diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index b493941dae20..b155b194ff3c 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -309,7 +309,7 @@ Step 2: Identify API spec status **Success Criteria**: User decision on spec readiness obtained Step 3: Validate TypeSpec Specification -**Goal**: Ensure TypeSpec specification compiles without errors. Povide a complete summary after running the tool. Highlight any errors and help user fix them. +**Goal**: Ensure TypeSpec specification compiles without errors. Provide a complete summary after running the tool. Highlight any errors and help user fix them. **Condition**: Only if the spec is not already merged (from Step 2) **Message to user**: "TypeSpec validation takes around 20 - 30 seconds." **Actions**: diff --git a/.github/cspell.yaml b/.github/cspell.yaml index bdb132159785..759993096538 100644 --- a/.github/cspell.yaml +++ b/.github/cspell.yaml @@ -2,5 +2,45 @@ version: "0.2" import: - ../cspell.yaml words: + - azmanager - azsdk + - brch + - buildid + - byval + - contosowidget + - contosowidgetmanager + - dapr + - fflate - pwsh + - retarget + - rhysd + - rpaas + - tsgs + - unstub + - vitest + +overrides: + - filename: "**/.github/chatmodes/api-review-feedback.chatmode.md" + words: + - Swathi + - Pillalamarri + + - filename: "**/.github/workflows/oav-runner-tests.yaml" + words: + - oavrunnertests + + - filename: "**/.github/workflows/src/spec-gen-sdk-status.js" + words: + - incompleted + + - filename: "**/.github/workflows/src/summarize-checks/tsgs.js" + words: + - efer + - rphelp + + - filename: "**/.github/workflows/src/summarize-checks/labelling.js" + words: + - unlabels + - rpaa + # This spelling may be a bug + - rpass diff --git a/.github/package-lock.json b/.github/package-lock.json index 63cf40afaf2e..bbf2e5dd5083 100644 --- a/.github/package-lock.json +++ b/.github/package-lock.json @@ -24,6 +24,7 @@ "@types/debug": "^4.1.12", "@types/js-yaml": "^4.0.9", "@types/node": "^20.0.0", + "@types/semver": "^7.7.1", "@vitest/coverage-v8": "^3.2.4", "cross-env": "^10.1.0", "eslint": "^9.22.0", @@ -95,9 +96,9 @@ } }, "node_modules/@actions/github-script/node_modules/@types/node": { - "version": "24.9.1", - "resolved": "https://registry.npmjs.org/@types/node/-/node-24.9.1.tgz", - "integrity": "sha512-QoiaXANRkSXK6p0Duvt56W208du4P9Uye9hWLWgGMDTEoKPhuenzNcC4vGUmrNkiOKTlIrBoyNQYNpSwfEZXSg==", + "version": "24.9.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-24.9.2.tgz", + "integrity": "sha512-uWN8YqxXxqFMX2RqGOrumsKeti4LlmIMIyV0lgut4jx7KQBcBiW6vkDtIBvHnHIquwNfJhk8v2OtmO8zXWHfPA==", "dev": true, "license": "MIT", "dependencies": { @@ -739,22 +740,22 @@ } }, "node_modules/@eslint/config-helpers": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.1.tgz", - "integrity": "sha512-csZAzkNhsgwb0I/UAV6/RGFTbiakPCf0ZrGmrIxQpYvGZ00PhTkSnyKNolphgIvmnJeGw6rcGVEXfTzUnFuEvw==", + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.2.tgz", + "integrity": "sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.16.0" + "@eslint/core": "^0.17.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, "node_modules/@eslint/core": { - "version": "0.16.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.16.0.tgz", - "integrity": "sha512-nmC8/totwobIiFcGkDza3GIKfAw1+hLiYVrh3I1nIomQ8PEr5cxg34jnkmGawul/ep52wGRAcyeDCNtWKSOj4Q==", + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.17.0.tgz", + "integrity": "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -802,9 +803,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.38.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.38.0.tgz", - "integrity": "sha512-UZ1VpFvXf9J06YG9xQBdnzU+kthors6KjhMAl6f4gH4usHyh31rUf2DLGInT8RFYIReYXNSydgPY0V2LuWgl7A==", + "version": "9.39.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.0.tgz", + "integrity": "sha512-BIhe0sW91JGPiaF1mOuPy5v8NflqfjIcDNpC+LbW9f609WVRX1rArrhi6Z2ymvrAry9jw+5POTj4t2t62o8Bmw==", "dev": true, "license": "MIT", "engines": { @@ -825,13 +826,13 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.0.tgz", - "integrity": "sha512-sB5uyeq+dwCWyPi31B2gQlVlo+j5brPlWx4yZBrEaRo/nhdDE8Xke1gsGgtiBdaBTxuTkceLVuVt/pclrasb0A==", + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz", + "integrity": "sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.16.0", + "@eslint/core": "^0.17.0", "levn": "^0.4.1" }, "engines": { @@ -1036,6 +1037,7 @@ "integrity": "sha512-/g2d4sW9nUDJOMz3mabVQvOGhVa4e/BN/Um7yca9Bb2XTzPPnfTWHWQg+IsEYO7M3Vx+EXvaM/I2pJWIMun1bg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@octokit/auth-token": "^4.0.0", "@octokit/graphql": "^7.1.0", @@ -1320,16 +1322,16 @@ } }, "node_modules/@octokit/rest": { - "version": "22.0.0", - "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-22.0.0.tgz", - "integrity": "sha512-z6tmTu9BTnw51jYGulxrlernpsQYXpui1RK21vmXn8yF5bp6iX16yfTtJYGK5Mh1qDkvDOmp2n8sRMcQmR8jiA==", + "version": "22.0.1", + "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-22.0.1.tgz", + "integrity": "sha512-Jzbhzl3CEexhnivb1iQ0KJ7s5vvjMWcmRtq5aUsKmKDrRW6z3r84ngmiFKFvpZjpiU/9/S6ITPFRpn5s/3uQJw==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/core": "^7.0.2", - "@octokit/plugin-paginate-rest": "^13.0.1", + "@octokit/core": "^7.0.6", + "@octokit/plugin-paginate-rest": "^14.0.0", "@octokit/plugin-request-log": "^6.0.0", - "@octokit/plugin-rest-endpoint-methods": "^16.0.0" + "@octokit/plugin-rest-endpoint-methods": "^17.0.0" }, "engines": { "node": ">= 20" @@ -1346,17 +1348,18 @@ } }, "node_modules/@octokit/rest/node_modules/@octokit/core": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/@octokit/core/-/core-7.0.5.tgz", - "integrity": "sha512-t54CUOsFMappY1Jbzb7fetWeO0n6K0k/4+/ZpkS+3Joz8I4VcvY9OiEBFRYISqaI2fq5sCiPtAjRDOzVYG8m+Q==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@octokit/core/-/core-7.0.6.tgz", + "integrity": "sha512-DhGl4xMVFGVIyMwswXeyzdL4uXD5OGILGX5N8Y+f6W7LhC1Ze2poSNrkF/fedpVDHEEZ+PHFW0vL14I+mm8K3Q==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@octokit/auth-token": "^6.0.0", - "@octokit/graphql": "^9.0.2", - "@octokit/request": "^10.0.4", - "@octokit/request-error": "^7.0.1", - "@octokit/types": "^15.0.0", + "@octokit/graphql": "^9.0.3", + "@octokit/request": "^10.0.6", + "@octokit/request-error": "^7.0.2", + "@octokit/types": "^16.0.0", "before-after-hook": "^4.0.0", "universal-user-agent": "^7.0.0" }, @@ -1365,35 +1368,28 @@ } }, "node_modules/@octokit/rest/node_modules/@octokit/graphql": { - "version": "9.0.2", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-9.0.2.tgz", - "integrity": "sha512-iz6KzZ7u95Fzy9Nt2L8cG88lGRMr/qy1Q36ih/XVzMIlPDMYwaNLE/ENhqmIzgPrlNWiYJkwmveEetvxAgFBJw==", + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-9.0.3.tgz", + "integrity": "sha512-grAEuupr/C1rALFnXTv6ZQhFuL1D8G5y8CN04RgrO4FIPMrtm+mcZzFG7dcBm+nq+1ppNixu+Jd78aeJOYxlGA==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/request": "^10.0.4", - "@octokit/types": "^15.0.0", + "@octokit/request": "^10.0.6", + "@octokit/types": "^16.0.0", "universal-user-agent": "^7.0.0" }, "engines": { "node": ">= 20" } }, - "node_modules/@octokit/rest/node_modules/@octokit/openapi-types": { - "version": "26.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-26.0.0.tgz", - "integrity": "sha512-7AtcfKtpo77j7Ts73b4OWhOZHTKo/gGY8bB3bNBQz4H+GRSWqx2yvj8TXRsbdTE0eRmYmXOEY66jM7mJ7LzfsA==", - "dev": true, - "license": "MIT" - }, "node_modules/@octokit/rest/node_modules/@octokit/plugin-paginate-rest": { - "version": "13.2.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-13.2.1.tgz", - "integrity": "sha512-Tj4PkZyIL6eBMYcG/76QGsedF0+dWVeLhYprTmuFVVxzDW7PQh23tM0TP0z+1MvSkxB29YFZwnUX+cXfTiSdyw==", + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-14.0.0.tgz", + "integrity": "sha512-fNVRE7ufJiAA3XUrha2omTA39M6IXIc6GIZLvlbsm8QOQCYvpq/LkMNGyFlB1d8hTDzsAXa3OKtybdMAYsV/fw==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.1" + "@octokit/types": "^16.0.0" }, "engines": { "node": ">= 20" @@ -1416,13 +1412,13 @@ } }, "node_modules/@octokit/rest/node_modules/@octokit/plugin-rest-endpoint-methods": { - "version": "16.1.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-16.1.1.tgz", - "integrity": "sha512-VztDkhM0ketQYSh5Im3IcKWFZl7VIrrsCaHbDINkdYeiiAsJzjhS2xRFCSJgfN6VOcsoW4laMtsmf3HcNqIimg==", + "version": "17.0.0", + "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-17.0.0.tgz", + "integrity": "sha512-B5yCyIlOJFPqUUeiD0cnBJwWJO8lkJs5d8+ze9QDP6SvfiXSz1BF+91+0MeI1d2yxgOhU/O+CvtiZ9jSkHhFAw==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.1" + "@octokit/types": "^16.0.0" }, "engines": { "node": ">= 20" @@ -1432,15 +1428,15 @@ } }, "node_modules/@octokit/rest/node_modules/@octokit/request": { - "version": "10.0.5", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-10.0.5.tgz", - "integrity": "sha512-TXnouHIYLtgDhKo+N6mXATnDBkV05VwbR0TtMWpgTHIoQdRQfCSzmy/LGqR1AbRMbijq/EckC/E3/ZNcU92NaQ==", + "version": "10.0.6", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-10.0.6.tgz", + "integrity": "sha512-FO+UgZCUu+pPnZAR+iKdUt64kPE7QW7ciqpldaMXaNzixz5Jld8dJ31LAUewk0cfSRkNSRKyqG438ba9c/qDlQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/endpoint": "^11.0.1", - "@octokit/request-error": "^7.0.1", - "@octokit/types": "^15.0.0", + "@octokit/endpoint": "^11.0.2", + "@octokit/request-error": "^7.0.2", + "@octokit/types": "^16.0.0", "fast-content-type-parse": "^3.0.0", "universal-user-agent": "^7.0.2" }, @@ -1449,28 +1445,18 @@ } }, "node_modules/@octokit/rest/node_modules/@octokit/request-error": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-7.0.1.tgz", - "integrity": "sha512-CZpFwV4+1uBrxu7Cw8E5NCXDWFNf18MSY23TdxCBgjw1tXXHvTrZVsXlW8hgFTOLw8RQR1BBrMvYRtuyaijHMA==", + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-7.0.2.tgz", + "integrity": "sha512-U8piOROoQQUyExw5c6dTkU3GKxts5/ERRThIauNL7yaRoeXW0q/5bgHWT7JfWBw1UyrbK8ERId2wVkcB32n0uQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.0" + "@octokit/types": "^16.0.0" }, "engines": { "node": ">= 20" } }, - "node_modules/@octokit/rest/node_modules/@octokit/types": { - "version": "15.0.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-15.0.2.tgz", - "integrity": "sha512-rR+5VRjhYSer7sC51krfCctQhVTmjyUMAaShfPB8mscVa8tSoLyon3coxQmXu0ahJoLVWl8dSGD/3OGZlFV44Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@octokit/openapi-types": "^26.0.0" - } - }, "node_modules/@octokit/rest/node_modules/before-after-hook": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-4.0.0.tgz", @@ -1845,6 +1831,7 @@ "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@types/ms": "*" } @@ -1874,7 +1861,8 @@ "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/@types/ms": { "version": "2.1.0", @@ -1884,15 +1872,23 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "20.19.23", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.23.tgz", - "integrity": "sha512-yIdlVVVHXpmqRhtyovZAcSy0MiPcYWGkoO4CGe/+jpP0hmNuihm4XhHbADpK++MsiLHP5MVlv+bcgdF99kSiFQ==", + "version": "20.19.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.24.tgz", + "integrity": "sha512-FE5u0ezmi6y9OZEzlJfg37mqqf6ZDSF2V/NLjUyGrR9uTZ7Sb9F7bLNZ03S4XVUNRWGA7Ck4c1kK+YnuWjl+DA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "undici-types": "~6.21.0" } }, + "node_modules/@types/semver": { + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-FmgJfu+MOcQ370SD0ev7EI8TlCAfKYU+B4m5T3yXc1CiRN94g/SZPtsCkk506aUDtlMnFZvasDwHHUcZUEaYuA==", + "dev": true, + "license": "MIT" + }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "8.46.2", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.46.2.tgz", @@ -1939,6 +1935,7 @@ "integrity": "sha512-BnOroVl1SgrPLywqxyqdJ4l3S2MsKVLDVxZvjI1Eoe8ev2r3kGDo+PcMihNmDE+6/KjkTubSJnmqGZZjQSBq/g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "8.46.2", "@typescript-eslint/types": "8.46.2", @@ -2306,6 +2303,7 @@ "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -2684,20 +2682,21 @@ } }, "node_modules/eslint": { - "version": "9.38.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.38.0.tgz", - "integrity": "sha512-t5aPOpmtJcZcz5UJyY2GbvpDlsK5E8JqRqoKtfiKE3cNh437KIqfJr3A3AKf5k64NPx6d0G3dno6XDY05PqPtw==", + "version": "9.39.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.0.tgz", + "integrity": "sha512-iy2GE3MHrYTL5lrCtMZ0X1KLEKKUjmK0kzwcnefhR66txcEmXZD2YWgR5GNdcEwkNx3a0siYkSvl0vIC+Svjmg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.1", - "@eslint/config-helpers": "^0.4.1", - "@eslint/core": "^0.16.0", + "@eslint/config-helpers": "^0.4.2", + "@eslint/core": "^0.17.0", "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.38.0", - "@eslint/plugin-kit": "^0.4.0", + "@eslint/js": "9.39.0", + "@eslint/plugin-kit": "^0.4.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", @@ -3394,9 +3393,9 @@ "license": "ISC" }, "node_modules/magic-string": { - "version": "0.30.19", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.19.tgz", - "integrity": "sha512-2N21sPY9Ws53PZvsEpVtNuSW+ScYbQdp4b9qUaL+9QkHUrGFKo56Lg9Emg5s9V/qrtNBmiR01sYhUOwu3H+VOw==", + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", "dev": true, "license": "MIT", "dependencies": { @@ -3731,6 +3730,7 @@ "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", "dev": true, "license": "MIT", + "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -4210,6 +4210,7 @@ "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -4302,6 +4303,7 @@ "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -4493,6 +4495,7 @@ "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -4506,6 +4509,7 @@ "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@types/chai": "^5.2.2", "@vitest/expect": "3.2.4", diff --git a/.github/package.json b/.github/package.json index 63477524f55d..3c85bf81241d 100644 --- a/.github/package.json +++ b/.github/package.json @@ -25,6 +25,7 @@ "@types/debug": "^4.1.12", "@types/js-yaml": "^4.0.9", "@types/node": "^20.0.0", + "@types/semver": "^7.7.1", "@vitest/coverage-v8": "^3.2.4", "cross-env": "^10.1.0", "eslint": "^9.22.0", diff --git a/.github/shared/cmd/spec-model.js b/.github/shared/cmd/spec-model.js index 3e3c0c285eb2..bcee4d62f664 100755 --- a/.github/shared/cmd/spec-model.js +++ b/.github/shared/cmd/spec-model.js @@ -5,7 +5,7 @@ import { SpecModel } from "../src/spec-model.js"; const USAGE = "Usage: npx spec-model path/to/spec [--debug] [--include-refs] [--relative-paths] [--no-embed-errors]\n" + - "Example: npx spec-model specfication/contosowidgetmanager"; + "Example: npx spec-model specification/widget"; // Exclude first two args (node, script file) let args = process.argv.slice(2); @@ -42,7 +42,6 @@ const specModel = new SpecModel(specPath, { logger }); console.log( JSON.stringify( - // Always embed errors, since we always want to return a valid JSON object instead of throwing await specModel.toJSONAsync({ embedErrors: !noEmbedErrors, includeRefs, relativePaths }), null, 2, diff --git a/.github/shared/package-lock.json b/.github/shared/package-lock.json index 3d4295a1ea6e..91ab5edd3ff6 100644 --- a/.github/shared/package-lock.json +++ b/.github/shared/package-lock.json @@ -22,6 +22,7 @@ "@types/debug": "^4.1.12", "@types/js-yaml": "^4.0.9", "@types/node": "^20.0.0", + "@types/semver": "^7.7.1", "@vitest/coverage-v8": "^3.2.4", "cross-env": "^10.1.0", "eslint": "^9.22.0", @@ -633,22 +634,22 @@ } }, "node_modules/@eslint/config-helpers": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.1.tgz", - "integrity": "sha512-csZAzkNhsgwb0I/UAV6/RGFTbiakPCf0ZrGmrIxQpYvGZ00PhTkSnyKNolphgIvmnJeGw6rcGVEXfTzUnFuEvw==", + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.2.tgz", + "integrity": "sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.16.0" + "@eslint/core": "^0.17.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, "node_modules/@eslint/core": { - "version": "0.16.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.16.0.tgz", - "integrity": "sha512-nmC8/totwobIiFcGkDza3GIKfAw1+hLiYVrh3I1nIomQ8PEr5cxg34jnkmGawul/ep52wGRAcyeDCNtWKSOj4Q==", + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.17.0.tgz", + "integrity": "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -696,9 +697,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.38.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.38.0.tgz", - "integrity": "sha512-UZ1VpFvXf9J06YG9xQBdnzU+kthors6KjhMAl6f4gH4usHyh31rUf2DLGInT8RFYIReYXNSydgPY0V2LuWgl7A==", + "version": "9.39.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.0.tgz", + "integrity": "sha512-BIhe0sW91JGPiaF1mOuPy5v8NflqfjIcDNpC+LbW9f609WVRX1rArrhi6Z2ymvrAry9jw+5POTj4t2t62o8Bmw==", "dev": true, "license": "MIT", "engines": { @@ -719,13 +720,13 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.0.tgz", - "integrity": "sha512-sB5uyeq+dwCWyPi31B2gQlVlo+j5brPlWx4yZBrEaRo/nhdDE8Xke1gsGgtiBdaBTxuTkceLVuVt/pclrasb0A==", + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz", + "integrity": "sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.16.0", + "@eslint/core": "^0.17.0", "levn": "^0.4.1" }, "engines": { @@ -1247,6 +1248,7 @@ "integrity": "sha512-vIChWdVG3LG1SMxEvI/AK+FWJthlrqlTu7fbrlywTkkaONwk/UAGaULXRlf8vkzFBLVm0zkMdCquhL5aOjhXPQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@types/ms": "*" } @@ -1276,7 +1278,8 @@ "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/@types/ms": { "version": "2.1.0", @@ -1286,15 +1289,23 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "20.19.23", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.23.tgz", - "integrity": "sha512-yIdlVVVHXpmqRhtyovZAcSy0MiPcYWGkoO4CGe/+jpP0hmNuihm4XhHbADpK++MsiLHP5MVlv+bcgdF99kSiFQ==", + "version": "20.19.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.19.24.tgz", + "integrity": "sha512-FE5u0ezmi6y9OZEzlJfg37mqqf6ZDSF2V/NLjUyGrR9uTZ7Sb9F7bLNZ03S4XVUNRWGA7Ck4c1kK+YnuWjl+DA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "undici-types": "~6.21.0" } }, + "node_modules/@types/semver": { + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-FmgJfu+MOcQ370SD0ev7EI8TlCAfKYU+B4m5T3yXc1CiRN94g/SZPtsCkk506aUDtlMnFZvasDwHHUcZUEaYuA==", + "dev": true, + "license": "MIT" + }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "8.46.2", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.46.2.tgz", @@ -1341,6 +1352,7 @@ "integrity": "sha512-BnOroVl1SgrPLywqxyqdJ4l3S2MsKVLDVxZvjI1Eoe8ev2r3kGDo+PcMihNmDE+6/KjkTubSJnmqGZZjQSBq/g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "8.46.2", "@typescript-eslint/types": "8.46.2", @@ -1708,6 +1720,7 @@ "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -2065,20 +2078,21 @@ } }, "node_modules/eslint": { - "version": "9.38.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.38.0.tgz", - "integrity": "sha512-t5aPOpmtJcZcz5UJyY2GbvpDlsK5E8JqRqoKtfiKE3cNh437KIqfJr3A3AKf5k64NPx6d0G3dno6XDY05PqPtw==", + "version": "9.39.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.0.tgz", + "integrity": "sha512-iy2GE3MHrYTL5lrCtMZ0X1KLEKKUjmK0kzwcnefhR66txcEmXZD2YWgR5GNdcEwkNx3a0siYkSvl0vIC+Svjmg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.1", - "@eslint/config-helpers": "^0.4.1", - "@eslint/core": "^0.16.0", + "@eslint/config-helpers": "^0.4.2", + "@eslint/core": "^0.17.0", "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.38.0", - "@eslint/plugin-kit": "^0.4.0", + "@eslint/js": "9.39.0", + "@eslint/plugin-kit": "^0.4.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", @@ -2299,24 +2313,6 @@ "reusify": "^1.0.4" } }, - "node_modules/fdir": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", - "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.0.0" - }, - "peerDependencies": { - "picomatch": "^3 || ^4" - }, - "peerDependenciesMeta": { - "picomatch": { - "optional": true - } - } - }, "node_modules/file-entry-cache": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-8.0.0.tgz", @@ -2769,9 +2765,9 @@ "license": "ISC" }, "node_modules/magic-string": { - "version": "0.30.19", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.19.tgz", - "integrity": "sha512-2N21sPY9Ws53PZvsEpVtNuSW+ScYbQdp4b9qUaL+9QkHUrGFKo56Lg9Emg5s9V/qrtNBmiR01sYhUOwu3H+VOw==", + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", "dev": true, "license": "MIT", "dependencies": { @@ -2842,19 +2838,6 @@ "node": ">=8.6" } }, - "node_modules/micromatch/node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=8.6" - }, - "funding": { - "url": "https://github.com/sponsors/jonschlinkert" - } - }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -3042,13 +3025,13 @@ "license": "ISC" }, "node_modules/picomatch": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", - "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", + "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", "dev": true, "license": "MIT", "engines": { - "node": ">=12" + "node": ">=8.6" }, "funding": { "url": "https://github.com/sponsors/jonschlinkert" @@ -3099,6 +3082,7 @@ "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", "dev": true, "license": "MIT", + "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -3554,6 +3538,38 @@ "url": "https://github.com/sponsors/SuperchupuDev" } }, + "node_modules/tinyglobby/node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/tinyglobby/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "peer": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/tinypool": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.1.1.tgz", @@ -3629,6 +3645,7 @@ "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -3776,12 +3793,45 @@ "url": "https://opencollective.com/vitest" } }, + "node_modules/vite/node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/vite/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "peer": true, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/vitest": { "version": "3.2.4", "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.2.4.tgz", "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@types/chai": "^5.2.2", "@vitest/expect": "3.2.4", @@ -3849,6 +3899,19 @@ } } }, + "node_modules/vitest/node_modules/picomatch": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.3.tgz", + "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", diff --git a/.github/shared/package.json b/.github/shared/package.json index c1be1d786a80..6784a847544c 100644 --- a/.github/shared/package.json +++ b/.github/shared/package.json @@ -47,6 +47,7 @@ "@types/debug": "^4.1.12", "@types/js-yaml": "^4.0.9", "@types/node": "^20.0.0", + "@types/semver": "^7.7.1", "@vitest/coverage-v8": "^3.2.4", "cross-env": "^10.1.0", "eslint": "^9.22.0", diff --git a/.github/shared/src/exec.js b/.github/shared/src/exec.js index e542ec8aa7a9..c98712e30057 100644 --- a/.github/shared/src/exec.js +++ b/.github/shared/src/exec.js @@ -36,7 +36,7 @@ export function isExecError(error) { * Wraps `child_process.execFile()`, adding logging and a larger default maxBuffer. * * @param {string} file - * @param {string[]} args + * @param {string[]} [args] * @param {ExecOptions} [options] * @returns {Promise} * @throws {ExecError} diff --git a/.github/shared/src/readme.js b/.github/shared/src/readme.js index a00d6cbb0755..f1fd14e30073 100644 --- a/.github/shared/src/readme.js +++ b/.github/shared/src/readme.js @@ -9,8 +9,17 @@ import { embedError } from "./spec-model.js"; import { Tag } from "./tag.js"; /** + * @typedef {import('./spec-model.js').ErrorJSON} ErrorJSON * @typedef {import('./spec-model.js').SpecModel} SpecModel * @typedef {import('./spec-model.js').ToJSONOptions} ToJSONOptions + * @typedef {import('./tag.js').TagJSON} TagJSON + */ + +/** + * @typedef {Object} ReadmeJSON + * @property {string} path + * @property {Object} globalConfig + * @property {(TagJSON|ErrorJSON)[]} tags */ /** @@ -43,7 +52,7 @@ export class Readme { */ #content; - /** @type {{globalConfig: Object, tags: Map} | undefined} */ + /** @type {{globalConfig: Record, tags: Map} | undefined} */ #data; /** @type {import('./logger.js').ILogger | undefined} */ @@ -210,7 +219,7 @@ export class Readme { } /** - * @returns {Promise} + * @returns {Promise>} */ async getGlobalConfig() { return (await this.#getData()).globalConfig; @@ -239,7 +248,7 @@ export class Readme { /** * @param {ToJSONOptions} [options] - * @returns {Promise} + * @returns {Promise} */ async toJSONAsync(options = {}) { const { relativePaths } = options; diff --git a/.github/shared/src/spec-model.js b/.github/shared/src/spec-model.js index d7335f1b3b33..e4614ac9879e 100644 --- a/.github/shared/src/spec-model.js +++ b/.github/shared/src/spec-model.js @@ -5,19 +5,33 @@ import { readme } from "./changed-files.js"; import { Readme } from "./readme.js"; import { SpecModelError } from "./spec-model-error.js"; -/** @type {Map} */ -const specModelCache = new Map(); +/** + * @typedef {import('./readme.js').ReadmeJSON} ReadmeJSON + * @typedef {import('./swagger.js').Swagger} Swagger + * @typedef {import('./tag.js').Tag} Tag + */ + +/** + * @typedef {Object} ErrorJSON + * @prop {string} error + */ + +/** + * @typedef {Object} SpecModelJSON + * @property {string} folder + * @property {(ReadmeJSON|ErrorJSON)[]} readmes + */ /** * @typedef {Object} ToJSONOptions * @prop {boolean} [embedErrors] * @prop {boolean} [includeRefs] * @prop {boolean} [relativePaths] - * - * @typedef {import('./swagger.js').Swagger} Swagger - * @typedef {import('./tag.js').Tag} Tag */ +/** @type {Map} */ +const specModelCache = new Map(); + export class SpecModel { /** @type {string} absolute path */ // @ts-expect-error Ignore error that value may not be set in ctor (since we may returned cached value) @@ -214,7 +228,7 @@ export class SpecModel { /** * @param {ToJSONOptions} [options] - * @returns {Promise} + * @returns {Promise} */ async toJSONAsync(options = {}) { return await embedError(async () => { @@ -242,7 +256,7 @@ export class SpecModel { * @param {() => Promise} fn * @param {Object} [options] * @param {boolean} [options.embedErrors] - * @returns {Promise} + * @returns {Promise} */ export async function embedError(fn, options = {}) { const { embedErrors } = options; diff --git a/.github/shared/src/swagger.js b/.github/shared/src/swagger.js index 064d4ad5bea4..af1da1517441 100644 --- a/.github/shared/src/swagger.js +++ b/.github/shared/src/swagger.js @@ -8,6 +8,7 @@ import { SpecModelError } from "./spec-model-error.js"; import { embedError } from "./spec-model.js"; /** + * @typedef {import('./spec-model.js').ErrorJSON} ErrorJSON * @typedef {import('./spec-model.js').Tag} Tag * @typedef {import('./spec-model.js').ToJSONOptions} ToJSONOptions */ @@ -19,6 +20,12 @@ import { embedError } from "./spec-model.js"; * @property {string} httpMethod - HTTP method (GET, POST, etc.) */ +/** + * @typedef {Object} SwaggerJSON + * @property {string} path + * @property {Object[]} [refs] + */ + /** * @type {import('@apidevtools/json-schema-ref-parser').ResolverOptions} */ @@ -200,7 +207,7 @@ export class Swagger { /** * @param {ToJSONOptions} [options] - * @returns {Promise} + * @returns {Promise} */ async toJSONAsync(options = {}) { const { includeRefs, relativePaths } = options; diff --git a/.github/shared/src/tag.js b/.github/shared/src/tag.js index feb331c56354..1a77a4c433e4 100644 --- a/.github/shared/src/tag.js +++ b/.github/shared/src/tag.js @@ -3,10 +3,18 @@ import { embedError } from "./spec-model.js"; import { Swagger } from "./swagger.js"; /** + * @typedef {import('./spec-model.js').ErrorJSON} ErrorJSON * @typedef {import('./readme.js').Readme} Readme + * @typedef {import('./swagger.js').SwaggerJSON} SwaggerJSON * @typedef {import('./spec-model.js').ToJSONOptions} ToJSONOptions */ +/** + * @typedef {Object} TagJSON + * @property {string} name + * @property {(SwaggerJSON|ErrorJSON)[]} inputFiles + */ + export class Tag { /** @type {Map} */ #inputFiles; @@ -68,7 +76,7 @@ export class Tag { /** * @param {ToJSONOptions} [options] - * @returns {Promise} + * @returns {Promise} */ async toJSONAsync(options = {}) { return await embedError( diff --git a/.github/shared/test/error-reporting.test.js b/.github/shared/test/error-reporting.test.js index 1435cb04abf5..756edfda111b 100644 --- a/.github/shared/test/error-reporting.test.js +++ b/.github/shared/test/error-reporting.test.js @@ -3,6 +3,7 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { annotateFileError, setOutput, setSummary } from "../src/error-reporting.js"; describe("ErrorReporting", () => { + /** @type {import("vitest").MockInstance} */ let logSpy; beforeEach(() => { @@ -42,7 +43,7 @@ describe("ErrorReporting", () => { const content = await fs.readFile(process.env.GITHUB_STEP_SUMMARY, "utf-8"); - // cleanup after the test so nothing is left behi + // cleanup after the test so nothing is left behind await fs.rm(process.env.GITHUB_STEP_SUMMARY, { force: true }); expect(content).toBe("# Title"); diff --git a/.github/shared/test/exec.test.js b/.github/shared/test/exec.test.js index bb773ea656d0..d8e951c0f314 100644 --- a/.github/shared/test/exec.test.js +++ b/.github/shared/test/exec.test.js @@ -39,7 +39,7 @@ describe("execFile", () => { describe("execNpm", () => { it("succeeds with --version", async () => { await expect(execNpm(["--version"], options)).resolves.toEqual({ - stdout: expect.toSatisfy((v) => semver.valid(v)), + stdout: expect.toSatisfy((v) => semver.valid(v) !== null), stderr: "", }); }); @@ -61,7 +61,7 @@ describe("execNpmExec", () => { // so it is used. it("runs prettier", async () => { await expect(execNpmExec(["prettier", "--version"], options)).resolves.toEqual({ - stdout: expect.toSatisfy((v) => semver.valid(v)), + stdout: expect.toSatisfy((v) => semver.valid(v) !== null), stderr: "", error: undefined, }); @@ -75,13 +75,15 @@ describe("isExecError", () => { const error = new Error(); expect(isExecError(error)).toBe(false); - error.stdout = "test"; - expect(isExecError(error)).toBe(true); + const execError = /** @type {import("../src/exec.js").ExecError} */ (error); - delete error.stdout; - expect(isExecError(error)).toBe(false); + execError.stdout = "test"; + expect(isExecError(execError)).toBe(true); + + delete execError.stdout; + expect(isExecError(execError)).toBe(false); - error.stderr = "test"; - expect(isExecError(error)).toBe(true); + execError.stderr = "test"; + expect(isExecError(execError)).toBe(true); }); }); diff --git a/.github/shared/test/fixtures/getSpecModel/specification/contosowidgetmanager/resource-manager/readme.md b/.github/shared/test/fixtures/getSpecModel/specification/contosowidgetmanager/resource-manager/readme.md index 21d77042619b..3fa08c28758f 100644 --- a/.github/shared/test/fixtures/getSpecModel/specification/contosowidgetmanager/resource-manager/readme.md +++ b/.github/shared/test/fixtures/getSpecModel/specification/contosowidgetmanager/resource-manager/readme.md @@ -57,7 +57,7 @@ input-file: Microsoft.Contoso/preview/2021-10-01-preview/contoso.json ### Tag: empty-properties -This tag has no yaml entites defined and is intended to test parser scenarios +This tag has no yaml entities defined and is intended to test parser scenarios around empty properties. ``` yaml $(tag) == 'empty-properties' diff --git a/.github/shared/test/git.test.js b/.github/shared/test/git.test.js index 6f26bd7db9f9..1e7e635d8ef5 100644 --- a/.github/shared/test/git.test.js +++ b/.github/shared/test/git.test.js @@ -1,6 +1,6 @@ import { describe, expect, it } from "vitest"; -import { isFullGitSha } from "../src/git"; -import { fullGitSha } from "./examples"; +import { isFullGitSha } from "../src/git.js"; +import { fullGitSha } from "./examples.js"; describe("git", () => { it.each([ diff --git a/.github/shared/test/logger.test.js b/.github/shared/test/logger.test.js index fc7c6c9a368b..d855eb0b6d39 100644 --- a/.github/shared/test/logger.test.js +++ b/.github/shared/test/logger.test.js @@ -1,8 +1,11 @@ import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; -import { ConsoleLogger, debugLogger, defaultLogger } from "../src/logger"; +import { ConsoleLogger, debugLogger, defaultLogger } from "../src/logger.js"; describe("logger", () => { - let debugSpy, errorSpy, logSpy, warnSpy; + /** @type {import("vitest").MockInstance} */ let debugSpy; + /** @type {import("vitest").MockInstance} */ let errorSpy; + /** @type {import("vitest").MockInstance} */ let logSpy; + /** @type {import("vitest").MockInstance} */ let warnSpy; beforeEach(() => { debugSpy = vi.spyOn(console, "debug"); diff --git a/.github/shared/test/set.test.js b/.github/shared/test/set.test.js index e48cc2acbd2d..93c637099420 100644 --- a/.github/shared/test/set.test.js +++ b/.github/shared/test/set.test.js @@ -1,5 +1,5 @@ import { describe, expect, it } from "vitest"; -import { equals, intersect } from "../src/set"; +import { equals, intersect } from "../src/set.js"; describe("set", () => { it.each([ diff --git a/.github/shared/test/spec-model.test.js b/.github/shared/test/spec-model.test.js index 3dbbf859e365..5ca6416727c6 100644 --- a/.github/shared/test/spec-model.test.js +++ b/.github/shared/test/spec-model.test.js @@ -8,6 +8,13 @@ import { SpecModel } from "../src/spec-model.js"; import { Duration } from "../src/time.js"; import { repoRoot } from "./repo.js"; +/** + * @typedef {import('../src/readme.js').ReadmeJSON} ReadmeJSON + * @typedef {import('../src/spec-model.js').SpecModelJSON} SpecModelJSON + * @typedef {import('../src/swagger.js').SwaggerJSON} SwaggerJSON + * @typedef {import('../src/tag.js').TagJSON} TagJSON + */ + const options = { logger: new ConsoleLogger(/*debug*/ true) }; describe("SpecModel", () => { @@ -91,18 +98,28 @@ describe("SpecModel", () => { ); expect(inputFiles1[0].tag).toBe(tags[1]); - const jsonDefault = await specModel.toJSONAsync(); - const readmePathDefault = jsonDefault.readmes[0].path; + const jsonDefault = /** @type {SpecModelJSON} */ (await specModel.toJSONAsync()); + const readmeJSONDefault = /** @type {ReadmeJSON} */ (jsonDefault.readmes[0]); + const readmePathDefault = readmeJSONDefault.path; expect(isAbsolute(readmePathDefault)).toBe(true); - expect(jsonDefault.readmes[0].tags[0].inputFiles[0].refs).toBeUndefined(); - - const jsonRefsRelative = await specModel.toJSONAsync({ - includeRefs: true, - relativePaths: true, - }); - const readmePathRelative = jsonRefsRelative.readmes[0].path; + expect( + /** @type {SwaggerJSON} */ (/** @type {TagJSON} */ (readmeJSONDefault.tags[0]).inputFiles[0]) + .refs, + ).toBeUndefined(); + + const jsonRefsRelative = /** @type {SpecModelJSON} */ ( + await specModel.toJSONAsync({ + includeRefs: true, + relativePaths: true, + }) + ); + const readmeJSONRelative = /** @type {ReadmeJSON} */ (jsonRefsRelative.readmes[0]); + const readmePathRelative = readmeJSONRelative.path; expect(isAbsolute(readmePathRelative)).toBe(false); - expect(jsonRefsRelative.readmes[0].tags[0].inputFiles[0].refs).toBeDefined(); + expect( + /** @type {SwaggerJSON}*/ (/** @type {TagJSON} */ (readmeJSONRelative.tags[0]).inputFiles[0]) + .refs, + ).toBeDefined(); }); it("uses strings for tag names and doesn't parse Date object", async () => { @@ -380,6 +397,7 @@ describe.skip("Parse readmes", () => { "runs properly against specific services", { timeout: 30 * Duration.Minute }, async ({ expect }) => { + /** @type {string[]} */ const folders = [ // Fill in services to test here ]; diff --git a/.github/shared/tsconfig.json b/.github/shared/tsconfig.json index fd8d4c43ea86..49aa7c7cbf78 100644 --- a/.github/shared/tsconfig.json +++ b/.github/shared/tsconfig.json @@ -8,8 +8,4 @@ "incremental": false, "noEmit": true, }, - "include": [ - // Only check runtime sources. Tests currently have too many errors. - "**/src/**/*.js", - ], } diff --git a/.github/shared/vitest.config.js b/.github/shared/vitest.config.js index d9fa13bfbfba..c1d6d511c86c 100644 --- a/.github/shared/vitest.config.js +++ b/.github/shared/vitest.config.js @@ -4,13 +4,14 @@ export default defineConfig({ esbuild: { // Ignore tsconfig.json, since it's only used for type checking, and causes // a warning if vitest tries to load it + // @ts-expect-error: tsConfig' does not exist in type 'ESBuildOptions' tsConfig: false, }, test: { coverage: { exclude: [ - ...configDefaults.coverage.exclude, + ...(configDefaults.coverage.exclude ?? []), // Not worth testing CLI code "cmd/**/*.js", diff --git a/.github/tsconfig.json b/.github/tsconfig.json index fd8d4c43ea86..49aa7c7cbf78 100644 --- a/.github/tsconfig.json +++ b/.github/tsconfig.json @@ -8,8 +8,4 @@ "incremental": false, "noEmit": true, }, - "include": [ - // Only check runtime sources. Tests currently have too many errors. - "**/src/**/*.js", - ], } diff --git a/.github/vitest.config.js b/.github/vitest.config.js index ae56b27cb71c..a357e6a05544 100644 --- a/.github/vitest.config.js +++ b/.github/vitest.config.js @@ -4,13 +4,14 @@ export default defineConfig({ esbuild: { // Ignore tsconfig.json, since it's only used for type checking, and causes // a warning if vitest tries to load it + // @ts-expect-error: tsConfig' does not exist in type 'ESBuildOptions' tsConfig: false, }, test: { coverage: { exclude: [ - ...configDefaults.coverage.exclude, + ...(configDefaults.coverage.exclude ?? []), // Not worth testing CLI code "**/cmd/**", diff --git a/.github/workflows/sdk-breaking-change-labels.yaml b/.github/workflows/sdk-breaking-change-labels.yaml index 44e82c6b3abe..30b478cbc630 100644 --- a/.github/workflows/sdk-breaking-change-labels.yaml +++ b/.github/workflows/sdk-breaking-change-labels.yaml @@ -23,7 +23,7 @@ jobs: sparse-checkout: | .github - # Only run the login and get token steps when the respository is azure-rest-api-specs-pr + # Only run the login and get token steps when the repository is azure-rest-api-specs-pr - if: github.event.repository.name == 'azure-rest-api-specs-pr' name: Azure Login with Workload Identity Federation uses: azure/login@v2 diff --git a/.github/workflows/spec-gen-sdk-status.yml b/.github/workflows/spec-gen-sdk-status.yml index faaaf71bbbf7..97c0b37db248 100644 --- a/.github/workflows/spec-gen-sdk-status.yml +++ b/.github/workflows/spec-gen-sdk-status.yml @@ -23,7 +23,7 @@ jobs: sparse-checkout: | .github - # Only run the login and get token steps when the respository is azure-rest-api-specs-pr + # Only run the login and get token steps when the repository is azure-rest-api-specs-pr - if: github.event.repository.name == 'azure-rest-api-specs-pr' name: Azure Login with Workload Identity Federation uses: azure/login@v2 diff --git a/.github/workflows/test/arm-auto-signoff.test.js b/.github/workflows/test/arm-auto-signoff.test.js index d354f08b54bf..f95c98e1dcee 100644 --- a/.github/workflows/test/arm-auto-signoff.test.js +++ b/.github/workflows/test/arm-auto-signoff.test.js @@ -43,7 +43,9 @@ function createMockGithub({ incrementalTypeSpec }) { describe("getLabelActionImpl", () => { it("throws if inputs null", async () => { - await expect(getLabelActionImpl({})).rejects.toThrow(); + await expect( + getLabelActionImpl(/** @type {Parameters[0]} */ ({})), + ).rejects.toThrow(); }); it("throws if no artifact from incremental typespec", async () => { diff --git a/.github/workflows/test/arm-incremental-typespec.test.js b/.github/workflows/test/arm-incremental-typespec.test.js index 668613e1acd1..65979bd07e21 100644 --- a/.github/workflows/test/arm-incremental-typespec.test.js +++ b/.github/workflows/test/arm-incremental-typespec.test.js @@ -16,11 +16,20 @@ import { swaggerHandWritten, swaggerTypeSpecGenerated, } from "../../shared/test/examples.js"; -import incrementalTypeSpec from "../src/arm-incremental-typespec.js"; +import incrementalTypeSpecImpl from "../src/arm-incremental-typespec.js"; import { createMockCore } from "./mocks.js"; const core = createMockCore(); +/** + * @param {unknown} asyncFunctionArgs + */ +function incrementalTypeSpec(asyncFunctionArgs) { + return incrementalTypeSpecImpl( + /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs), + ); +} + describe("incrementalTypeSpec", () => { afterEach(() => { vi.clearAllMocks(); @@ -131,8 +140,27 @@ describe("incrementalTypeSpec", () => { const showSpy = vi .mocked(simpleGit.simpleGit().show) - .mockImplementation(async ([treePath]) => - treePath.split(":")[0] == "HEAD" ? swaggerTypeSpecGenerated : swaggerHandWritten, + .mockImplementation( + ( + /** @type {import("simple-git").SimpleGitTaskCallback|string|string[]|undefined} */ optionsOrCallback, + ) => { + /** @type {string} */ + let option; + + if (Array.isArray(optionsOrCallback)) { + option = optionsOrCallback[0]; + } else if (typeof optionsOrCallback === "string") { + option = optionsOrCallback; + } else { + throw new Error(`Unexpected argument: ${optionsOrCallback}`); + } + + return /** @type {import("simple-git").Response} */ ( + Promise.resolve( + option?.split(":")[0] == "HEAD" ? swaggerTypeSpecGenerated : swaggerHandWritten, + ) + ); + }, ); const lsTreeSpy = vi.mocked(simpleGit.simpleGit().raw).mockResolvedValue(swaggerPath); @@ -199,16 +227,37 @@ describe("incrementalTypeSpec", () => { vi.spyOn(changedFiles, "getChangedFiles").mockResolvedValue([readmePath]); - const showSpy = vi.mocked(simpleGit.simpleGit().show).mockImplementation(async ([treePath]) => { - const path = treePath.split(":")[1]; - if (path === swaggerPath) { - return swaggerTypeSpecGenerated; - } else if (path === readmePath) { - return contosoReadme; - } else { - throw new Error("does not exist"); - } - }); + const showSpy = vi + .mocked(simpleGit.simpleGit().show) + .mockImplementation( + ( + /** @type {import("simple-git").SimpleGitTaskCallback|string|string[]|undefined} */ optionsOrCallback, + ) => { + /** @type {string} */ + let option; + + if (Array.isArray(optionsOrCallback)) { + option = optionsOrCallback[0]; + } else if (typeof optionsOrCallback === "string") { + option = optionsOrCallback; + } else { + throw new Error(`Unexpected argument: ${optionsOrCallback}`); + } + + const path = option.split(":")[1]; + if (path === swaggerPath) { + return /** @type {import("simple-git").Response} */ ( + Promise.resolve(swaggerTypeSpecGenerated) + ); + } else if (path === readmePath) { + return /** @type {import("simple-git").Response} */ ( + Promise.resolve(contosoReadme) + ); + } else { + throw new Error("does not exist"); + } + }, + ); const lsTreeSpy = vi.mocked(simpleGit.simpleGit().raw).mockResolvedValue(swaggerPath); diff --git a/.github/workflows/test/artifacts.test.js b/.github/workflows/test/artifacts.test.js index ac5810967cf1..6296b77ccf5d 100644 --- a/.github/workflows/test/artifacts.test.js +++ b/.github/workflows/test/artifacts.test.js @@ -12,7 +12,8 @@ vi.mock("../src/context.js", () => ({ })); // Mock global fetch -global.fetch = vi.fn(); +const mockFetch = vi.fn(); +global.fetch = mockFetch; const mockCore = createMockCore(); describe("getAzurePipelineArtifact function", () => { @@ -78,7 +79,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch to capture headers and return appropriate responses - global.fetch.mockImplementation((url, options) => { + mockFetch.mockImplementation((url, options) => { // For all calls, verify the headers include the authorization token if (options && options.headers) { expect(options.headers).toEqual(expectedHeaders); @@ -152,7 +153,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch with a spy to capture the headers - global.fetch.mockImplementation((url, options) => { + mockFetch.mockImplementation((url, options) => { if (url.includes("artifacts?artifactName=")) { // Verify headers contain Authorization expect(options.headers).toHaveProperty("Authorization", `Bearer ${testToken}`); @@ -189,7 +190,7 @@ describe("getAzurePipelineArtifact function", () => { it("should handle API failure", async () => { // Mock fetch failure - global.fetch.mockResolvedValue({ + mockFetch.mockResolvedValue({ ok: false, status: 500, statusText: "Server Error", @@ -216,7 +217,7 @@ describe("getAzurePipelineArtifact function", () => { it("should complete without op when artifact does not exist", async () => { // Mock fetch failure - global.fetch.mockResolvedValue({ + mockFetch.mockResolvedValue({ ok: false, status: 404, statusText: "Not Found", @@ -289,7 +290,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch to return different responses based on the URL - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { // First attempted artifact request with 404 if (url.includes(`artifacts?artifactName=${inputs.artifactName}&api-version=7.0`)) { return mockInitialResponse; @@ -340,7 +341,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } @@ -368,7 +369,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } @@ -408,7 +409,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } else { @@ -430,7 +431,7 @@ describe("getAzurePipelineArtifact function", () => { it("should handle exception during processing", async () => { // Mock fetch to throw an error - global.fetch.mockImplementation(() => { + mockFetch.mockImplementation(() => { throw new Error("Network error"); }); @@ -473,7 +474,7 @@ describe("getAzurePipelineArtifact function", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } else { @@ -587,7 +588,7 @@ describe("fetchFailedArtifact function", () => { }; // Setup fetch with a spy to capture the headers - global.fetch.mockImplementation((url, options) => { + mockFetch.mockImplementation((url, options) => { // Verify that the custom headers are included in all requests expect(options.headers).toEqual(customHeaders); @@ -654,7 +655,7 @@ describe("fetchFailedArtifact function", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?api-version")) { return mockListResponse; } else if (url.includes("artifactName=spec-gen-sdk-artifact-FailedAttempt2")) { @@ -689,7 +690,7 @@ describe("fetchFailedArtifact function", () => { statusText: "OK", }; - global.fetch.mockResolvedValue(mockListResponse); + mockFetch.mockResolvedValue(mockListResponse); // Call the function and expect it to return a 404 response const response = await fetchFailedArtifact(defaultParams); @@ -708,7 +709,7 @@ describe("fetchFailedArtifact function", () => { statusText: "Internal Server Error", }; - global.fetch.mockResolvedValue(mockErrorResponse); + mockFetch.mockResolvedValue(mockErrorResponse); // Call the function and expect it to throw await expect(fetchFailedArtifact(defaultParams)).rejects.toThrow( @@ -751,7 +752,7 @@ describe("fetchFailedArtifact function", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?api-version")) { return mockListResponse; } else if (url.includes("artifactName=spec-gen-sdk-artifact-FailedAttempt3")) { diff --git a/.github/workflows/test/avocado-code.test.js b/.github/workflows/test/avocado-code.test.js index 909c782b21b0..4f8fe8589b79 100644 --- a/.github/workflows/test/avocado-code.test.js +++ b/.github/workflows/test/avocado-code.test.js @@ -5,10 +5,9 @@ vi.mock("fs/promises", () => ({ readFile: vi.fn() })); import * as fs from "fs/promises"; -/** @type {import("vitest").Mock} */ -const readFileMock = fs.readFile; +const readFileMock = /** @type {import("vitest").Mock} */ (fs.readFile); -import generateJobSummary from "../src/avocado-code.js"; +import generateJobSummaryImpl from "../src/avocado-code.js"; import { MessageLevel, MessageType } from "../src/message.js"; import { stringify } from "../src/ndjson.js"; import { createMockCore } from "./mocks.js"; @@ -17,6 +16,15 @@ const core = createMockCore(); const outputFile = "avocado.ndjson"; describe("generateJobSummary", () => { + /** + * @param {unknown} asyncFunctionArgs + */ + function generateJobSummary(asyncFunctionArgs) { + return generateJobSummaryImpl( + /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs), + ); + } + beforeEach(() => { vi.stubEnv("AVOCADO_OUTPUT_FILE", outputFile); readFileMock.mockReset(); @@ -31,7 +39,9 @@ describe("generateJobSummary", () => { `[Error: Env var AVOCADO_OUTPUT_FILE must be set]`, ); - expect(core.info.mock.calls.at(-1)[0]).toMatchInlineSnapshot(`"avocadoOutputFile: undefined"`); + expect(core.info.mock.calls.at(-1)?.[0]).toMatchInlineSnapshot( + `"avocadoOutputFile: undefined"`, + ); }); it("no-ops if file cannot be read", async () => { @@ -41,7 +51,7 @@ describe("generateJobSummary", () => { await expect(generateJobSummary({ core })).resolves.toBeUndefined(); - expect(core.info.mock.calls.at(-1)[0]).toMatchInlineSnapshot( + expect(core.info.mock.calls.at(-1)?.[0]).toMatchInlineSnapshot( `"Error reading 'avocado.ndjson': Error: ENOENT: no such file or directory, open 'avocado.ndjson'"`, ); }); @@ -51,7 +61,7 @@ describe("generateJobSummary", () => { await expect(generateJobSummary({ core })).resolves.toBeUndefined(); - expect(core.notice.mock.calls.at(-1)[0]).toMatchInlineSnapshot( + expect(core.notice.mock.calls.at(-1)?.[0]).toMatchInlineSnapshot( `"No messages in 'avocado.ndjson'"`, ); }); diff --git a/.github/workflows/test/breaking-change-add-label-artifacts.test.js b/.github/workflows/test/breaking-change-add-label-artifacts.test.js index a36b9fc4b56c..14aec9b63ecb 100644 --- a/.github/workflows/test/breaking-change-add-label-artifacts.test.js +++ b/.github/workflows/test/breaking-change-add-label-artifacts.test.js @@ -1,7 +1,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { REVIEW_REQUIRED_LABELS } from "../../shared/src/breaking-change.js"; import { PER_PAGE_MAX } from "../../shared/src/github.js"; -import getLabelActions, { +import getLabelActionsImpl, { CROSS_VERSION_BREAKING_CHANGE_WORKFLOW_NAME, SWAGGER_BREAKING_CHANGE_WORKFLOW_NAME, } from "../src/breaking-change-add-label-artifacts.js"; @@ -12,10 +12,19 @@ vi.mock("../src/context.js", () => ({ extractInputs: vi.fn(), })); +/** + * @param {Partial} asyncFunctionArgs + */ +function getLabelActions(asyncFunctionArgs) { + return getLabelActionsImpl( + /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs), + ); +} + describe("breaking-change-add-label-artifacts", () => { - let mockGithub; - let mockContext; - let mockCore; + /** @type {ReturnType} */ let mockGithub; + /** @type {ReturnType} */ let mockContext; + /** @type {ReturnType} */ let mockCore; beforeEach(() => { // Reset all mocks before each test @@ -35,9 +44,9 @@ describe("breaking-change-add-label-artifacts", () => { }; const createMockWorkflowRun = ( - name, + /** @type {string} */ name, status = "completed", - conclusion = "success", + /** @type {string|null} */ conclusion = "success", id = 1, updated_at = "2024-01-01T12:00:00Z", ) => ({ @@ -48,21 +57,26 @@ describe("breaking-change-add-label-artifacts", () => { updated_at, }); - const createMockArtifact = (name) => ({ name }); + const createMockArtifact = (/** @type {string} */ name) => ({ name }); // Shared setup helpers const setupMockInputs = async () => { const { extractInputs } = await import("../src/context.js"); - extractInputs.mockResolvedValue(mockInputs); + /** @type {import("vitest").Mock} */ (extractInputs).mockResolvedValue(mockInputs); }; - const setupWorkflowRunsMock = (workflowRuns) => { + const setupWorkflowRunsMock = ( + /** @type {{ id: number; name: string; status: string; conclusion: string | null; updated_at: string; }[]} */ workflowRuns, + ) => { mockGithub.rest.actions.listWorkflowRunsForRepo.mockResolvedValue({ data: { workflow_runs: workflowRuns }, }); }; - const setupArtifactsMock = (breakingChangeArtifacts, crossVersionArtifacts) => { + const setupArtifactsMock = ( + /** @type {{ name: string; }[]} */ breakingChangeArtifacts, + /** @type {{ name: string; }[]} */ crossVersionArtifacts, + ) => { mockGithub.rest.actions.listWorkflowRunArtifacts .mockResolvedValueOnce({ data: { artifacts: breakingChangeArtifacts } }) .mockResolvedValueOnce({ data: { artifacts: crossVersionArtifacts } }); @@ -78,7 +92,10 @@ describe("breaking-change-add-label-artifacts", () => { expect(mockCore.setOutput).toHaveBeenCalledWith("issue_number", mockInputs.issue_number); }; - const expectStandardOutputs = (breakingChangeValue, versioningValue) => { + const expectStandardOutputs = ( + /** @type {boolean} */ breakingChangeValue, + /** @type {boolean} */ versioningValue, + ) => { expectRequiredOutputs(); expect(mockCore.setOutput).toHaveBeenCalledWith( @@ -96,7 +113,7 @@ describe("breaking-change-add-label-artifacts", () => { expect(mockCore.setOutput).toHaveBeenCalledWith("versioningReviewLabelValue", versioningValue); }; - const expectEarlyReturn = (infoMessage) => { + const expectEarlyReturn = (/** @type {string} */ infoMessage) => { expectRequiredOutputs(); // Ensure setOutput was *only* called with the two required outputs diff --git a/.github/workflows/test/context.test.js b/.github/workflows/test/context.test.js index ffc7ca11ba84..d38299355b85 100644 --- a/.github/workflows/test/context.test.js +++ b/.github/workflows/test/context.test.js @@ -1,9 +1,19 @@ import { describe, expect, it } from "vitest"; import { PER_PAGE_MAX } from "../../shared/src/github.js"; import { fullGitSha } from "../../shared/test/examples.js"; -import { extractInputs } from "../src/context.js"; +import { extractInputs as extractInputsImpl } from "../src/context.js"; import { createMockCore, createMockGithub } from "./mocks.js"; +/** + * + * @param {import("./mocks.js").GitHub} github + * @param {unknown} context + * @param {import("./mocks.js").Core} core + */ +function extractInputs(github, context, core) { + return extractInputsImpl(github, /** @type {import("./mocks.js").Context} */ (context), core); +} + describe("extractInputs", () => { it("unsupported_event", async () => { const context = { diff --git a/.github/workflows/test/github.test.js b/.github/workflows/test/github.test.js index 825c8691d696..c4b6d936339c 100644 --- a/.github/workflows/test/github.test.js +++ b/.github/workflows/test/github.test.js @@ -15,7 +15,7 @@ const mockCore = createMockCore(); describe("getCheckRuns", () => { it("returns matching check_run", async () => { const githubMock = createMockGithub(); - githubMock.rest.checks.listForRef = vi.fn().mockResolvedValue({ + githubMock.rest.checks.listForRef.mockResolvedValue({ data: { check_runs: [ { @@ -27,13 +27,7 @@ describe("getCheckRuns", () => { }, }); - const actual = await getCheckRuns( - githubMock, - createMockContext(), - createMockCore(), - "checkRunName", - "head_sha", - ); + const actual = await getCheckRuns(githubMock, createMockContext(), "checkRunName", "head_sha"); expect(actual).toEqual([ expect.objectContaining({ @@ -46,7 +40,7 @@ describe("getCheckRuns", () => { it("returns null when no check matches", async () => { const githubMock = createMockGithub(); - githubMock.rest.checks.listForRef = vi.fn().mockResolvedValue({ + githubMock.rest.checks.listForRef.mockResolvedValue({ data: { check_runs: [], }, @@ -61,7 +55,7 @@ describe("getCheckRuns", () => { const githubMock = createMockGithub(); const earlierDate = "2025-04-01T00:00:00Z"; const laterDate = "2025-04-02T00:00:00Z"; - githubMock.rest.checks.listForRef = vi.fn().mockResolvedValue({ + githubMock.rest.checks.listForRef.mockResolvedValue({ data: { check_runs: [ { @@ -102,7 +96,7 @@ describe("getCheckRuns", () => { describe("getWorkflowRuns", () => { it("returns matching workflow_run", async () => { const githubMock = createMockGithub(); - githubMock.rest.actions.listWorkflowRunsForRepo = vi.fn().mockResolvedValue({ + githubMock.rest.actions.listWorkflowRunsForRepo.mockResolvedValue({ data: { workflow_runs: [ { @@ -132,7 +126,7 @@ describe("getWorkflowRuns", () => { it("returns null when no workflow matches", async () => { const githubMock = createMockGithub(); - githubMock.rest.actions.listWorkflowRunsForRepo = vi.fn().mockResolvedValue({ + githubMock.rest.actions.listWorkflowRunsForRepo.mockResolvedValue({ data: { workflow_runs: [ { @@ -156,7 +150,7 @@ describe("getWorkflowRuns", () => { const githubMock = createMockGithub(); const earlyDate = "2025-04-01T00:00:00Z"; const laterDate = "2025-04-02T00:00:00Z"; - githubMock.rest.actions.listWorkflowRunsForRepo = vi.fn().mockResolvedValue({ + githubMock.rest.actions.listWorkflowRunsForRepo.mockResolvedValue({ data: { workflow_runs: [ { @@ -221,7 +215,10 @@ describe("writeToActionsSummary function", () => { describe("createLogHook", () => { it("logs request info with body", () => { const mockLogger = createMockLogger(); - const logHook = createLogHook((r) => r, mockLogger); + const logHook = createLogHook( + /** @type {import("@octokit/types").EndpointInterface} */ ((/** @type {any} */ r) => r), + mockLogger, + ); expect( logHook({ @@ -241,7 +238,10 @@ describe("createLogHook", () => { it("logs request info without body", () => { const mockLogger = createMockLogger(); - const logHook = createLogHook((r) => r, mockLogger); + const logHook = createLogHook( + /** @type {import("@octokit/types").EndpointInterface} */ ((/** @type {any} */ r) => r), + mockLogger, + ); expect( logHook({ @@ -273,7 +273,11 @@ describe("createRateLimitHook", () => { const mockLogger = createMockLogger(); const ratelimitHook = createRateLimitHook(mockLogger); - expect(ratelimitHook({ headers: {} })).toBeUndefined(); + expect( + ratelimitHook( + /** @type {import("@octokit/types").OctokitResponse} */ ({ headers: {} }), + ), + ).toBeUndefined(); expect(mockLogger.info).toBeCalledTimes(0); expect(mockLogger.debug).toBeCalledTimes(1); @@ -291,13 +295,15 @@ describe("createRateLimitHook", () => { const reset = (add(new Date(), 30 * Duration.Minute).getTime() / Duration.Second).toFixed(0); expect( - ratelimitHook({ - headers: { - "x-ratelimit-limit": "100", - "x-ratelimit-remaining": "50", - "x-ratelimit-reset": reset, - }, - }), + ratelimitHook( + /** @type {import("@octokit/types").OctokitResponse} */ ({ + headers: { + "x-ratelimit-limit": "100", + "x-ratelimit-remaining": "50", + "x-ratelimit-reset": reset, + }, + }), + ), ).toBeUndefined(); expect(mockLogger.info).toBeCalledTimes(1); expect(mockLogger.info.mock.calls[0]).toMatchInlineSnapshot(` @@ -307,13 +313,15 @@ describe("createRateLimitHook", () => { `); expect( - ratelimitHook({ - headers: { - "x-ratelimit-limit": "100", - "x-ratelimit-remaining": "75", - "x-ratelimit-reset": reset, - }, - }), + ratelimitHook( + /** @type {import("@octokit/types").OctokitResponse} */ ({ + headers: { + "x-ratelimit-limit": "100", + "x-ratelimit-remaining": "75", + "x-ratelimit-reset": reset, + }, + }), + ), ).toBeUndefined(); expect(mockLogger.info).toBeCalledTimes(2); expect(mockLogger.info.mock.calls[1]).toMatchInlineSnapshot(` @@ -323,13 +331,15 @@ describe("createRateLimitHook", () => { `); expect( - ratelimitHook({ - headers: { - "x-ratelimit-limit": "100", - "x-ratelimit-remaining": "25", - "x-ratelimit-reset": reset, - }, - }), + ratelimitHook( + /** @type {import("@octokit/types").OctokitResponse} */ ({ + headers: { + "x-ratelimit-limit": "100", + "x-ratelimit-remaining": "25", + "x-ratelimit-reset": reset, + }, + }), + ), ).toBeUndefined(); expect(mockLogger.info).toBeCalledTimes(3); expect(mockLogger.info.mock.calls[2]).toMatchInlineSnapshot(` @@ -339,13 +349,15 @@ describe("createRateLimitHook", () => { `); expect( - ratelimitHook({ - headers: { - "x-ratelimit-limit": "100", - "x-ratelimit-remaining": "0", - "x-ratelimit-reset": reset, - }, - }), + ratelimitHook( + /** @type {import("@octokit/types").OctokitResponse} */ ({ + headers: { + "x-ratelimit-limit": "100", + "x-ratelimit-remaining": "0", + "x-ratelimit-reset": reset, + }, + }), + ), ).toBeUndefined(); expect(mockLogger.info).toBeCalledTimes(4); expect(mockLogger.info.mock.calls[3]).toMatchInlineSnapshot(` diff --git a/.github/workflows/test/issues.test.js b/.github/workflows/test/issues.test.js index e9eb083c1bcc..75779c391d69 100644 --- a/.github/workflows/test/issues.test.js +++ b/.github/workflows/test/issues.test.js @@ -1,7 +1,7 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { defaultLogger } from "../../shared/src/logger.js"; import { getIssueNumber } from "../src/issues.js"; -import { asGitHub, createMockGithub, createMockLogger } from "./mocks.js"; +import { createMockGithub, createMockLogger } from "./mocks.js"; /** @typedef {import('@actions/github-script').AsyncFunctionArguments["github"]} GitHub */ @@ -14,9 +14,7 @@ describe("getIssueNumber", () => { }); it("should return NaN when head_sha is missing", async () => { // Call function and expect it to throw - await expect( - getIssueNumber(asGitHub(mockGithub), ""), - ).rejects.toThrowErrorMatchingInlineSnapshot( + await expect(getIssueNumber(mockGithub, "")).rejects.toThrowErrorMatchingInlineSnapshot( `[Error: head_sha is required when trying to search a PR.]`, ); }); @@ -36,7 +34,7 @@ describe("getIssueNumber", () => { }); // Call function - const result = await getIssueNumber(asGitHub(mockGithub), "abc123", mockLogger); + const result = await getIssueNumber(mockGithub, "abc123", mockLogger); // Verify result uses first PR expect(result.issueNumber).toBe(123); @@ -57,7 +55,7 @@ describe("getIssueNumber", () => { }); // Call function - const result = await getIssueNumber(asGitHub(mockGithub), "abc123", defaultLogger); + const result = await getIssueNumber(mockGithub, "abc123", defaultLogger); // Verify result expect(result.issueNumber).toBeNaN(); @@ -69,6 +67,6 @@ describe("getIssueNumber", () => { mockGithub.rest.search.issuesAndPullRequests.mockRejectedValue(searchError); // Call function and expect it to throw - await expect(getIssueNumber(asGitHub(mockGithub), "abc123", defaultLogger)).rejects.toThrow(); + await expect(getIssueNumber(mockGithub, "abc123", defaultLogger)).rejects.toThrow(); }); }); diff --git a/.github/workflows/test/message.test.js b/.github/workflows/test/message.test.js index 78209e033420..24bf69a8805d 100644 --- a/.github/workflows/test/message.test.js +++ b/.github/workflows/test/message.test.js @@ -9,6 +9,11 @@ import { generateMarkdownTable, } from "../src/message.js"; +/** + * @param {import("zod").ZodType} schema + * @param {unknown} input + * @param {string | RegExp | import("@vitest/utils").Constructable | Error | undefined} expectedError + */ function testSchemaParse(schema, input, expectedError) { if (expectedError) { expect(() => schema.parse(input)).toThrowError(expectedError); @@ -18,19 +23,24 @@ function testSchemaParse(schema, input, expectedError) { } describe("MessageLevelSchema", () => { - it.each([["foo", ZodError], [MessageLevel.Error], [MessageLevel.Info], [MessageLevel.Warning]])( - "parse(%o)", - (input, expectedError) => { - testSchemaParse(MessageLevelSchema, input, expectedError); - }, - ); + it.each([ + ["foo", ZodError], + [MessageLevel.Error, undefined], + [MessageLevel.Info, undefined], + [MessageLevel.Warning, undefined], + ])("parse(%o)", (input, expectedError) => { + testSchemaParse(MessageLevelSchema, input, expectedError); + }); }); describe("BaseMessageRecordSchema", () => { it.each([ [{}, ZodError], [{ level: "foo", message: 1, time: "bar" }, ZodError], - [{ level: MessageLevel.Error, message: "test-message", time: new Date().toISOString() }], + [ + { level: MessageLevel.Error, message: "test-message", time: new Date().toISOString() }, + undefined, + ], [ { level: MessageLevel.Warning, @@ -41,6 +51,7 @@ describe("BaseMessageRecordSchema", () => { extra: { extraKey: "extraVal" }, groupName: "test-group-name", }, + undefined, ], ])("parse(%o)", (input, expectedError) => { testSchemaParse(BaseMessageRecordSchema, input, expectedError); @@ -67,6 +78,7 @@ describe("MessageRecordSchema", () => { message: "test-message", time: new Date().toISOString(), }, + undefined, ], [ { @@ -79,6 +91,7 @@ describe("MessageRecordSchema", () => { extra: { extraKey: "extraVal" }, groupName: "test-group-name", }, + undefined, ], [ { @@ -98,6 +111,7 @@ describe("MessageRecordSchema", () => { { tag: "tag2", path: "path2" }, ], }, + undefined, ], ])("parse(%o)", (input, expectedError) => { testSchemaParse(MessageRecordSchema, input, expectedError); @@ -106,6 +120,9 @@ describe("MessageRecordSchema", () => { describe("generateMarkdownTable", () => { it("no messages", () => { + /** + * @type {import("../src/message.js").MessageRecord[]} + */ const messages = []; expect(generateMarkdownTable(messages)).toMatchInlineSnapshot(` diff --git a/.github/workflows/test/mocks.js b/.github/workflows/test/mocks.js index 920eb1e752d5..bf444f415c27 100644 --- a/.github/workflows/test/mocks.js +++ b/.github/workflows/test/mocks.js @@ -3,16 +3,25 @@ import { vi } from "vitest"; /** * @typedef {import('@actions/github-script').AsyncFunctionArguments["github"]} GitHub + * @typedef {import('@actions/github-script').AsyncFunctionArguments["context"]} Context + * @typedef {import('@actions/github-script').AsyncFunctionArguments["core"]} Core */ -// Partial mock of `github` parameter passed into github-script actions +/** + * @returns {GitHub & ReturnType} + */ export function createMockGithub() { + return /** @type {GitHub & ReturnType} */ (createMockGithubImpl()); +} + +// Partial mock of `github` parameter passed into github-script actions +function createMockGithubImpl() { return { hook: { after: vi.fn(), before: vi.fn(), }, - paginate: async (func, params) => { + paginate: async (/** @type {(arg0: any) => any} */ func, /** @type {any} */ params) => { // Assume all test data fits in single page const data = (await func(params)).data; @@ -55,15 +64,18 @@ export function createMockGithub() { } /** - * @returns {GitHub} - * @param {any} mockGithub + * @returns {Core & ReturnType} */ -export function asGitHub(mockGithub) { - return /** @type {GitHub} */ mockGithub; +export function createMockCore() { + return /** @type {Core & ReturnType} */ (createMockCoreImpl()); } // Partial mock of `core` parameter passed into to github-script actions -export function createMockCore() { +function createMockCoreImpl() { + const summary = {}; + summary.addRaw = vi.fn().mockReturnValue(summary); + summary.write = vi.fn().mockResolvedValue(undefined); + return { debug: vi.fn(console.debug), info: vi.fn(console.log), @@ -73,13 +85,7 @@ export function createMockCore() { isDebug: vi.fn().mockReturnValue(true), setOutput: vi.fn((name, value) => console.log(`setOutput('${name}', '${value}')`)), setFailed: vi.fn((msg) => console.log(`setFailed('${msg}')`)), - summary: { - // eslint-disable-next-line @typescript-eslint/no-unused-vars - addRaw: vi.fn(function (content) { - return this; // Return 'this' for method chaining - }), - write: vi.fn().mockResolvedValue(undefined), - }, + summary, }; } @@ -94,8 +100,15 @@ export function createMockRequestError(status) { }); } -// Partial mock of `context` parameter passed into github-script actions +/** + * @returns {Context & ReturnType} + */ export function createMockContext() { + return /** @type {Context & ReturnType} */ (createMockContextImpl()); +} + +// Partial mock of `context` parameter passed into github-script actions +function createMockContextImpl() { return { payload: {}, repo: { diff --git a/.github/workflows/test/ndjson.test.js b/.github/workflows/test/ndjson.test.js index 94da6cc20d92..f5416fe76383 100644 --- a/.github/workflows/test/ndjson.test.js +++ b/.github/workflows/test/ndjson.test.js @@ -21,6 +21,7 @@ describe("ndjson", () => { }); it("empty array", () => { + /** @type {string[]} */ let values = []; const stringifiedValues = stringify(values); diff --git a/.github/workflows/test/retries.test.js b/.github/workflows/test/retries.test.js index 49895789f26b..a1c4c68cb38d 100644 --- a/.github/workflows/test/retries.test.js +++ b/.github/workflows/test/retries.test.js @@ -55,9 +55,13 @@ describe("retry function", () => { }); describe("fetchWithRetry function", () => { + /** @type {import("vitest").Mock} */ + let mockFetch; + beforeEach(() => { + mockFetch = vi.fn(); // Mock global fetch - global.fetch = vi.fn(); + global.fetch = mockFetch; }); it("should call fetch with provided url and options", async () => { @@ -65,7 +69,7 @@ describe("fetchWithRetry function", () => { ok: true, json: () => Promise.resolve({ data: "test" }), }; - global.fetch.mockResolvedValue(mockResponse); + mockFetch.mockResolvedValue(mockResponse); const url = "https://example.com/api"; const options = { method: "POST", body: JSON.stringify({ key: "value" }) }; diff --git a/.github/workflows/test/sdk-breaking-change-labels.test.js b/.github/workflows/test/sdk-breaking-change-labels.test.js index a2dca7492c61..9b2e58cc9d49 100644 --- a/.github/workflows/test/sdk-breaking-change-labels.test.js +++ b/.github/workflows/test/sdk-breaking-change-labels.test.js @@ -1,7 +1,10 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { sdkLabels } from "../../shared/src/sdk-types.js"; import { LabelAction } from "../src/label.js"; -import { getLabelAndAction, getLabelAndActionImpl } from "../src/sdk-breaking-change-labels.js"; +import { + getLabelAndActionImpl, + getLabelAndAction as getLabelAndActionSrc, +} from "../src/sdk-breaking-change-labels.js"; import { createMockContext, createMockCore, createMockGithub } from "./mocks.js"; // Mock dependencies @@ -9,13 +12,23 @@ vi.mock("../src/context.js", () => ({ extractInputs: vi.fn(), })); +const mockFetch = vi.fn(); // Mock global fetch -global.fetch = vi.fn(); +global.fetch = mockFetch; const mockGithub = createMockGithub(); const mockContext = createMockContext(); const mockCore = createMockCore(); +/** + * @param {Partial} asyncFunctionArgs + */ +function getLabelAndAction(asyncFunctionArgs) { + return getLabelAndActionSrc( + /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs), + ); +} + describe("sdk-breaking-change-labels", () => { beforeEach(() => { // Reset mocks @@ -32,7 +45,7 @@ describe("sdk-breaking-change-labels", () => { // Setup mock implementation for extractInputs const { extractInputs } = await import("../src/context.js"); - extractInputs.mockResolvedValue(mockInputs); + /** @type {import("vitest").Mock} */ (extractInputs).mockResolvedValue(mockInputs); // Mock fetch responses // First fetch - artifact metadata @@ -60,7 +73,7 @@ describe("sdk-breaking-change-labels", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } else { @@ -91,7 +104,7 @@ describe("sdk-breaking-change-labels", () => { // Setup mock for extractInputs const { extractInputs } = await import("../src/context.js"); - extractInputs.mockResolvedValue(inputs); + /** @type {import("vitest").Mock} */ (extractInputs)(inputs); // Mock artifact responses with 'remove' action const mockArtifactResponse = { @@ -116,7 +129,7 @@ describe("sdk-breaking-change-labels", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } else { @@ -147,7 +160,7 @@ describe("sdk-breaking-change-labels", () => { // Setup mock for extractInputs const { extractInputs } = await import("../src/context.js"); - extractInputs.mockResolvedValue(inputs); + /** @type {import("vitest").Mock} */ (extractInputs)(inputs); // Mock artifact responses with 'remove' action const mockArtifactResponse = { @@ -172,7 +185,7 @@ describe("sdk-breaking-change-labels", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } else { @@ -203,7 +216,7 @@ describe("sdk-breaking-change-labels", () => { // Setup mock for extractInputs const { extractInputs } = await import("../src/context.js"); - extractInputs.mockResolvedValue(inputs); + /** @type {import("vitest").Mock} */ (extractInputs).mockResolvedValue(inputs); // Call function and expect it to throw await expect( @@ -225,7 +238,7 @@ describe("sdk-breaking-change-labels", () => { }; // Mock fetch failure - global.fetch.mockResolvedValue({ + mockFetch.mockResolvedValue({ ok: false, status: 500, statusText: "Server Error", @@ -235,8 +248,6 @@ describe("sdk-breaking-change-labels", () => { // Call function const result = await getLabelAndActionImpl({ details_url: inputs.details_url, - head_sha: inputs.head_sha, - github: mockGithub, core: mockCore, }); @@ -262,7 +273,7 @@ describe("sdk-breaking-change-labels", () => { }; // Mock fetch to handle the artifact URL with 404 error and fallback behavior - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=spec-gen-sdk-artifact")) { // Initial fetch for the specific artifact returns 404 return Promise.resolve({ @@ -306,8 +317,6 @@ describe("sdk-breaking-change-labels", () => { // Call function const result = await getLabelAndActionImpl({ details_url: inputs.details_url, - head_sha: inputs.head_sha, - github: mockGithub, core: mockCore, }); @@ -334,7 +343,7 @@ describe("sdk-breaking-change-labels", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } @@ -344,8 +353,6 @@ describe("sdk-breaking-change-labels", () => { await expect( getLabelAndActionImpl({ details_url: inputs.details_url, - head_sha: inputs.head_sha, - github: mockGithub, core: mockCore, }), ).rejects.toThrow(); @@ -367,7 +374,7 @@ describe("sdk-breaking-change-labels", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } @@ -377,8 +384,6 @@ describe("sdk-breaking-change-labels", () => { await expect( getLabelAndActionImpl({ details_url: inputs.details_url, - head_sha: inputs.head_sha, - github: mockGithub, core: mockCore, }), ).rejects.toThrow(); @@ -412,7 +417,7 @@ describe("sdk-breaking-change-labels", () => { }; // Setup fetch to return different responses for each call - global.fetch.mockImplementation((url) => { + mockFetch.mockImplementation((url) => { if (url.includes("artifacts?artifactName=")) { return mockArtifactResponse; } else { @@ -424,8 +429,6 @@ describe("sdk-breaking-change-labels", () => { await expect( getLabelAndActionImpl({ details_url: inputs.details_url, - head_sha: inputs.head_sha, - github: mockGithub, core: mockCore, }), ).rejects.toThrow(); @@ -439,15 +442,13 @@ describe("sdk-breaking-change-labels", () => { }; // Mock fetch to throw an error - global.fetch.mockImplementation(() => { + mockFetch.mockImplementation(() => { throw new Error("Network error"); }); // Start the async operation that will retry const promise = getLabelAndActionImpl({ details_url: inputs.details_url, - head_sha: inputs.head_sha, - github: mockGithub, core: mockCore, // Change default retry delay from 1000ms to 1ms to reduce test time retryOptions: { initialDelayMs: 1 }, diff --git a/.github/workflows/test/set-status.test.js b/.github/workflows/test/set-status.test.js index 48c02adbd6eb..39728bc7de6a 100644 --- a/.github/workflows/test/set-status.test.js +++ b/.github/workflows/test/set-status.test.js @@ -5,7 +5,10 @@ import { setStatusImpl } from "../src/set-status.js"; import { createMockCore, createMockGithub } from "./mocks.js"; describe("setStatusImpl", () => { + /** @type {ReturnType} */ let core; + + /** @type {ReturnType} */ let github; beforeEach(() => { @@ -14,10 +17,9 @@ describe("setStatusImpl", () => { }); it("throws if inputs null", async () => { - // @ts-expect-error Testing invalid input type - await expect(setStatusImpl({})).rejects.toMatchInlineSnapshot( - `[Error: head_sha is not a valid full git SHA: 'undefined']`, - ); + await expect( + setStatusImpl(/** @type {Parameters[0]} */ ({})), + ).rejects.toMatchInlineSnapshot(`[Error: head_sha is not a valid full git SHA: 'undefined']`); }); it.each([null, undefined, "", "abc123"])("throws when head_sha is %o", async (head_sha) => { @@ -25,8 +27,7 @@ describe("setStatusImpl", () => { setStatusImpl({ owner: "test-owner", repo: "test-repo", - // @ts-expect-error - Testing invalid input - head_sha, + head_sha: /** @type {string} */ (head_sha), issue_number: 123, target_url: "https://test.com/set_status_url", github, @@ -44,8 +45,7 @@ describe("setStatusImpl", () => { owner: "test-owner", repo: "test-repo", head_sha: fullGitSha, - // @ts-expect-error - Testing invalid input - issue_number, + issue_number: /** @type {Number} */ (issue_number), target_url: "https://test.com/set_status_url", github, core, diff --git a/.github/workflows/test/spec-gen-sdk-status.test.js b/.github/workflows/test/spec-gen-sdk-status.test.js index a1aef18a6eb7..e9ae2eb107d0 100644 --- a/.github/workflows/test/spec-gen-sdk-status.test.js +++ b/.github/workflows/test/spec-gen-sdk-status.test.js @@ -6,10 +6,19 @@ import { setSpecGenSdkStatusImpl } from "../src/spec-gen-sdk-status.js"; import { createMockCore, createMockGithub } from "./mocks.js"; describe("spec-gen-sdk-status", () => { + /** @type {ReturnType} */ let mockGithub; + + /** @type {ReturnType} */ let mockCore; + + /** @type {import("vitest").MockInstance} */ let getAzurePipelineArtifactMock; + + /** @type {import("vitest").MockInstance} */ let writeToActionsSummaryMock; + + /** @type {import("vitest").MockInstance} */ let appendFileSyncMock; beforeEach(() => { @@ -128,6 +137,7 @@ describe("spec-gen-sdk-status", () => { target_url: "https://example.com", github: mockGithub, core: mockCore, + issue_number: 123, }); // Verify the right status was set @@ -194,6 +204,7 @@ describe("spec-gen-sdk-status", () => { target_url: "https://example.com", github: mockGithub, core: mockCore, + issue_number: 123, }); // Verify the right status was set @@ -232,6 +243,7 @@ describe("spec-gen-sdk-status", () => { target_url: "https://example.com", github: mockGithub, core: mockCore, + issue_number: 123, }); // Verify summary was written @@ -267,6 +279,7 @@ describe("spec-gen-sdk-status", () => { target_url: "https://example.com", github: mockGithub, core: mockCore, + issue_number: 123, }), ).rejects.toThrow("Artifact 'spec-gen-sdk-artifact' not found"); }); @@ -323,6 +336,7 @@ describe("spec-gen-sdk-status", () => { target_url: "https://example.com", github: mockGithub, core: mockCore, + issue_number: 123, }); // Verify the right status was set (success since only non-required failed) diff --git a/.github/workflows/test/summarize-checks/labelling.test.js b/.github/workflows/test/summarize-checks/labelling.test.js index 21b2dc9e8ba0..30214802d743 100644 --- a/.github/workflows/test/summarize-checks/labelling.test.js +++ b/.github/workflows/test/summarize-checks/labelling.test.js @@ -303,7 +303,7 @@ describe("ARM review process labelling", () => { it.each(testCases)( "$description", async ({ existingLabels, expectedLabelsToAdd, expectedLabelsToRemove }) => { - /** @type {import("./labelling.js").LabelContext} */ + /** @type {import("../../src/summarize-checks/labelling.js").LabelContext} */ const labelContext = { present: new Set(), toAdd: new Set(), diff --git a/.github/workflows/test/summarize-checks/summarize-checks.test.js b/.github/workflows/test/summarize-checks/summarize-checks.test.js index 77a902e65c1d..07208a8ff7b5 100644 --- a/.github/workflows/test/summarize-checks/summarize-checks.test.js +++ b/.github/workflows/test/summarize-checks/summarize-checks.test.js @@ -12,12 +12,20 @@ import { } from "../../src/summarize-checks/summarize-checks.js"; import { createMockCore, createMockGithub } from "../mocks.js"; +/** + * @typedef {import("../../src/summarize-checks/summarize-checks.js").CheckRunData} CheckRunData + */ + const mockCore = createMockCore(); const WORKFLOW_URL = "http://github.com/a/fake/workflowrun/url"; /** * Find and extract the "Next Steps to Merge" existing comment on a PR. * Used in the integration test. + * @param {import("../mocks.js").GitHub} github + * @param {string} owner + * @param {string} repo + * @param {number} prNumber */ async function getNextStepsComment(github, owner, repo, prNumber) { try { @@ -29,12 +37,12 @@ async function getNextStepsComment(github, owner, repo, prNumber) { // Find comment containing "Next Steps to Merge" const nextStepsComment = comments.find((comment) => - comment.body.includes("

Next Steps to Merge

"), + comment.body?.includes("

Next Steps to Merge

"), ); return nextStepsComment ? nextStepsComment.body : null; } catch (error) { - console.error(`Error getting comments for PR #${prNumber}:`, error.message); + console.error(`Error getting comments for PR #${prNumber}:`, error); return null; } } @@ -57,9 +65,13 @@ describe("Summarize Checks Integration Tests", () => { "Monitor", ]; - const github = new Octokit({ - auth: process.env.GITHUB_TOKEN, - }); + const github = /** @type {import("../mocks.js").GitHub} */ ( + /** @type {unknown} */ ( + new Octokit({ + auth: process.env.GITHUB_TOKEN, + }) + ) + ); const { data: pr } = await github.rest.pulls.get({ owner: owner, @@ -126,8 +138,11 @@ describe("Summarize Checks Unit Tests", () => { it("should generate success summary for no matched check suites (completed impactAssessment)", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; + /** @type {CheckRunData[]} */ const requiredCheckRuns = []; const expectedOutput = [ '

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.', @@ -155,7 +170,9 @@ describe("Summarize Checks Unit Tests", () => { it("should generate success summary for all completed check suites", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedOutput = [ '

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.', @@ -264,6 +281,7 @@ describe("Summarize Checks Unit Tests", () => { it("should generate success summary with completed required checks but in-progress FYI", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; const expectedOutput = [ '

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.', @@ -336,6 +354,7 @@ describe("Summarize Checks Unit Tests", () => { it("should generate success summary with 0 required checks but in-progress FYI", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; const expectedOutput = [ '

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.', @@ -346,6 +365,7 @@ describe("Summarize Checks Unit Tests", () => { }, ]; + /** @type {CheckRunData[]} */ const requiredCheckRuns = []; const fyiCheckRuns = [ @@ -392,6 +412,7 @@ describe("Summarize Checks Unit Tests", () => { it("should generate success with warning for error FYI", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; const expectedOutput = [ `

Next Steps to Merge

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:
  • ⚠️ The check named license/cla has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide
If you still want to proceed merging this PR without addressing the above failures, refer to step 4 in the PR workflow diagram.

Comment generated by summarize-checks workflow run.`, @@ -437,8 +458,9 @@ describe("Summarize Checks Unit Tests", () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; const labelNames = ["CI-NewRPNamespaceWithoutRPaaS", "RPaaSException"]; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; - const expectedCommentBody = `

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.`; + const expectedCommentBody = `

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.`; const expectedCheckOutput = { name: "Automated merging requirements met", result: "SUCCESS", @@ -462,6 +484,7 @@ describe("Summarize Checks Unit Tests", () => { requiredCheckRuns, fyiCheckRuns, true, // assessmentCompleted + "target_url", ); expect(commentBody).toEqual(expectedCommentBody); @@ -471,7 +494,9 @@ describe("Summarize Checks Unit Tests", () => { it("should generate pending summary when checks are partially in progress", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedOutput = [ `

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.`, @@ -520,7 +545,9 @@ describe("Summarize Checks Unit Tests", () => { it("should generate pending summary when checks are in progress", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedOutput = [ `

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.`, @@ -569,7 +596,9 @@ describe("Summarize Checks Unit Tests", () => { it("should generate pending summary when impact assessment is not completed", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedOutput = [ `

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.`, @@ -678,7 +707,9 @@ describe("Summarize Checks Unit Tests", () => { it("should generate pending summary when checks are in progress", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedOutput = [ `

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.`, @@ -814,6 +845,7 @@ describe("Summarize Checks Unit Tests", () => { "TypeSpec", "VersioningReviewRequired", ]; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedComment = `

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ ` + @@ -944,6 +976,7 @@ describe("Summarize Checks Unit Tests", () => { "TypeSpec", "VersioningReviewRequired", ]; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedComment = "

    Next Steps to Merge

    Next steps that must be taken to merge this PR:
      " + @@ -1067,6 +1100,7 @@ describe("Summarize Checks Unit Tests", () => { it("should generate error summary with a failed required check, and failed FYI checks", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; const expectedCheckOutput = { name: "Automated merging requirements met", @@ -1112,6 +1146,7 @@ describe("Summarize Checks Unit Tests", () => { it("should generate error summary with a failed required check, and in-progress FYI checks", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; const expectedCheckOutput = { name: "Automated merging requirements met", @@ -1146,6 +1181,7 @@ describe("Summarize Checks Unit Tests", () => { requiredCheckRuns, fyiCheckRuns, true, // assessmentCompleted + "target_url", ); expect(automatedCheckOutput).toEqual(expectedCheckOutput); @@ -1155,8 +1191,9 @@ describe("Summarize Checks Unit Tests", () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; const labelNames = ["CI-NewRPNamespaceWithoutRPaaS"]; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; - const expectedCommentBody = `

      Next Steps to Merge

      Next steps that must be taken to merge this PR:
      • ❌ This PR has CI-NewRPNamespaceWithoutRPaaS label. This means it is introducing a new RP (Resource Provider) namespace that has not been onboarded with RPaaS. Merging this PR to the main branch is blocked as RPaaS is required for new RPs.
        To resolve, use RPaaS to onboard the new RP. To apply for exception, see aka.ms/RPaaSException.


      Comment generated by summarize-checks workflow run.`; + const expectedCommentBody = `

      Next Steps to Merge

      Next steps that must be taken to merge this PR:
      • ❌ This PR has CI-NewRPNamespaceWithoutRPaaS label. This means it is introducing a new RP (Resource Provider) namespace that has not been onboarded with RPaaS. Merging this PR to the main branch is blocked as RPaaS is required for new RPs.
        To resolve, use RPaaS to onboard the new RP. To apply for exception, see aka.ms/RPaaSException.


      Comment generated by summarize-checks workflow run.`; const expectedCheckOutput = { name: "Automated merging requirements met", result: "FAILURE", @@ -1181,6 +1218,7 @@ describe("Summarize Checks Unit Tests", () => { requiredCheckRuns, fyiCheckRuns, true, // assessmentCompleted + "target_url", ); expect(commentBody).toEqual(expectedCommentBody); @@ -1190,7 +1228,9 @@ describe("Summarize Checks Unit Tests", () => { it("should generate error summary when checks are in error state", async () => { const repo = "azure-rest-api-specs"; const targetBranch = "main"; + /** @type {string[]} */ const labelNames = []; + /** @type {CheckRunData[]} */ const fyiCheckRuns = []; const expectedCheckOutput = { name: "Automated merging requirements met", @@ -1216,6 +1256,7 @@ describe("Summarize Checks Unit Tests", () => { requiredCheckRuns, fyiCheckRuns, true, // assessmentCompleted + "target_url", ); expect(automatedCheckOutput).toEqual(expectedCheckOutput); diff --git a/.github/workflows/test/update-labels.test.js b/.github/workflows/test/update-labels.test.js index e9cfdd97c869..0c4d60fae0c6 100644 --- a/.github/workflows/test/update-labels.test.js +++ b/.github/workflows/test/update-labels.test.js @@ -1,9 +1,18 @@ import { describe, expect, it } from "vitest"; import { PER_PAGE_MAX } from "../../shared/src/github.js"; import { fullGitSha } from "../../shared/test/examples.js"; -import updateLabels, { updateLabelsImpl } from "../src/update-labels.js"; +import updateLabelsSrc, { updateLabelsImpl } from "../src/update-labels.js"; import { createMockCore, createMockGithub, createMockRequestError } from "./mocks.js"; +/** + * @param {unknown} asyncFunctionArgs + */ +function updateLabels(asyncFunctionArgs) { + return updateLabelsSrc( + /** @type {import("@actions/github-script").AsyncFunctionArguments} */ (asyncFunctionArgs), + ); +} + describe("updateLabels", () => { it("loads inputs from context", async () => { const core = createMockCore(); @@ -63,6 +72,7 @@ describe("updateLabelsImpl", () => { updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: 123, run_id: NaN, github: github, @@ -90,6 +100,7 @@ describe("updateLabelsImpl", () => { updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: NaN, run_id: 456, github: github, @@ -108,6 +119,7 @@ describe("updateLabelsImpl", () => { updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: NaN, run_id: 456, github: github, @@ -139,6 +151,7 @@ describe("updateLabelsImpl", () => { updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: 123, run_id: 456, github: github, @@ -189,6 +202,7 @@ describe("updateLabelsImpl", () => { updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: 123, run_id: 456, github: github, @@ -226,6 +240,7 @@ describe("updateLabelsImpl", () => { updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: 123, run_id: 456, github: github, @@ -257,6 +272,7 @@ describe("updateLabelsImpl", () => { const updateLabelsImplPromise = updateLabelsImpl({ owner: "owner", repo: "repo", + head_sha: fullGitSha, issue_number: 123, run_id: 456, github: github, diff --git a/.github/workflows/test/verify-run-status.test.js b/.github/workflows/test/verify-run-status.test.js index 7a6280e9d26a..31e9100f627d 100644 --- a/.github/workflows/test/verify-run-status.test.js +++ b/.github/workflows/test/verify-run-status.test.js @@ -1,5 +1,5 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; -import { verifyRunStatusImpl } from "../src/verify-run-status.js"; +import { verifyRunStatusImpl as verifyRunStatusImplSrc } from "../src/verify-run-status.js"; import { createMockCore, createMockGithub } from "./mocks.js"; vi.mock("../src/context.js", () => { @@ -18,6 +18,35 @@ vi.mock("../src/github.js", () => { }; }); +/** + * @param {Object} params + * @param {import('@actions/github-script').AsyncFunctionArguments["github"]} params.github + * @param {Partial} params.context + * @param {import('@actions/github-script').AsyncFunctionArguments["core"]} params.core + * @param {string} params.checkRunName + * @param {string} [params.commitStatusName] + * @param {string} [params.workflowName] + */ +export async function verifyRunStatusImpl({ + github, + context, + core, + checkRunName, + commitStatusName, + workflowName, +}) { + return verifyRunStatusImplSrc({ + github, + context: /** @type {import('@actions/github-script').AsyncFunctionArguments["context"]} */ ( + context + ), + core, + checkRunName, + commitStatusName, + workflowName, + }); +} + describe("verifyRunStatusImpl", () => { // Reset mock call history before each test beforeEach(() => { @@ -27,7 +56,7 @@ describe("verifyRunStatusImpl", () => { it("verifies status when check_run event fires", async () => { const github = createMockGithub(); const { getWorkflowRuns } = await import("../src/github.js"); - getWorkflowRuns.mockResolvedValue([ + /** @type {import("vitest").Mock} */ (getWorkflowRuns).mockResolvedValue([ { name: "workflowName", status: "completed", @@ -64,7 +93,7 @@ describe("verifyRunStatusImpl", () => { it("verifies status when workflow_run event fires", async () => { const github = createMockGithub(); - github.rest.checks.listForRef = vi.fn().mockResolvedValue({ + github.rest.checks.listForRef.mockResolvedValue({ data: { check_runs: [ { @@ -103,7 +132,7 @@ describe("verifyRunStatusImpl", () => { it("returns early during workflow_run event when no matching check_run is found", async () => { const github = createMockGithub(); - github.rest.checks.listForRef = vi.fn().mockResolvedValue({ + github.rest.checks.listForRef.mockResolvedValue({ data: { check_runs: [], }, @@ -134,7 +163,7 @@ describe("verifyRunStatusImpl", () => { it("returns early during check_run event when no matching workflow_run is found", async () => { const { getWorkflowRuns } = await import("../src/github.js"); - getWorkflowRuns.mockResolvedValue([]); + /** @type {import("vitest").Mock} */ (getWorkflowRuns).mockResolvedValue([]); const context = { eventName: "check_run", @@ -185,7 +214,7 @@ describe("verifyRunStatusImpl", () => { it("throws if check_run conclusion does not match workflow_run conclusion", async () => { const { getWorkflowRuns } = await import("../src/github.js"); - getWorkflowRuns.mockResolvedValue([ + /** @type {import("vitest").Mock} */ (getWorkflowRuns).mockResolvedValue([ { name: "workflowName", status: "completed", @@ -217,7 +246,7 @@ describe("verifyRunStatusImpl", () => { it("throws when in check_suite event but no check_run with name is found", async () => { const github = createMockGithub(); - github.rest.checks.listForRef = vi.fn().mockResolvedValue({ + github.rest.checks.listForRef.mockResolvedValue({ data: { check_runs: [], }, @@ -248,14 +277,14 @@ describe("verifyRunStatusImpl", () => { it("fetches commit status from API when not status event", async () => { const { getCheckRuns, getCommitStatuses } = await import("../src/github.js"); - getCheckRuns.mockResolvedValue([ + /** @type {import("vitest").Mock}*/ (getCheckRuns).mockResolvedValue([ { name: "checkRunName", conclusion: "success", html_url: "https://example.com/check", }, ]); - getCommitStatuses.mockResolvedValue([ + /** @type {import("vitest").Mock}*/ (getCommitStatuses).mockResolvedValue([ { context: "commitStatusName", state: "success", @@ -292,14 +321,16 @@ describe("verifyRunStatusImpl", () => { it("handles API error when fetching commit status", async () => { const { getCheckRuns, getCommitStatuses } = await import("../src/github.js"); - getCheckRuns.mockResolvedValue([ + /** @type {import("vitest").Mock}*/ (getCheckRuns).mockResolvedValue([ { name: "checkRunName", conclusion: "success", html_url: "https://example.com/check", }, ]); - getCommitStatuses.mockRejectedValue(new Error("API Error")); + /** @type {import("vitest").Mock}*/ (getCommitStatuses).mockRejectedValue( + new Error("API Error"), + ); const context = { eventName: "workflow_run", @@ -327,7 +358,7 @@ describe("verifyRunStatusImpl", () => { it("verifies neutral check run matches success workflow run", async () => { const { getCheckRuns } = await import("../src/github.js"); - getCheckRuns.mockResolvedValue([ + /** @type {import("vitest").Mock}*/ (getCheckRuns).mockResolvedValue([ { name: "checkRunName", conclusion: "neutral", diff --git a/eng/common/instructions/azsdk-tools/check-package-validation.instructions.md b/eng/common/instructions/azsdk-tools/check-package-validation.instructions.md new file mode 100644 index 000000000000..8a1238c81f09 --- /dev/null +++ b/eng/common/instructions/azsdk-tools/check-package-validation.instructions.md @@ -0,0 +1,23 @@ +--- +description: 'Run the package validation checks for the SDK package.' +--- +## Goal +Run the validation checks for the SDK package by collecting the required information from the user and executing the `azsdk_package_run_check` tool. + +## Instructions +1. **Collect Required Information**: + - Prompt the user for the absolute package path to the package directory for the SDK package they want to check. + - Prompt the user to specify values for each of the parameters required by the azsdk_package_run_check tool. Present the user with options to pick from for the allowed values specified by the parameter schema. + +2. **Execute Check**: + - Use the `azsdk_package_run_check` tool with the package path and check type. + +3. **Present Results**: + - If the package has passed all validation checks, highlight and finish + - If the package is not ready, display the specific check types that need to be fixed for each language. + +## Expected User Interaction Flow +1. Ask: "What is the exact path of the package you want to check for validation?" +2. Ask: "Please specify the check type you want to run (e.g., 'all', 'linting', 'format', etc.)" +3. Execute the check using the provided information +4. Display results and next steps \ No newline at end of file diff --git a/eng/common/instructions/azsdk-tools/verify-setup.instructions.md b/eng/common/instructions/azsdk-tools/verify-setup.instructions.md new file mode 100644 index 000000000000..284e38417701 --- /dev/null +++ b/eng/common/instructions/azsdk-tools/verify-setup.instructions.md @@ -0,0 +1,20 @@ +--- +description: 'Verify Setup' +--- + +## Goal +This tool verifies the developer's environment for SDK development and release tasks. It returns what requirements are missing for the specified languages and repo. + +Your goal is to identify the project repo root, and pass in the `packagePath` to the Verify Setup tool. For a language repo, pass in the language of the repo. + +## Examples +- in `azure-sdk-for-js`, run `azsdk_verify_setup` with `(langs=javascript, packagePath=/azure-sdk-for-js)`. +- in `azure-sdk-for-python`, run `azsdk_verify_setup` with `(langs=python, packagePath=/azure-sdk-for-python, venvPath=)`. + +## Parameter Requirements +WHENEVER Python is included in `langs`, BEFORE RUNNING `azsdk_verify_setup`, you MUST ASK THE USER TO SPECIFY WHICH virtual environment they want to check. DO NOT ASSUME THE VENV WITHOUT ASKING THE USER. After obtaining the `venvPath`, you can run the tool. + +The user can specify multiple languages to check. If the user wants to check all languages, pass in ALL supported languages and STILL ASK for a `venvPath`. Passing in no languages will only check the core requirements. + +## Output +Display results in a user-friendly and concise format, highlighting any missing dependencies that need to be addressed. diff --git a/eng/common/scripts/Update-DocsMsPackages.ps1 b/eng/common/scripts/Update-DocsMsPackages.ps1 index 06ee79102eab..f4a61bba4769 100644 --- a/eng/common/scripts/Update-DocsMsPackages.ps1 +++ b/eng/common/scripts/Update-DocsMsPackages.ps1 @@ -26,7 +26,9 @@ param ( [string] $DocRepoLocation, # the location of the cloned doc repo [Parameter(Mandatory = $false)] - [string] $PackageSourceOverride + [string] $PackageSourceOverride, + + [switch] $SkipLegacyOnboarding ) . (Join-Path $PSScriptRoot common.ps1) @@ -57,7 +59,11 @@ function PackageIsValidForDocsOnboarding($package) { -DocRepoLocation $DocRepoLocation } -$MONIKERS = @('latest', 'preview', 'legacy') +$MONIKERS = @('latest', 'preview') +if (!$SkipLegacyOnboarding) { + $MONIKERS += 'legacy' +} + foreach ($moniker in $MONIKERS) { try { Write-Host "Onboarding packages for moniker: $moniker" diff --git a/package-lock.json b/package-lock.json index a37b3e6e2ad8..62c53be6b11c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -64,6 +64,7 @@ "@types/debug": "^4.1.12", "@types/js-yaml": "^4.0.9", "@types/node": "^20.0.0", + "@types/semver": "^7.7.1", "@vitest/coverage-v8": "^3.2.4", "cross-env": "^10.1.0", "eslint": "^9.22.0", @@ -683,6 +684,7 @@ "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -1037,6 +1039,7 @@ "integrity": "sha512-sqOYBUghAtVMBiAWwT3fMRVSDNwR7IU3AQ96n/ErhAthwWjTe7PFVfK/MPjpI1mO3cdyLeS2DGyI3gt/waWP4g==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -1063,6 +1066,7 @@ "integrity": "sha512-+BVZf1OfSZfEaXsOp1ZUCyjjZjC465ieIAr1zEz4yD7KaWGW+yE/w+HXbsRNNw0B52FhgVcWX6iVuvBtMZpNMQ==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -1131,6 +1135,7 @@ "integrity": "sha512-CUhw8vkMzDTYlRfddQERT0ZEJAtwjKteRNuhs1S3IrDceJlHEiXTK+FpPwen/F5DBbj1w2SgnSFfaJ3fL171/w==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0", @@ -2486,22 +2491,22 @@ } }, "node_modules/@eslint/config-helpers": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.1.tgz", - "integrity": "sha512-csZAzkNhsgwb0I/UAV6/RGFTbiakPCf0ZrGmrIxQpYvGZ00PhTkSnyKNolphgIvmnJeGw6rcGVEXfTzUnFuEvw==", + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/@eslint/config-helpers/-/config-helpers-0.4.2.tgz", + "integrity": "sha512-gBrxN88gOIf3R7ja5K9slwNayVcZgK6SOUORm2uBzTeIEfeVaIhOpCtTox3P6R7o2jLFwLFTLnC7kU/RGcYEgw==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.16.0" + "@eslint/core": "^0.17.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" } }, "node_modules/@eslint/core": { - "version": "0.16.0", - "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.16.0.tgz", - "integrity": "sha512-nmC8/totwobIiFcGkDza3GIKfAw1+hLiYVrh3I1nIomQ8PEr5cxg34jnkmGawul/ep52wGRAcyeDCNtWKSOj4Q==", + "version": "0.17.0", + "resolved": "https://registry.npmjs.org/@eslint/core/-/core-0.17.0.tgz", + "integrity": "sha512-yL/sLrpmtDaFEiUj1osRP4TI2MDz1AddJL+jZ7KSqvBuliN4xqYY54IfdN8qD8Toa6g1iloph1fxQNkjOxrrpQ==", "dev": true, "license": "Apache-2.0", "dependencies": { @@ -2549,9 +2554,9 @@ } }, "node_modules/@eslint/js": { - "version": "9.38.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.38.0.tgz", - "integrity": "sha512-UZ1VpFvXf9J06YG9xQBdnzU+kthors6KjhMAl6f4gH4usHyh31rUf2DLGInT8RFYIReYXNSydgPY0V2LuWgl7A==", + "version": "9.39.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.39.0.tgz", + "integrity": "sha512-BIhe0sW91JGPiaF1mOuPy5v8NflqfjIcDNpC+LbW9f609WVRX1rArrhi6Z2ymvrAry9jw+5POTj4t2t62o8Bmw==", "dev": true, "license": "MIT", "engines": { @@ -2572,13 +2577,13 @@ } }, "node_modules/@eslint/plugin-kit": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.0.tgz", - "integrity": "sha512-sB5uyeq+dwCWyPi31B2gQlVlo+j5brPlWx4yZBrEaRo/nhdDE8Xke1gsGgtiBdaBTxuTkceLVuVt/pclrasb0A==", + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/@eslint/plugin-kit/-/plugin-kit-0.4.1.tgz", + "integrity": "sha512-43/qtrDUokr7LJqoF2c3+RInu/t4zfrpYdoSDfYyhg52rwLV6TnOvdG4fXm7IkSB3wErkcmJS9iEhjVtOSEjjA==", "dev": true, "license": "Apache-2.0", "dependencies": { - "@eslint/core": "^0.16.0", + "@eslint/core": "^0.17.0", "levn": "^0.4.1" }, "engines": { @@ -3516,17 +3521,18 @@ } }, "node_modules/@octokit/core": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/@octokit/core/-/core-7.0.5.tgz", - "integrity": "sha512-t54CUOsFMappY1Jbzb7fetWeO0n6K0k/4+/ZpkS+3Joz8I4VcvY9OiEBFRYISqaI2fq5sCiPtAjRDOzVYG8m+Q==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/@octokit/core/-/core-7.0.6.tgz", + "integrity": "sha512-DhGl4xMVFGVIyMwswXeyzdL4uXD5OGILGX5N8Y+f6W7LhC1Ze2poSNrkF/fedpVDHEEZ+PHFW0vL14I+mm8K3Q==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@octokit/auth-token": "^6.0.0", - "@octokit/graphql": "^9.0.2", - "@octokit/request": "^10.0.4", - "@octokit/request-error": "^7.0.1", - "@octokit/types": "^15.0.0", + "@octokit/graphql": "^9.0.3", + "@octokit/request": "^10.0.6", + "@octokit/request-error": "^7.0.2", + "@octokit/types": "^16.0.0", "before-after-hook": "^4.0.0", "universal-user-agent": "^7.0.0" }, @@ -3535,13 +3541,13 @@ } }, "node_modules/@octokit/endpoint": { - "version": "11.0.1", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-11.0.1.tgz", - "integrity": "sha512-7P1dRAZxuWAOPI7kXfio88trNi/MegQ0IJD3vfgC3b+LZo1Qe6gRJc2v0mz2USWWJOKrB2h5spXCzGbw+fAdqA==", + "version": "11.0.2", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-11.0.2.tgz", + "integrity": "sha512-4zCpzP1fWc7QlqunZ5bSEjxc6yLAlRTnDwKtgXfcI/FxxGoqedDG8V2+xJ60bV2kODqcGB+nATdtap/XYq2NZQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.0", + "@octokit/types": "^16.0.0", "universal-user-agent": "^7.0.2" }, "engines": { @@ -3549,14 +3555,14 @@ } }, "node_modules/@octokit/graphql": { - "version": "9.0.2", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-9.0.2.tgz", - "integrity": "sha512-iz6KzZ7u95Fzy9Nt2L8cG88lGRMr/qy1Q36ih/XVzMIlPDMYwaNLE/ENhqmIzgPrlNWiYJkwmveEetvxAgFBJw==", + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-9.0.3.tgz", + "integrity": "sha512-grAEuupr/C1rALFnXTv6ZQhFuL1D8G5y8CN04RgrO4FIPMrtm+mcZzFG7dcBm+nq+1ppNixu+Jd78aeJOYxlGA==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/request": "^10.0.4", - "@octokit/types": "^15.0.0", + "@octokit/request": "^10.0.6", + "@octokit/types": "^16.0.0", "universal-user-agent": "^7.0.0" }, "engines": { @@ -3564,20 +3570,20 @@ } }, "node_modules/@octokit/openapi-types": { - "version": "26.0.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-26.0.0.tgz", - "integrity": "sha512-7AtcfKtpo77j7Ts73b4OWhOZHTKo/gGY8bB3bNBQz4H+GRSWqx2yvj8TXRsbdTE0eRmYmXOEY66jM7mJ7LzfsA==", + "version": "27.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-27.0.0.tgz", + "integrity": "sha512-whrdktVs1h6gtR+09+QsNk2+FO+49j6ga1c55YZudfEG+oKJVvJLQi3zkOm5JjiUXAagWK2tI2kTGKJ2Ys7MGA==", "dev": true, "license": "MIT" }, "node_modules/@octokit/plugin-paginate-rest": { - "version": "13.2.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-13.2.1.tgz", - "integrity": "sha512-Tj4PkZyIL6eBMYcG/76QGsedF0+dWVeLhYprTmuFVVxzDW7PQh23tM0TP0z+1MvSkxB29YFZwnUX+cXfTiSdyw==", + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-14.0.0.tgz", + "integrity": "sha512-fNVRE7ufJiAA3XUrha2omTA39M6IXIc6GIZLvlbsm8QOQCYvpq/LkMNGyFlB1d8hTDzsAXa3OKtybdMAYsV/fw==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.1" + "@octokit/types": "^16.0.0" }, "engines": { "node": ">= 20" @@ -3600,13 +3606,13 @@ } }, "node_modules/@octokit/plugin-rest-endpoint-methods": { - "version": "16.1.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-16.1.1.tgz", - "integrity": "sha512-VztDkhM0ketQYSh5Im3IcKWFZl7VIrrsCaHbDINkdYeiiAsJzjhS2xRFCSJgfN6VOcsoW4laMtsmf3HcNqIimg==", + "version": "17.0.0", + "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-17.0.0.tgz", + "integrity": "sha512-B5yCyIlOJFPqUUeiD0cnBJwWJO8lkJs5d8+ze9QDP6SvfiXSz1BF+91+0MeI1d2yxgOhU/O+CvtiZ9jSkHhFAw==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.1" + "@octokit/types": "^16.0.0" }, "engines": { "node": ">= 20" @@ -3616,15 +3622,15 @@ } }, "node_modules/@octokit/request": { - "version": "10.0.5", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-10.0.5.tgz", - "integrity": "sha512-TXnouHIYLtgDhKo+N6mXATnDBkV05VwbR0TtMWpgTHIoQdRQfCSzmy/LGqR1AbRMbijq/EckC/E3/ZNcU92NaQ==", + "version": "10.0.6", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-10.0.6.tgz", + "integrity": "sha512-FO+UgZCUu+pPnZAR+iKdUt64kPE7QW7ciqpldaMXaNzixz5Jld8dJ31LAUewk0cfSRkNSRKyqG438ba9c/qDlQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/endpoint": "^11.0.1", - "@octokit/request-error": "^7.0.1", - "@octokit/types": "^15.0.0", + "@octokit/endpoint": "^11.0.2", + "@octokit/request-error": "^7.0.2", + "@octokit/types": "^16.0.0", "fast-content-type-parse": "^3.0.0", "universal-user-agent": "^7.0.2" }, @@ -3633,42 +3639,42 @@ } }, "node_modules/@octokit/request-error": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-7.0.1.tgz", - "integrity": "sha512-CZpFwV4+1uBrxu7Cw8E5NCXDWFNf18MSY23TdxCBgjw1tXXHvTrZVsXlW8hgFTOLw8RQR1BBrMvYRtuyaijHMA==", + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-7.0.2.tgz", + "integrity": "sha512-U8piOROoQQUyExw5c6dTkU3GKxts5/ERRThIauNL7yaRoeXW0q/5bgHWT7JfWBw1UyrbK8ERId2wVkcB32n0uQ==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/types": "^15.0.0" + "@octokit/types": "^16.0.0" }, "engines": { "node": ">= 20" } }, "node_modules/@octokit/rest": { - "version": "22.0.0", - "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-22.0.0.tgz", - "integrity": "sha512-z6tmTu9BTnw51jYGulxrlernpsQYXpui1RK21vmXn8yF5bp6iX16yfTtJYGK5Mh1qDkvDOmp2n8sRMcQmR8jiA==", + "version": "22.0.1", + "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-22.0.1.tgz", + "integrity": "sha512-Jzbhzl3CEexhnivb1iQ0KJ7s5vvjMWcmRtq5aUsKmKDrRW6z3r84ngmiFKFvpZjpiU/9/S6ITPFRpn5s/3uQJw==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/core": "^7.0.2", - "@octokit/plugin-paginate-rest": "^13.0.1", + "@octokit/core": "^7.0.6", + "@octokit/plugin-paginate-rest": "^14.0.0", "@octokit/plugin-request-log": "^6.0.0", - "@octokit/plugin-rest-endpoint-methods": "^16.0.0" + "@octokit/plugin-rest-endpoint-methods": "^17.0.0" }, "engines": { "node": ">= 20" } }, "node_modules/@octokit/types": { - "version": "15.0.1", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-15.0.1.tgz", - "integrity": "sha512-sdiirM93IYJ9ODDCBgmRPIboLbSkpLa5i+WLuXH8b8Atg+YMLAyLvDDhNWLV4OYd08tlvYfVm/dw88cqHWtw1Q==", + "version": "16.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-16.0.0.tgz", + "integrity": "sha512-sKq+9r1Mm4efXW1FCk7hFSeJo4QKreL/tTbR0rz/qx/r1Oa2VV83LTA/H/MuCOX7uCIJmQVRKBcbmWoySjAnSg==", "dev": true, "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^26.0.0" + "@octokit/openapi-types": "^27.0.0" } }, "node_modules/@paralleldrive/cuid2": { @@ -4227,6 +4233,7 @@ "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -4317,6 +4324,7 @@ "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -4657,7 +4665,8 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", "dev": true, - "license": "0BSD" + "license": "0BSD", + "peer": true }, "node_modules/@ts-common/property-set": { "version": "0.1.0", @@ -4867,7 +4876,8 @@ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", "dev": true, - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/@types/lodash": { "version": "4.17.20", @@ -4911,6 +4921,13 @@ "dev": true, "license": "MIT" }, + "node_modules/@types/semver": { + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-FmgJfu+MOcQ370SD0ev7EI8TlCAfKYU+B4m5T3yXc1CiRN94g/SZPtsCkk506aUDtlMnFZvasDwHHUcZUEaYuA==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/triple-beam": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/@types/triple-beam/-/triple-beam-1.3.5.tgz", @@ -4988,6 +5005,7 @@ "integrity": "sha512-BnOroVl1SgrPLywqxyqdJ4l3S2MsKVLDVxZvjI1Eoe8ev2r3kGDo+PcMihNmDE+6/KjkTubSJnmqGZZjQSBq/g==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@typescript-eslint/scope-manager": "8.46.2", "@typescript-eslint/types": "8.46.2", @@ -5219,6 +5237,7 @@ "integrity": "sha512-REJgZOEZ9g9CC72GGT0+nLbjW+5WVlCfm1d6w18N5RsUo7vLXs8IPXwq7xZJzoqU99Q9B4keqzPuTU4OrDUTrA==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@babel/code-frame": "~7.27.1", "@inquirer/prompts": "^7.4.0", @@ -5375,6 +5394,7 @@ "integrity": "sha512-V7unXnj+sZoa/1wQG8G6x2TiQqotx18S/qFbDzdfJRPCVpH/Z3xIpppce4jTZALXT97tKZK5GDHijn2zWuWWxg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5388,6 +5408,7 @@ "integrity": "sha512-52XLXwqSY2SY6nSvfkiTsNiJzlMeIAZ6MFIVJ5YkoibA21TNAP4DtjTZgC2GieZLY2NNN/rqDCqBX+DyWqTrfQ==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5407,6 +5428,7 @@ "integrity": "sha512-27sXkSK2r1sAmVMLv+pwlN/Cm+yg9nEK8iuGyJRuEkBk7hcsJDbTnBlsEvlRTI8DqljtzA7YECDHBLK88zZHeg==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5468,6 +5490,7 @@ "integrity": "sha512-rQ+RP0kcrKWjbpCIkBd8hpxYSNc3CfQxl0MLP1+MYGRHlHL8ss4xbwdANIYZXZZ2i2Hqt19B7cEUGD4MLoCHvw==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5482,6 +5505,7 @@ "integrity": "sha512-8iODUY3C/0hR9sTzyHeTgYfZkKeqZM+/P0OmN1ZWlLUokXQ67yydGXIqnjl+yaeuntwN8H2DDwLguU15c+j+UQ==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5498,6 +5522,7 @@ "integrity": "sha512-ubvxCN+SZwN9aEarz8CPtMJgnopeu8dXyut47q0FAPp9nykmXy7s+dmsopR+7OX0Fhcnh8ZFYTQcJzJ3QftOiQ==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5526,6 +5551,7 @@ "integrity": "sha512-wdLcVx5UW4WRks/OXfqLiaDTtWfAWgv/nj69u99gRJU6iY9ExEvK5x9NQszZQKYnu6tM7nkoYMg4zu+7YBUBaw==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5539,6 +5565,7 @@ "integrity": "sha512-JVafN1nZE3BcQrKbaAFVWw/IleTRdsJpwT3oZ2m7EfWnG30sKtoR9inF9dRoW+XXIjNzCfeYqjkwzEkEnIrCww==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=20.0.0" }, @@ -5714,6 +5741,7 @@ "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "dev": true, "license": "MIT", + "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -6192,9 +6220,9 @@ } }, "node_modules/chardet": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.1.0.tgz", - "integrity": "sha512-bNFETTG/pM5ryzQ9Ad0lJOTa6HWD/YsScAR3EnCPZRPlQh77JocYktSHOUHelyhm8IARL+o4c4F1bP5KVOjiRA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/chardet/-/chardet-2.1.1.tgz", + "integrity": "sha512-PsezH1rqdV9VvyNhxxOW32/d75r01NY7TQCmOqomRo15ZSOKbpTFVsfjghxo6JloQUCGnH4k1LGu0R4yCLlWQQ==", "dev": true, "license": "MIT" }, @@ -6996,20 +7024,21 @@ } }, "node_modules/eslint": { - "version": "9.38.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.38.0.tgz", - "integrity": "sha512-t5aPOpmtJcZcz5UJyY2GbvpDlsK5E8JqRqoKtfiKE3cNh437KIqfJr3A3AKf5k64NPx6d0G3dno6XDY05PqPtw==", + "version": "9.39.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-9.39.0.tgz", + "integrity": "sha512-iy2GE3MHrYTL5lrCtMZ0X1KLEKKUjmK0kzwcnefhR66txcEmXZD2YWgR5GNdcEwkNx3a0siYkSvl0vIC+Svjmg==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@eslint-community/eslint-utils": "^4.8.0", "@eslint-community/regexpp": "^4.12.1", "@eslint/config-array": "^0.21.1", - "@eslint/config-helpers": "^0.4.1", - "@eslint/core": "^0.16.0", + "@eslint/config-helpers": "^0.4.2", + "@eslint/core": "^0.17.0", "@eslint/eslintrc": "^3.3.1", - "@eslint/js": "9.38.0", - "@eslint/plugin-kit": "^0.4.0", + "@eslint/js": "9.39.0", + "@eslint/plugin-kit": "^0.4.1", "@humanfs/node": "^0.16.6", "@humanwhocodes/module-importer": "^1.0.1", "@humanwhocodes/retry": "^0.4.2", @@ -8887,6 +8916,7 @@ "integrity": "sha512-B7qPcEVE3NVkmSJbaYxvv4cHkVW7DQsZz13pUMrfS8z8Q/BuShN+gcTXrUlPiGqM2/t/EEaI030bpxMqY8gMlw==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">= 10.16.0" } @@ -9813,7 +9843,8 @@ "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz", "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==", "dev": true, - "license": "MIT" + "license": "MIT", + "peer": true }, "node_modules/optionator": { "version": "0.9.4", @@ -10106,6 +10137,7 @@ "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==", "dev": true, "license": "MIT", + "peer": true, "bin": { "prettier": "bin/prettier.cjs" }, @@ -10271,7 +10303,8 @@ "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", "dev": true, - "license": "Apache-2.0" + "license": "Apache-2.0", + "peer": true }, "node_modules/reflect.getprototypeof": { "version": "1.0.10", @@ -10754,9 +10787,9 @@ } }, "node_modules/simple-git": { - "version": "3.28.0", - "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.28.0.tgz", - "integrity": "sha512-Rs/vQRwsn1ILH1oBUy8NucJlXmnnLeLCfcvbSehkPzbv3wwoFWIdtfd6Ndo6ZPhlPsCZ60CPI4rxurnwAa+a2w==", + "version": "3.29.0", + "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.29.0.tgz", + "integrity": "sha512-PEBgFYc8plTys6/XuxinxAJ+6CbXVh+xxsBTOEXw/uYBd3sYlGGoyB12nX5rRPGsFrdnnZWb81qluSl7a83HtA==", "dev": true, "license": "MIT", "dependencies": { @@ -11364,6 +11397,7 @@ "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -11483,7 +11517,8 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", "dev": true, - "license": "0BSD" + "license": "0BSD", + "peer": true }, "node_modules/tunnel": { "version": "0.0.6", @@ -11592,6 +11627,7 @@ "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, "license": "Apache-2.0", + "peer": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -11870,6 +11906,7 @@ "integrity": "sha512-5gTmgEY/sqK6gFXLIsQNH19lWb4ebPDLA4SdLP7dsWkIXHWlG66oPuVvXSGFPppYZz8ZDZq0dYYrbHfBCVUb1Q==", "dev": true, "license": "MIT", + "peer": true, "engines": { "node": ">=12" }, @@ -11883,6 +11920,7 @@ "integrity": "sha512-LUCP5ev3GURDysTWiP47wRRUpLKMOfPh+yKTx3kVIEiu5KOMeqzpnYNsKyOoVrULivR8tLcks4+lga33Whn90A==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@types/chai": "^5.2.2", "@vitest/expect": "3.2.4", diff --git a/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml b/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml index 4787f21c19da..48dfe4d875d2 100644 --- a/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml +++ b/specification/advisor/resource-manager/Microsoft.Advisor/Advisor/tspconfig.yaml @@ -12,7 +12,7 @@ options: output-file: "{version-status}/{version}/openapi.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-advisor" namespace: "azure.mgmt.advisor" diff --git a/specification/apicenter/ApiCenter.Management/back-compatible.tsp b/specification/apicenter/ApiCenter.Management/back-compatible.tsp new file mode 100644 index 000000000000..9276e157d9fa --- /dev/null +++ b/specification/apicenter/ApiCenter.Management/back-compatible.tsp @@ -0,0 +1,35 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using Microsoft.ApiCenter; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Api.properties, "autorest"); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiDefinition.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DeletedService.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Deployment.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Environment.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MetadataSchema.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Service.properties, + "autorest" +); +// For ServiceUpdate +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Workspace.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApiSource.properties, + "autorest" +); diff --git a/specification/apicenter/ApiCenter.Management/main.tsp b/specification/apicenter/ApiCenter.Management/main.tsp index 1a84aabe2259..44e18d8daaeb 100644 --- a/specification/apicenter/ApiCenter.Management/main.tsp +++ b/specification/apicenter/ApiCenter.Management/main.tsp @@ -15,6 +15,7 @@ import "./ApiDefinition.tsp"; import "./ApiSource.tsp"; import "./Deployment.tsp"; import "./Environment.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/apicenter/ApiCenter.Management/tspconfig.yaml b/specification/apicenter/ApiCenter.Management/tspconfig.yaml index 3463917ab3c3..17fe9f5d5acb 100644 --- a/specification/apicenter/ApiCenter.Management/tspconfig.yaml +++ b/specification/apicenter/ApiCenter.Management/tspconfig.yaml @@ -5,8 +5,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/apicenter.json" use-read-only-status-schema: true linter: diff --git a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml index eb95a6c369f6..1359c4429a69 100644 --- a/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml +++ b/specification/appcomplianceautomation/AppComplianceAutomation.Management/tspconfig.yaml @@ -11,8 +11,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/appcomplianceautomation.json" "@azure-tools/typespec-ts": experimental-extensible-enums: true diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/models.tsp b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/models.tsp index af1ce209ed5a..f495f49d9793 100644 --- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/models.tsp +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/models.tsp @@ -376,8 +376,8 @@ model PrivateEndpointConnectionReference { /** * The properties of a private endpoint connection. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: PrivateEndpointConnectionProperties; } @@ -485,8 +485,8 @@ model ConfigurationStoreUpdateParameters { /** * The properties for updating a configuration store. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ConfigurationStorePropertiesUpdateParameters; /** diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/tspconfig.yaml b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/tspconfig.yaml index b8e32252d05d..4a356f091b1a 100644 --- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/tspconfig.yaml +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/tspconfig.yaml @@ -15,7 +15,7 @@ options: emit-lro-options: "all" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-appconfiguration" namespace: "azure.mgmt.appconfiguration" diff --git a/specification/azuredependencymap/DependencyMap.Management/back-compatible.tsp b/specification/azuredependencymap/DependencyMap.Management/back-compatible.tsp new file mode 100644 index 000000000000..ae4d3ff00c0f --- /dev/null +++ b/specification/azuredependencymap/DependencyMap.Management/back-compatible.tsp @@ -0,0 +1,11 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Microsoft.DependencyMap; + +// Discriminated type +// @@Azure.ClientGenerator.Core.Legacy.flattenProperty(DiscoverySourceResource.properties, +// "autorest" +// ); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MapsResource.properties, + "autorest" +); diff --git a/specification/azuredependencymap/DependencyMap.Management/client.tsp b/specification/azuredependencymap/DependencyMap.Management/client.tsp new file mode 100644 index 000000000000..1fe783e46caa --- /dev/null +++ b/specification/azuredependencymap/DependencyMap.Management/client.tsp @@ -0,0 +1,77 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Azure.Core; +using Microsoft.DependencyMap; + +@@clientName(Microsoft.DependencyMap, "DependencyMapMgmt", "python"); + +@@clientName(Microsoft.DependencyMap, "DependencyMapManagementClient", "java"); + +// CSharp +@@clientName(MapsResource, "DependencyMap", "csharp"); +@@clientName(MapsResourceProperties, "DependencyMapProperties", "csharp"); +@@clientName(ProvisioningState, "DependencyMapProvisioningState", "csharp"); +@@clientName(DiscoverySourceResource, "DependencyMapDiscoverySource", "csharp"); +@@clientName(DiscoverySourceResourceProperties, + "DependencyMapDiscoverySourceProperties", + "csharp" +); +@@clientName(DateTimeFilter, "DependencyMapDateTimeFilter", "csharp"); +@@clientName(DateTimeFilter.startDateTimeUtc, "StartOn", "csharp"); +@@clientName(DateTimeFilter.endDateTimeUtc, "EndOn", "csharp"); +@@clientName(OffAzureDiscoverySourceResourceProperties, + "OffAzureDiscoverySourceProperties", + "csharp" +); +@@clientName(ProcessNameFilter, "DependencyMapProcessNameFilter", "csharp"); +@@clientName(ProcessNameFilterOperator, + "DependencyMapProcessNameFilterOperator", + "csharp" +); +@@clientName(ExportDependenciesRequest, "ExportDependenciesContent", "csharp"); +@@clientName(GetDependencyViewForFocusedMachineRequest, + "GetDependencyViewForFocusedMachineContent", + "csharp" +); +@@clientName(GetConnectionsForProcessOnFocusedMachineRequest, + "GetConnectionsForProcessOnFocusedMachineContent", + "csharp" +); +@@clientName(GetConnectionsWithConnectedMachineForFocusedMachineRequest, + "GetConnectionsWithConnectedMachineForFocusedMachineContent", + "csharp" +); +@@clientName(GetDependencyViewForAllMachinesRequest, + "GetDependencyViewForAllMachinesContent", + "csharp" +); +@@alternateType(GetDependencyViewForFocusedMachineRequest.focusedMachineId, + armResourceIdentifier, + "csharp" +); +@@alternateType(GetConnectionsWithConnectedMachineForFocusedMachineRequest.focusedMachineId, + armResourceIdentifier, + "csharp" +); +@@alternateType(GetConnectionsWithConnectedMachineForFocusedMachineRequest.connectedMachineId, + armResourceIdentifier, + "csharp" +); +@@alternateType(GetConnectionsForProcessOnFocusedMachineRequest.focusedMachineId, + armResourceIdentifier, + "csharp" +); +@@alternateType(ExportDependenciesRequest.focusedMachineId, + armResourceIdentifier, + "csharp" +); +@@alternateType(DiscoverySourceResourceProperties.sourceId, + armResourceIdentifier, + "csharp" +); +@@alternateType(Azure.ResourceManager.CommonTypes.Resource.id, + armResourceIdentifier, + "csharp" +); diff --git a/specification/azuredependencymap/DependencyMap.Management/main.tsp b/specification/azuredependencymap/DependencyMap.Management/main.tsp index 2b8e406d0682..d965721f7900 100644 --- a/specification/azuredependencymap/DependencyMap.Management/main.tsp +++ b/specification/azuredependencymap/DependencyMap.Management/main.tsp @@ -3,10 +3,11 @@ import "@typespec/versioning"; import "@azure-tools/typespec-autorest"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; + import "./models.tsp"; import "./resources.tsp"; import "./routes.tsp"; -//import "@azure-tools/typespec-providerhub"; +import "./back-compatible.tsp"; using TypeSpec.Versioning; using Azure.ResourceManager; diff --git a/specification/azuredependencymap/DependencyMap.Management/tspconfig.yaml b/specification/azuredependencymap/DependencyMap.Management/tspconfig.yaml index 7a9c0c784139..5ce02742bbba 100644 --- a/specification/azuredependencymap/DependencyMap.Management/tspconfig.yaml +++ b/specification/azuredependencymap/DependencyMap.Management/tspconfig.yaml @@ -9,14 +9,11 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/dependencyMap.json" - arm-resource-flattening: true + version-enum-strategy: true emit-lro-options: "all" - "@azure-tools/typespec-csharp": + "@azure-typespec/http-client-csharp-mgmt": emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" - flavor: azure - clear-output-folder: true - model-namespace: false namespace: "Azure.ResourceManager.DependencyMap" "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-dependencymap" diff --git a/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-01-31-preview/dependencyMap.json b/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-01-31-preview/dependencyMap.json index e2ffd8f4e190..504dcb2d3f2f 100644 --- a/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-01-31-preview/dependencyMap.json +++ b/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-01-31-preview/dependencyMap.json @@ -1082,8 +1082,7 @@ "properties": { "properties": { "$ref": "#/definitions/DiscoverySourceResourceProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-05-01-preview/dependencyMap.json b/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-05-01-preview/dependencyMap.json index a01ce7def2e5..58f44e247695 100644 --- a/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-05-01-preview/dependencyMap.json +++ b/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-05-01-preview/dependencyMap.json @@ -1082,8 +1082,7 @@ "properties": { "properties": { "$ref": "#/definitions/DiscoverySourceResourceProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-07-01-preview/dependencyMap.json b/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-07-01-preview/dependencyMap.json index 292c6c9f89d9..559d6db78167 100644 --- a/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-07-01-preview/dependencyMap.json +++ b/specification/azuredependencymap/resource-manager/Microsoft.DependencyMap/preview/2025-07-01-preview/dependencyMap.json @@ -1171,8 +1171,7 @@ "properties": { "properties": { "$ref": "#/definitions/DiscoverySourceResourceProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/back-compatible.tsp b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/back-compatible.tsp new file mode 100644 index 000000000000..4c528053c575 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/back-compatible.tsp @@ -0,0 +1,7 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Microsoft.AzureFleet; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Fleet.properties, + "autorest" +); diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/main.tsp b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/main.tsp index 703030d7284d..0c43c06cc9ee 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/main.tsp +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/main.tsp @@ -8,6 +8,7 @@ import "./fleet.tsp"; import "./baseVirtualMachineProfile.tsp"; import "./virtualMachineScaleSet.tsp"; import "./virtualMachine.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/tspconfig.yaml b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/tspconfig.yaml index d1eb45f91e53..76db8bce0e3c 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/tspconfig.yaml +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/AzureFleet/tspconfig.yaml @@ -14,8 +14,6 @@ options: emitter-output-dir: "{project-root}" azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{version-status}/{version}/azurefleet.json" arm-types-dir: "{project-root}/../../../../common-types/resource-management" "@azure-tools/typespec-csharp": diff --git a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/back-compatible.tsp b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/back-compatible.tsp new file mode 100644 index 000000000000..18f35dedd1ad --- /dev/null +++ b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/back-compatible.tsp @@ -0,0 +1,11 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible + +using Microsoft.AzureLargeInstance; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AzureLargeInstance.properties, + "autorest" +); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AzureLargeStorageInstance.properties, + "autorest" +); diff --git a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/main.tsp b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/main.tsp index d1705de12052..7871cfefc5b8 100644 --- a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/main.tsp +++ b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/main.tsp @@ -5,6 +5,7 @@ import "@azure-tools/typespec-azure-resource-manager"; import "./models.tsp"; import "./AzureLargeInstance.tsp"; import "./AzureLargeStorageInstance.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/tspconfig.yaml b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/tspconfig.yaml index bde6d5b7dbe5..d74722635a74 100644 --- a/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/tspconfig.yaml +++ b/specification/azurelargeinstance/resource-manager/Microsoft.AzureLargeInstance/AzureLargeInstance/tspconfig.yaml @@ -8,7 +8,5 @@ options: emitter-output-dir: "{project-root}" azure-resource-provider-folder: "resource-manager" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{version-status}/{version}/azurelargeinstance.json" use-read-only-status-schema: true diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/back-compatible.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/back-compatible.tsp new file mode 100644 index 000000000000..2b7d7ac43664 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/back-compatible.tsp @@ -0,0 +1,40 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Microsoft.AzureStackHCI; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AttestationStatus.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GalleryImage.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GuestAgent.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(HybridIdentityMetadata.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LogicalNetwork.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MarketplaceGalleryImage.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NetworkInterface.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NetworkSecurityGroup.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SecurityRule.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StorageContainer.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualHardDisk.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualMachineInstance.properties, + "autorest" +); diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp index e9e6211fc26a..890b3c5e51b4 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp @@ -16,6 +16,8 @@ import "./VirtualMachineInstance.tsp"; import "./HybridIdentityMetadata.tsp"; import "./AttestationStatus.tsp"; import "./GuestAgent.tsp"; +import "./back-compatible.tsp"; + using TypeSpec.Rest; using TypeSpec.Http; using Azure.Core; diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml index 7898fe67f3b2..69f3a9f10b63 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/tspconfig.yaml @@ -9,8 +9,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/StackHCIVM/{version-status}/{version}/stackhcivm.json" "@azure-tools/typespec-python": service-dir: "sdk/azurestackhci" diff --git a/specification/azurestackhci/Operations.Management/tspconfig.yaml b/specification/azurestackhci/Operations.Management/tspconfig.yaml index ce55d803eae4..4a8f1edff056 100644 --- a/specification/azurestackhci/Operations.Management/tspconfig.yaml +++ b/specification/azurestackhci/Operations.Management/tspconfig.yaml @@ -6,8 +6,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/operations/{version-status}/{version}/operations.json" linter: extends: diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/models.tsp b/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/models.tsp index 9f831212ccd6..d38138347730 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/models.tsp +++ b/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/models.tsp @@ -2746,8 +2746,8 @@ model AFDDomainUpdateParameters { /** * The JSON object that contains the properties of the domain to create. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AFDDomainUpdatePropertiesParameters; } @@ -2809,8 +2809,8 @@ model AFDEndpointUpdateParameters { /** * The JSON object containing endpoint update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AFDEndpointPropertiesUpdateParameters; } @@ -2986,8 +2986,8 @@ model AFDOriginGroupUpdateParameters { /** * The JSON object that contains the properties of the origin group. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AFDOriginGroupUpdatePropertiesParameters; } @@ -3143,8 +3143,8 @@ model AFDOriginUpdateParameters { /** * The JSON object that contains the properties of the origin. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AFDOriginUpdatePropertiesParameters; } @@ -3290,8 +3290,8 @@ model RouteUpdateParameters { /** * The JSON object that contains the properties of the domain to create. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: RouteUpdatePropertiesParameters; } @@ -3379,8 +3379,8 @@ model RuleUpdateParameters { /** * The JSON object that contains the properties of the rule to update. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: RuleUpdatePropertiesParameters; } @@ -3420,8 +3420,8 @@ model SecurityPolicyUpdateParameters { /** * The json object that contains properties required to update a security policy */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: SecurityPolicyUpdateProperties; } @@ -3552,8 +3552,8 @@ model DeploymentVersionUpdate { /** * Contains the properties of the deployment version. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DeploymentVersionUpdateProperties; } @@ -3880,8 +3880,8 @@ model ProfileUpdateParameters { /** * The JSON object containing profile update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ProfilePropertiesUpdateParameters; } @@ -3927,9 +3927,9 @@ model CanMigrateResult { @visibility(Lifecycle.Read) type?: string; - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: CanMigrateProperties; } @@ -4038,9 +4038,9 @@ model MigrateResult { @visibility(Lifecycle.Read) type?: string; - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: MigrateResultProperties; } @@ -4164,8 +4164,8 @@ model DeepCreatedOrigin { /** * Properties of the origin created on the CDN endpoint. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DeepCreatedOriginProperties; } @@ -4255,8 +4255,8 @@ model DeepCreatedOriginGroup { /** * Properties of the origin group created on the CDN endpoint. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DeepCreatedOriginGroupProperties; } @@ -4340,8 +4340,8 @@ model DeepCreatedCustomDomain { /** * Properties of the custom domain created on the CDN endpoint. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DeepCreatedCustomDomainProperties; } @@ -4571,8 +4571,8 @@ model EndpointUpdateParameters { /** * The JSON object containing endpoint update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: EndpointPropertiesUpdateParameters; } @@ -4700,8 +4700,8 @@ model OriginUpdateParameters { /** * The JSON object that contains the properties of the origin. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: OriginUpdatePropertiesParameters; } @@ -4757,8 +4757,8 @@ model OriginGroupUpdateParameters { /** * The JSON object that contains the properties of the origin group. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: OriginGroupUpdatePropertiesParameters; } @@ -4943,8 +4943,8 @@ model Operation { /** * Properties of operation, include metric specifications. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: OperationProperties; } @@ -5134,8 +5134,8 @@ model EdgeNode extends Azure.ResourceManager.CommonTypes.ProxyResource { /** * The JSON object that contains the properties required to create an edgenode. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: EdgeNodeProperties; } @@ -5248,8 +5248,8 @@ model ProfileAgentUpdateParameters { /** * The properties for updating a profile agent association. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ProfileAgentUpdateProperties; } @@ -5570,8 +5570,8 @@ model ManagedRuleSetDefinition /** * Describes managed rule set definition properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ManagedRuleSetDefinitionProperties; /** @@ -5721,8 +5721,8 @@ model WebAgentUpdateParameters { /** * Properties of the web agent to be updated. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: WebAgentPropertiesUpdateParameters; } @@ -5802,8 +5802,8 @@ model KnowledgeSourceUpdateParameters { /** * Properties of the knowledge source to be updated. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: KnowledgeSourcePropertiesUpdateParameters; } @@ -5838,8 +5838,8 @@ model WebApplicationFirewallPolicy /** * Properties of the web application firewall policy. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: WebApplicationFirewallPolicyProperties; /** @@ -5955,8 +5955,8 @@ model PolicySettingsAfd { /** * Defines rules that scrub sensitive fields in the Web Application Firewall logs. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty logScrubbing?: PolicySettingsLogScrubbing; } diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/tspconfig.yaml b/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/tspconfig.yaml index abd4b42fc827..6ccb07caca4f 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/tspconfig.yaml +++ b/specification/cdn/resource-manager/Microsoft.Cdn/Cdn/tspconfig.yaml @@ -11,7 +11,7 @@ options: output-file: "{version-status}/{version}/openapi.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + emit-lro-options: "all" "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-cdn" diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/edgeactionsbasemodels.tsp b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/edgeactionsbasemodels.tsp new file mode 100644 index 000000000000..2ee290dcf064 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/edgeactionsbasemodels.tsp @@ -0,0 +1,234 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@typespec/openapi"; +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ClientGenerator.Core; + +namespace Microsoft.Cdn; + +/** The SKU type for the edge action */ +model SkuType { + /** The name of the SKU */ + name: string; + + /** The tier of the SKU */ + tier: string; +} + +/** The deployment type for edge action versions */ +union EdgeActionVersionDeploymentType { + string, + + /** ZIP file deployment */ + zip: "zip", + + /** Single file deployment */ + file: "file", + + /** Other deployment types */ + others: "others", +} + +/** The validation status for edge action versions */ +union EdgeActionVersionValidationStatus { + string, + + /** Validation succeeded */ + Succeeded: "Succeeded", + + /** Validation failed */ + Failed: "Failed", +} + +/** Indicates whether this is the default version */ +union EdgeActionIsDefaultVersion { + string, + + /** This is the default version */ + True: "True", + + /** This is not the default version */ + False: "False", +} + +/** The status of an operation */ +union OperationStatus { + string, + + /** Operation is running */ + Running: "Running", + + /** Operation succeeded */ + Succeeded: "Succeeded", + + /** Operation failed */ + Failed: "Failed", + + /** Operation was canceled */ + Canceled: "Canceled", +} + +@pattern("[a-zA-Z0-9]+") +@maxLength(50) +scalar smallString extends string; + +@doc("Azure resource identifier for attached routes") +scalar AttachedResourceId + extends Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Cdn/Profiles/afdEndpoints/routes", + } + ]>; + +@doc("Azure resource identifier for edge action versions") +scalar EdgeActionVersionId + extends Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Cdn/edgeActions/versions", + } + ]>; + +/** The status of the current operation */ +@Azure.Core.lroStatus +union ProvisioningState { + ResourceProvisioningState, + + @doc("Initial provisioning in progress") + Provisioning: "Provisioning", + + @doc("Upgrade in progress") + Upgrading: "Upgrading", +} + +/** Edge action attachment information */ +model EdgeActionAttachment { + @doc("The edge action attachment id") + @visibility(Lifecycle.Read) + id: string; + + @doc("The attached resource Id") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + attachedResourceId: AttachedResourceId; +} + +/** Edge action attachment response */ +@clientName("EdgeActionAttachmentResult", "csharp") +model EdgeActionAttachmentResponse { + #suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" + @doc("Non changing guid to identity edge action") + @extension("x-ms-mutability", #["read", "update", "create"]) + edgeActionId: string; +} + +@doc("Represents an edge action properties") +model EdgeActionProperties { + @doc("The provisioning state of the edge action") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("A list of attachments for the edge action") + @visibility(Lifecycle.Read) + attachments: EdgeActionAttachment[]; +} + +@doc("Represents an edge action version") +model EdgeActionVersionProperties { + @doc("The deployment type") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + deploymentType: EdgeActionVersionDeploymentType; + + @doc("The validation status") + @visibility(Lifecycle.Read) + validationStatus: EdgeActionVersionValidationStatus; + + @doc("The provisioning state") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("The active state") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + isDefaultVersion: EdgeActionIsDefaultVersion; + + @doc("The last update time in UTC for package update") + @visibility(Lifecycle.Read) + lastPackageUpdateTime: utcDateTime; +} + +/** Properties for edge action execution filter */ +model EdgeActionExecutionFilterProperties { + @doc("The referenced versionId of the edgeaction version") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + versionId: EdgeActionVersionId; + + @doc("The last update time in UTC for the execution filter") + @visibility(Lifecycle.Read) + lastUpdateTime: utcDateTime; + + @doc("Custom Header Key associated with the execution filter") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + executionFilterIdentifierHeaderName: string; + + @doc("Custom Header Value associated with the execution filter") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + executionFilterIdentifierHeaderValue: string; + + @doc("The provisioning state") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +/** Version code information for edge action */ +model VersionCode { + @doc("The version code deployment content ") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + content: string; + + @doc("The version code name") + @visibility(Lifecycle.Read, Lifecycle.Create, Lifecycle.Update) + name: string; +} + +/** Edge action operation properties */ +model EdgeActionOperationProperties { + @doc("The resource id of the operation.") + resourceId: string; + + @doc("The GUID representing operationID.") + operationId: string; + + @doc("The current status of the operation.") + status: OperationStatus; + + @doc("The operation type.") + operationType: string; + + @doc("The start time of the operation.") + startTime?: utcDateTime; + + @doc("The end time of the operation (if completed).") + endTime?: utcDateTime; + + @doc("Error details, if applicable.") + error?: ErrorDetails; +} + +/** Error details for operations */ +model ErrorDetails { + @doc("Error code.") + code: string; + + @doc("Detailed error message.") + message: string; +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Create.json new file mode 100644 index 000000000000..515fa0fea845 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Create.json @@ -0,0 +1,51 @@ +{ + "operationId": "EdgeActionExecutionFilters_Create", + "title": "CreateEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1", + "resource": { + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Delete.json new file mode 100644 index 000000000000..feba90ee8948 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "EdgeActionExecutionFilters_Delete", + "title": "DeleteEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Get.json new file mode 100644 index 000000000000..7b784e5a2106 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActionExecutionFilters_Get", + "title": "GetEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_ListByEdgeAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_ListByEdgeAction.json new file mode 100644 index 000000000000..d985d2198120 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_ListByEdgeAction.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActionExecutionFilters_ListByEdgeAction", + "title": "ListEdgeActionsExecutionFiltersByEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters2", + "name": "executionFilter2", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version2", + "executionFilterIdentifierHeaderName": "header-key2", + "executionFilterIdentifierHeaderValue": "header-value2", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Update.json new file mode 100644 index 000000000000..604b874f573b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionExecutionFilters_Update.json @@ -0,0 +1,38 @@ +{ + "operationId": "EdgeActionExecutionFilters_Update", + "title": "UpdateEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1", + "properties": { + "properties": { + "executionFilterIdentifierHeaderValue": "header-value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/slots/slot1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value2", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Create.json new file mode 100644 index 000000000000..2555fa60c581 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Create.json @@ -0,0 +1,50 @@ +{ + "operationId": "EdgeActionVersions_Create", + "title": "CreateEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version2", + "resource": { + "location": "global", + "properties": { + "deploymentType": "zip", + "isDefaultVersion": "True" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Delete.json new file mode 100644 index 000000000000..6aed9a19a8ed --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "EdgeActionVersions_Delete", + "title": "DeleteEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_DeployVersionCode.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_DeployVersionCode.json new file mode 100644 index 000000000000..f427f4df0021 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_DeployVersionCode.json @@ -0,0 +1,31 @@ +{ + "operationId": "EdgeActionVersions_DeployVersionCode", + "title": "DeployVersionCode", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version2", + "body": { + "name": "zippedFile", + "content": "UEsDBBQAAAAIAI1NzkQAAAAABQAAAA==" + } + }, + "responses": { + "200": { + "body": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Get.json new file mode 100644 index 000000000000..ee4b4300f068 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActionVersions_Get", + "title": "GetEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_GetVersionCode.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_GetVersionCode.json new file mode 100644 index 000000000000..bcb349788f06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_GetVersionCode.json @@ -0,0 +1,25 @@ +{ + "operationId": "EdgeActionVersions_GetVersionCode", + "title": "GetVersionCode", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "zipfile", + "content": "encodedzip" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_ListByEdgeAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_ListByEdgeAction.json new file mode 100644 index 000000000000..b4c13f03e9ca --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_ListByEdgeAction.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActionVersions_ListByEdgeAction", + "title": "GetEdgeActionVersionsByEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "False", + "lastPackageUpdateTime": "2024-05-25T11:19:23Z" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_SwapDefault.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_SwapDefault.json new file mode 100644 index 000000000000..a94a9a128869 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_SwapDefault.json @@ -0,0 +1,20 @@ +{ + "operationId": "EdgeActionVersions_SwapDefault", + "title": "Swap Default Version", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "edgeActionName": "edgeAction1", + "version": "1.0", + "api-version": "2025-09-01-preview", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Update.json new file mode 100644 index 000000000000..81a7bb401a7c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActionVersions_Update.json @@ -0,0 +1,38 @@ +{ + "operationId": "EdgeActionVersions_Update", + "title": "UpdateEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1", + "properties": { + "properties": { + "deploymentType": "others" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "others", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_AddAttachment.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_AddAttachment.json new file mode 100644 index 000000000000..6d21874605b6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_AddAttachment.json @@ -0,0 +1,25 @@ +{ + "operationId": "EdgeActions_AddAttachment", + "title": "AddAttachment", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "body": { + "attachedResourceId": "/subscriptions/sub1/resourceGroups/rs1/providers/Microsoft.Cdn/Profiles/myProfile/afdEndpoints/ep1/routes/route1" + } + }, + "responses": { + "200": { + "body": { + "edgeActionId": "someguid" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Create.json new file mode 100644 index 000000000000..c3619e690588 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Create.json @@ -0,0 +1,51 @@ +{ + "operationId": "EdgeActions_Create", + "title": "CreateEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "resource": { + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Delete.json new file mode 100644 index 000000000000..c3de07233a8d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "EdgeActions_Delete", + "title": "DeleteEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-03-06-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_DeleteAttachment.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_DeleteAttachment.json new file mode 100644 index 000000000000..e5e87774eaf2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_DeleteAttachment.json @@ -0,0 +1,21 @@ +{ + "operationId": "EdgeActions_DeleteAttachment", + "title": "DeleteAttachment", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "body": { + "attachedResourceId": "/subscriptions/sub1/resourceGroups/rs1/providers/Microsoft.Cdn/Profiles/myProfile/afdEndpoints/ep1/routes/route1" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Get.json new file mode 100644 index 000000000000..6cebb226cad3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActions_Get", + "title": "GetEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_ListByResourceGroup.json new file mode 100644 index 000000000000..cbb237a52fbc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_ListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "operationId": "EdgeActions_ListByResourceGroup", + "title": "ListEdgeActions_byResourceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-09-01-preview", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction2", + "name": "edgeAction2", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_ListBySubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_ListBySubscription.json new file mode 100644 index 000000000000..5d0922451de9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_ListBySubscription.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActions_ListBySubscription", + "title": "ListEdgeActions_bySubscription", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction2", + "name": "edgeAction2", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Update.json new file mode 100644 index 000000000000..b9907af4bef7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/examples/2025-09-01-preview/EdgeActions_Update.json @@ -0,0 +1,39 @@ +{ + "operationId": "EdgeActions_Update", + "title": "UpdateEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "properties": { + "sku": { + "name": "Standard", + "tier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-03-06-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/main.tsp b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/main.tsp new file mode 100644 index 000000000000..c79a9418a7c9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/main.tsp @@ -0,0 +1,139 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@typespec/openapi"; +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./edgeactionsbasemodels.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; +using Azure.ResourceManager; +using Azure.Core; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Operations interface defined in main CDN swagger, not in EdgeActions-specific swagger" +@armProviderNamespace +@service(#{ title: "Microsoft.Cdn/EdgeAction" }) +@versioned(Versions) +@armCommonTypesVersion("v6") +namespace Microsoft.Cdn; + +enum Versions { + `2025-09-01-preview`, +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "SKU property required at envelope level for backwards compatibility with 2024-07-22-preview" +model EdgeAction is TrackedResource { + @path + @doc("The name of the Edge Action") + @segment("edgeActions") + @key("edgeActionName") + @visibility(Lifecycle.Read) + name: smallString; + + @doc("The sku type of the edge action") + sku: SkuType; +} + +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" +@@extension(EdgeAction.properties, "x-ms-client-flatten", true); +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" +@@extension(EdgeAction.properties, "x-ms-mutability", #["read", "create"]); + +@parentResource(EdgeAction) +model EdgeActionVersion is TrackedResource { + @path + @doc("The name of the Edge Action version") + @segment("versions") + @key("version") + @visibility(Lifecycle.Read) + name: smallString; +} + +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" +@@extension(EdgeActionVersion.properties, "x-ms-client-flatten", true); +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" +@@extension(EdgeActionVersion.properties, + "x-ms-mutability", + #["read", "create"] +); + +@parentResource(EdgeAction) +model EdgeActionExecutionFilter + is TrackedResource { + @path + @doc("The name of the execution filter") + @segment("executionFilters") + @key("executionFilter") + @visibility(Lifecycle.Read) + name: smallString; +} + +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" +@@extension(EdgeActionExecutionFilter.properties, "x-ms-client-flatten", true); +#suppress "@azure-tools/typespec-azure-core/no-openapi" "Extension needed for backwards compatibility with 2024-07-22-preview" +@@extension(EdgeActionExecutionFilter.properties, + "x-ms-mutability", + #["read", "create"] +); + +@armResourceOperations +interface EdgeActions { + get is ArmResourceRead; + create is ArmResourceCreateOrUpdateAsync; + update is ArmResourcePatchAsync; + delete is ArmResourceDeleteWithoutOkAsync; + listByResourceGroup is ArmResourceListByParent; + listBySubscription is ArmListBySubscription; + addAttachment is ArmResourceActionAsync< + EdgeAction, + EdgeActionAttachment, + EdgeActionAttachmentResponse + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Operation matches 2024 baseline with 200, 202 responses" + deleteAttachment is ArmResourceActionNoContentAsync< + EdgeAction, + EdgeActionAttachment + >; +} + +@armResourceOperations +interface EdgeActionVersions { + get is ArmResourceRead; + create is ArmResourceCreateOrUpdateAsync; + update is ArmResourcePatchAsync< + EdgeActionVersion, + EdgeActionVersionProperties + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByEdgeAction is ArmResourceListByParent; + deployVersionCode is ArmResourceActionAsync< + EdgeActionVersion, + VersionCode, + EdgeActionVersionProperties + >; + getVersionCode is ArmResourceActionAsync< + EdgeActionVersion, + void, + VersionCode + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Operation matches 2024 baseline with 200, 202 responses" + swapDefault is ArmResourceActionNoContentAsync; +} + +@armResourceOperations +interface EdgeActionExecutionFilters { + get is ArmResourceRead; + create is ArmResourceCreateOrUpdateAsync; + update is ArmResourcePatchAsync< + EdgeActionExecutionFilter, + EdgeActionExecutionFilterProperties + >; + delete is ArmResourceDeleteWithoutOkAsync; + listByEdgeAction is ArmResourceListByParent; +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Create.json new file mode 100644 index 000000000000..515fa0fea845 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Create.json @@ -0,0 +1,51 @@ +{ + "operationId": "EdgeActionExecutionFilters_Create", + "title": "CreateEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1", + "resource": { + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Delete.json new file mode 100644 index 000000000000..feba90ee8948 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "EdgeActionExecutionFilters_Delete", + "title": "DeleteEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Get.json new file mode 100644 index 000000000000..7b784e5a2106 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActionExecutionFilters_Get", + "title": "GetEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_ListByEdgeAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_ListByEdgeAction.json new file mode 100644 index 000000000000..d985d2198120 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_ListByEdgeAction.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActionExecutionFilters_ListByEdgeAction", + "title": "ListEdgeActionsExecutionFiltersByEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters2", + "name": "executionFilter2", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version2", + "executionFilterIdentifierHeaderName": "header-key2", + "executionFilterIdentifierHeaderValue": "header-value2", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Update.json new file mode 100644 index 000000000000..604b874f573b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionExecutionFilters_Update.json @@ -0,0 +1,38 @@ +{ + "operationId": "EdgeActionExecutionFilters_Update", + "title": "UpdateEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1", + "properties": { + "properties": { + "executionFilterIdentifierHeaderValue": "header-value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/slots/slot1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value2", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Create.json new file mode 100644 index 000000000000..2555fa60c581 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Create.json @@ -0,0 +1,50 @@ +{ + "operationId": "EdgeActionVersions_Create", + "title": "CreateEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version2", + "resource": { + "location": "global", + "properties": { + "deploymentType": "zip", + "isDefaultVersion": "True" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Delete.json new file mode 100644 index 000000000000..6aed9a19a8ed --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "EdgeActionVersions_Delete", + "title": "DeleteEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_DeployVersionCode.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_DeployVersionCode.json new file mode 100644 index 000000000000..f427f4df0021 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_DeployVersionCode.json @@ -0,0 +1,31 @@ +{ + "operationId": "EdgeActionVersions_DeployVersionCode", + "title": "DeployVersionCode", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version2", + "body": { + "name": "zippedFile", + "content": "UEsDBBQAAAAIAI1NzkQAAAAABQAAAA==" + } + }, + "responses": { + "200": { + "body": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Get.json new file mode 100644 index 000000000000..ee4b4300f068 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActionVersions_Get", + "title": "GetEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_GetVersionCode.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_GetVersionCode.json new file mode 100644 index 000000000000..bcb349788f06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_GetVersionCode.json @@ -0,0 +1,25 @@ +{ + "operationId": "EdgeActionVersions_GetVersionCode", + "title": "GetVersionCode", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1", + "body": {} + }, + "responses": { + "200": { + "body": { + "name": "zipfile", + "content": "encodedzip" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_ListByEdgeAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_ListByEdgeAction.json new file mode 100644 index 000000000000..b4c13f03e9ca --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_ListByEdgeAction.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActionVersions_ListByEdgeAction", + "title": "GetEdgeActionVersionsByEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "False", + "lastPackageUpdateTime": "2024-05-25T11:19:23Z" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_SwapDefault.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_SwapDefault.json new file mode 100644 index 000000000000..a94a9a128869 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_SwapDefault.json @@ -0,0 +1,20 @@ +{ + "operationId": "EdgeActionVersions_SwapDefault", + "title": "Swap Default Version", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "edgeActionName": "edgeAction1", + "version": "1.0", + "api-version": "2025-09-01-preview", + "body": {} + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Update.json new file mode 100644 index 000000000000..81a7bb401a7c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionVersions_Update.json @@ -0,0 +1,38 @@ +{ + "operationId": "EdgeActionVersions_Update", + "title": "UpdateEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "version": "version1", + "properties": { + "properties": { + "deploymentType": "others" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "others", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Create.json new file mode 100644 index 000000000000..bf4003702796 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Create.json @@ -0,0 +1,51 @@ +{ + "operationId": "EdgeActionExecutionFilters_Create", + "title": "CreateEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1", + "resource": { + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Delete.json new file mode 100644 index 000000000000..046ebee7af71 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "EdgeActionExecutionFilters_Delete", + "title": "DeleteEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-07-22-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Get.json new file mode 100644 index 000000000000..1b5c551edbeb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActionExecutionFilters_Get", + "title": "GetEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_ListByEdgeAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_ListByEdgeAction.json new file mode 100644 index 000000000000..54d39eb602e7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_ListByEdgeAction.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActionExecutionFilters_ListByEdgeAction", + "title": "ListEdgeActionsExecutionFilters_byEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/executionFilters/executionFilters2", + "name": "executionFilter2", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version2", + "executionFilterIdentifierHeaderName": "header-key2", + "executionFilterIdentifierHeaderValue": "header-value2", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Update.json new file mode 100644 index 000000000000..9cb78a259e6b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsExecutionFilters_Update.json @@ -0,0 +1,38 @@ +{ + "operationId": "EdgeActionExecutionFilters_Update", + "title": "UpdateEdgeActionExecutionFilters", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "executionFilter": "executionFilter1", + "properties": { + "properties": { + "executionFilterIdentifierHeaderValue": "header-value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/slots/slot1", + "name": "executionFilter1", + "type": "Microsoft.Cdn/edgeActions/executionFilters", + "location": "global", + "properties": { + "versionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testrg/providers/Microsoft.Cdn/EdgeActions/edgeAction1/versions/version1", + "executionFilterIdentifierHeaderName": "header-key", + "executionFilterIdentifierHeaderValue": "header-value2", + "provisioningState": "Succeeded", + "lastUpdateTime": "2024-04-25T15:19:23Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-07-22-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Create.json new file mode 100644 index 000000000000..b3293b8c2240 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Create.json @@ -0,0 +1,50 @@ +{ + "operationId": "EdgeActionVersion_Create", + "title": "CreateEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "version": "version2", + "resource": { + "location": "global", + "properties": { + "deploymentType": "zip", + "isDefaultVersion": "True" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version2", + "name": "vesrion2", + "type": "Microsoft.Cdn/edgAactions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Delete.json new file mode 100644 index 000000000000..584a81045993 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "EdgeActionsVersion_Delete", + "title": "DeleteEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "version": "version1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-07-22-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Get.json new file mode 100644 index 000000000000..2288d25b6c09 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActionVersion_Get", + "title": "GetEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "version": "version1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_ListByEdgeAction.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_ListByEdgeAction.json new file mode 100644 index 000000000000..c69c871e579e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_ListByEdgeAction.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActionVersions_ListByEdgeAction", + "title": "GetEdgeActionVersionsByEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeactions/edgeaction1/versions/version2", + "name": "version2", + "type": "Microsoft.Cdn/edgeactions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "zip", + "validationStatus": "Succeeded", + "isDefaultVersion": "False", + "lastPackageUpdateTime": "2024-05-25T11:19:23Z" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Update.json new file mode 100644 index 000000000000..ee5500d4251e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActionsVersions_Update.json @@ -0,0 +1,38 @@ +{ + "operationId": "EdgeActionsVersion_Update", + "title": "UpdateEdgeActionVersion", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2024-07-22-preview", + "edgeActionName": "edgeAction1", + "version": "version1", + "properties": { + "properties": { + "deploymentType": "others" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1/versions/version1", + "name": "version1", + "type": "Microsoft.Cdn/edgeActions/versions", + "location": "global", + "properties": { + "provisioningState": "Succeeded", + "deploymentType": "others", + "validationStatus": "Succeeded", + "isDefaultVersion": "True", + "lastPackageUpdateTime": "2024-05-25T16:19:23Z" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-07-22-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_AddAttachment.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_AddAttachment.json new file mode 100644 index 000000000000..6d21874605b6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_AddAttachment.json @@ -0,0 +1,25 @@ +{ + "operationId": "EdgeActions_AddAttachment", + "title": "AddAttachment", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "body": { + "attachedResourceId": "/subscriptions/sub1/resourceGroups/rs1/providers/Microsoft.Cdn/Profiles/myProfile/afdEndpoints/ep1/routes/route1" + } + }, + "responses": { + "200": { + "body": { + "edgeActionId": "someguid" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Create.json new file mode 100644 index 000000000000..c3619e690588 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Create.json @@ -0,0 +1,51 @@ +{ + "operationId": "EdgeActions_Create", + "title": "CreateEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "resource": { + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Delete.json new file mode 100644 index 000000000000..c3de07233a8d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "EdgeActions_Delete", + "title": "DeleteEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-03-06-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_DeleteAttachment.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_DeleteAttachment.json new file mode 100644 index 000000000000..e5e87774eaf2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_DeleteAttachment.json @@ -0,0 +1,21 @@ +{ + "operationId": "EdgeActions_DeleteAttachment", + "title": "DeleteAttachment", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "body": { + "attachedResourceId": "/subscriptions/sub1/resourceGroups/rs1/providers/Microsoft.Cdn/Profiles/myProfile/afdEndpoints/ep1/routes/route1" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2025-09-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Get.json new file mode 100644 index 000000000000..6cebb226cad3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Get.json @@ -0,0 +1,28 @@ +{ + "operationId": "EdgeActions_Get", + "title": "GetEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_ListByResourceGroup.json new file mode 100644 index 000000000000..cbb237a52fbc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_ListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "operationId": "EdgeActions_ListByResourceGroup", + "title": "ListEdgeActions_byResourceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-09-01-preview", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction2", + "name": "edgeAction2", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_ListBySubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_ListBySubscription.json new file mode 100644 index 000000000000..5d0922451de9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_ListBySubscription.json @@ -0,0 +1,44 @@ +{ + "operationId": "EdgeActions_ListBySubscription", + "title": "ListEdgeActions_bySubscription", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction2", + "name": "edgeAction2", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Update.json new file mode 100644 index 000000000000..b9907af4bef7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/examples/EdgeActions_Update.json @@ -0,0 +1,39 @@ +{ + "operationId": "EdgeActions_Update", + "title": "UpdateEdgeAction", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testrg", + "api-version": "2025-09-01-preview", + "edgeActionName": "edgeAction1", + "properties": { + "sku": { + "name": "Standard", + "tier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testrg/providers/Microsoft.Cdn/edgeActions/edgeAction1", + "name": "edgeAction1", + "type": "Microsoft.Cdn/edgeActions", + "location": "global", + "sku": { + "name": "Standard", + "tier": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "attachments": [] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-03-06-preview" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/openapi.json b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/openapi.json new file mode 100644 index 000000000000..1f80a210915c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/preview/2025-09-01-preview/openapi.json @@ -0,0 +1,2103 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Cdn/EdgeAction", + "version": "2025-09-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EdgeActions" + }, + { + "name": "EdgeActionVersions" + }, + { + "name": "EdgeActionExecutionFilters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/edgeActions": { + "get": { + "operationId": "EdgeActions_ListBySubscription", + "tags": [ + "EdgeActions" + ], + "description": "List EdgeAction resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListEdgeActions_bySubscription": { + "$ref": "./examples/EdgeActions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions": { + "get": { + "operationId": "EdgeActions_ListByResourceGroup", + "tags": [ + "EdgeActions" + ], + "description": "List EdgeAction resources by resource group", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListEdgeActions_byResourceGroup": { + "$ref": "./examples/EdgeActions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}": { + "get": { + "operationId": "EdgeActions_Get", + "tags": [ + "EdgeActions" + ], + "description": "Get a EdgeAction", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEdgeAction": { + "$ref": "./examples/EdgeActions_Get.json" + } + } + }, + "put": { + "operationId": "EdgeActions_Create", + "tags": [ + "EdgeActions" + ], + "description": "Create a EdgeAction", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeAction" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EdgeAction' update operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeAction" + } + }, + "201": { + "description": "Resource 'EdgeAction' create operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeAction" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateEdgeAction": { + "$ref": "./examples/EdgeActions_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EdgeActions_Update", + "tags": [ + "EdgeActions" + ], + "description": "Update a EdgeAction", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeAction" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateEdgeAction": { + "$ref": "./examples/EdgeActions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EdgeActions_Delete", + "tags": [ + "EdgeActions" + ], + "description": "Delete a EdgeAction", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteEdgeAction": { + "$ref": "./examples/EdgeActions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/addAttachment": { + "post": { + "operationId": "EdgeActions_AddAttachment", + "tags": [ + "EdgeActions" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionAttachment" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionAttachmentResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AddAttachment": { + "$ref": "./examples/EdgeActions_AddAttachment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/deleteAttachment": { + "post": { + "operationId": "EdgeActions_DeleteAttachment", + "tags": [ + "EdgeActions" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionAttachment" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteAttachment": { + "$ref": "./examples/EdgeActions_DeleteAttachment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/executionFilters": { + "get": { + "operationId": "EdgeActionExecutionFilters_ListByEdgeAction", + "tags": [ + "EdgeActionExecutionFilters" + ], + "description": "List EdgeActionExecutionFilter resources by EdgeAction", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListEdgeActionsExecutionFiltersByEdgeAction": { + "$ref": "./examples/EdgeActionExecutionFilters_ListByEdgeAction.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/executionFilters/{executionFilter}": { + "get": { + "operationId": "EdgeActionExecutionFilters_Get", + "tags": [ + "EdgeActionExecutionFilters" + ], + "description": "Get a EdgeActionExecutionFilter", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "executionFilter", + "in": "path", + "description": "The name of the execution filter", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEdgeActionExecutionFilters": { + "$ref": "./examples/EdgeActionExecutionFilters_Get.json" + } + } + }, + "put": { + "operationId": "EdgeActionExecutionFilters_Create", + "tags": [ + "EdgeActionExecutionFilters" + ], + "description": "Create a EdgeActionExecutionFilter", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "executionFilter", + "in": "path", + "description": "The name of the execution filter", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilter" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EdgeActionExecutionFilter' update operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilter" + } + }, + "201": { + "description": "Resource 'EdgeActionExecutionFilter' create operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilter" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateEdgeActionExecutionFilters": { + "$ref": "./examples/EdgeActionExecutionFilters_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EdgeActionExecutionFilters_Update", + "tags": [ + "EdgeActionExecutionFilters" + ], + "description": "Update a EdgeActionExecutionFilter", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "executionFilter", + "in": "path", + "description": "The name of the execution filter", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilterUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionExecutionFilter" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateEdgeActionExecutionFilters": { + "$ref": "./examples/EdgeActionExecutionFilters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EdgeActionExecutionFilters_Delete", + "tags": [ + "EdgeActionExecutionFilters" + ], + "description": "Delete a EdgeActionExecutionFilter", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "executionFilter", + "in": "path", + "description": "The name of the execution filter", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteEdgeActionExecutionFilters": { + "$ref": "./examples/EdgeActionExecutionFilters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/versions": { + "get": { + "operationId": "EdgeActionVersions_ListByEdgeAction", + "tags": [ + "EdgeActionVersions" + ], + "description": "List EdgeActionVersion resources by EdgeAction", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEdgeActionVersionsByEdgeAction": { + "$ref": "./examples/EdgeActionVersions_ListByEdgeAction.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/versions/{version}": { + "get": { + "operationId": "EdgeActionVersions_Get", + "tags": [ + "EdgeActionVersions" + ], + "description": "Get a EdgeActionVersion", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetEdgeActionVersion": { + "$ref": "./examples/EdgeActionVersions_Get.json" + } + } + }, + "put": { + "operationId": "EdgeActionVersions_Create", + "tags": [ + "EdgeActionVersions" + ], + "description": "Create a EdgeActionVersion", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionVersion" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EdgeActionVersion' update operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeActionVersion" + } + }, + "201": { + "description": "Resource 'EdgeActionVersion' create operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeActionVersion" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateEdgeActionVersion": { + "$ref": "./examples/EdgeActionVersions_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EdgeActionVersions_Update", + "tags": [ + "EdgeActionVersions" + ], + "description": "Update a EdgeActionVersion", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeActionVersionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionVersion" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateEdgeActionVersion": { + "$ref": "./examples/EdgeActionVersions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EdgeActionVersions_Delete", + "tags": [ + "EdgeActionVersions" + ], + "description": "Delete a EdgeActionVersion", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeleteEdgeActionVersion": { + "$ref": "./examples/EdgeActionVersions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/versions/{version}/deployVersionCode": { + "post": { + "operationId": "EdgeActionVersions_DeployVersionCode", + "tags": [ + "EdgeActionVersions" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/VersionCode" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeActionVersionProperties" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeployVersionCode": { + "$ref": "./examples/EdgeActionVersions_DeployVersionCode.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/versions/{version}/getVersionCode": { + "post": { + "operationId": "EdgeActionVersions_GetVersionCode", + "tags": [ + "EdgeActionVersions" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VersionCode" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVersionCode": { + "$ref": "./examples/EdgeActionVersions_GetVersionCode.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/versions/{version}/swapDefault": { + "post": { + "operationId": "EdgeActionVersions_SwapDefault", + "tags": [ + "EdgeActionVersions" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "edgeActionName", + "in": "path", + "description": "The name of the Edge Action", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + }, + { + "name": "version", + "in": "path", + "description": "The name of the Edge Action version", + "required": true, + "type": "string", + "maxLength": 50, + "pattern": "[a-zA-Z0-9]+" + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Swap Default Version": { + "$ref": "./examples/EdgeActionVersions_SwapDefault.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AttachedResourceId": { + "type": "string", + "format": "arm-id", + "description": "Azure resource identifier for attached routes", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cdn/Profiles/afdEndpoints/routes" + } + ] + } + }, + "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": { + "type": "object", + "title": "Tracked Resource", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "EdgeAction": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeActionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sku": { + "$ref": "#/definitions/SkuType", + "description": "The sku type of the edge action" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "EdgeActionAttachment": { + "type": "object", + "description": "Edge action attachment information", + "properties": { + "id": { + "type": "string", + "description": "The edge action attachment id", + "readOnly": true + }, + "attachedResourceId": { + "$ref": "#/definitions/AttachedResourceId", + "description": "The attached resource Id", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "required": [ + "id", + "attachedResourceId" + ] + }, + "EdgeActionAttachmentResponse": { + "type": "object", + "description": "Edge action attachment response", + "properties": { + "edgeActionId": { + "type": "string", + "description": "Non changing guid to identity edge action", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "required": [ + "edgeActionId" + ] + }, + "EdgeActionExecutionFilter": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeActionExecutionFilterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "EdgeActionExecutionFilterListResult": { + "type": "object", + "description": "The response of a EdgeActionExecutionFilter list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeActionExecutionFilter items on this page", + "items": { + "$ref": "#/definitions/EdgeActionExecutionFilter" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeActionExecutionFilterProperties": { + "type": "object", + "description": "Properties for edge action execution filter", + "properties": { + "versionId": { + "$ref": "#/definitions/EdgeActionVersionId", + "description": "The referenced versionId of the edgeaction version", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last update time in UTC for the execution filter", + "readOnly": true + }, + "executionFilterIdentifierHeaderName": { + "type": "string", + "description": "Custom Header Key associated with the execution filter", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "executionFilterIdentifierHeaderValue": { + "type": "string", + "description": "Custom Header Value associated with the execution filter", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state", + "readOnly": true + } + }, + "required": [ + "versionId", + "lastUpdateTime", + "executionFilterIdentifierHeaderName", + "executionFilterIdentifierHeaderValue" + ] + }, + "EdgeActionExecutionFilterPropertiesUpdate": { + "type": "object", + "description": "Properties for edge action execution filter", + "properties": { + "versionId": { + "$ref": "#/definitions/EdgeActionVersionId", + "description": "The referenced versionId of the edgeaction version", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "executionFilterIdentifierHeaderName": { + "type": "string", + "description": "Custom Header Key associated with the execution filter", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "executionFilterIdentifierHeaderValue": { + "type": "string", + "description": "Custom Header Value associated with the execution filter", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "EdgeActionExecutionFilterUpdate": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeActionExecutionFilterPropertiesUpdate", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" + } + ] + }, + "EdgeActionIsDefaultVersion": { + "type": "string", + "description": "Indicates whether this is the default version", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "EdgeActionIsDefaultVersion", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "This is the default version" + }, + { + "name": "False", + "value": "False", + "description": "This is not the default version" + } + ] + } + }, + "EdgeActionListResult": { + "type": "object", + "description": "The response of a EdgeAction list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeAction items on this page", + "items": { + "$ref": "#/definitions/EdgeAction" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeActionProperties": { + "type": "object", + "description": "Represents an edge action properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the edge action", + "readOnly": true + }, + "attachments": { + "type": "array", + "description": "A list of attachments for the edge action", + "items": { + "$ref": "#/definitions/EdgeActionAttachment" + }, + "readOnly": true + } + }, + "required": [ + "attachments" + ] + }, + "EdgeActionPropertiesUpdate": { + "type": "object", + "description": "Represents an edge action properties" + }, + "EdgeActionUpdate": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeActionPropertiesUpdate", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sku": { + "$ref": "#/definitions/SkuTypeUpdate", + "description": "The sku type of the edge action" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" + } + ] + }, + "EdgeActionVersion": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeActionVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "EdgeActionVersionDeploymentType": { + "type": "string", + "description": "The deployment type for edge action versions", + "enum": [ + "zip", + "file", + "others" + ], + "x-ms-enum": { + "name": "EdgeActionVersionDeploymentType", + "modelAsString": true, + "values": [ + { + "name": "zip", + "value": "zip", + "description": "ZIP file deployment" + }, + { + "name": "file", + "value": "file", + "description": "Single file deployment" + }, + { + "name": "others", + "value": "others", + "description": "Other deployment types" + } + ] + } + }, + "EdgeActionVersionId": { + "type": "string", + "format": "arm-id", + "description": "Azure resource identifier for edge action versions", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Cdn/edgeActions/versions" + } + ] + } + }, + "EdgeActionVersionListResult": { + "type": "object", + "description": "The response of a EdgeActionVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeActionVersion items on this page", + "items": { + "$ref": "#/definitions/EdgeActionVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeActionVersionProperties": { + "type": "object", + "description": "Represents an edge action version", + "properties": { + "deploymentType": { + "$ref": "#/definitions/EdgeActionVersionDeploymentType", + "description": "The deployment type", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "validationStatus": { + "$ref": "#/definitions/EdgeActionVersionValidationStatus", + "description": "The validation status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state", + "readOnly": true + }, + "isDefaultVersion": { + "$ref": "#/definitions/EdgeActionIsDefaultVersion", + "description": "The active state", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "lastPackageUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last update time in UTC for package update", + "readOnly": true + } + }, + "required": [ + "deploymentType", + "validationStatus", + "isDefaultVersion", + "lastPackageUpdateTime" + ] + }, + "EdgeActionVersionPropertiesUpdate": { + "type": "object", + "description": "Represents an edge action version", + "properties": { + "deploymentType": { + "$ref": "#/definitions/EdgeActionVersionDeploymentType", + "description": "The deployment type", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "isDefaultVersion": { + "$ref": "#/definitions/EdgeActionIsDefaultVersion", + "description": "The active state", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + } + }, + "EdgeActionVersionUpdate": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/EdgeActionVersionPropertiesUpdate", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" + } + ] + }, + "EdgeActionVersionValidationStatus": { + "type": "string", + "description": "The validation status for edge action versions", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "EdgeActionVersionValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed" + } + ] + }, + "readOnly": true + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Upgrading" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Initial provisioning in progress" + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Upgrade in progress" + } + ] + }, + "readOnly": true + }, + "SkuType": { + "type": "object", + "description": "The SKU type for the edge action", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU" + }, + "tier": { + "type": "string", + "description": "The tier of the SKU" + } + }, + "required": [ + "name", + "tier" + ] + }, + "SkuTypeUpdate": { + "type": "object", + "description": "The SKU type for the edge action", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU" + }, + "tier": { + "type": "string", + "description": "The tier of the SKU" + } + } + }, + "VersionCode": { + "type": "object", + "description": "Version code information for edge action", + "properties": { + "content": { + "type": "string", + "description": "The version code deployment content ", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + }, + "name": { + "type": "string", + "description": "The version code name", + "x-ms-mutability": [ + "read", + "update", + "create" + ] + } + }, + "required": [ + "content", + "name" + ] + } + }, + "parameters": {} +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/readme.md b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/readme.md new file mode 100644 index 000000000000..ceb5e9833781 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/readme.md @@ -0,0 +1,82 @@ +# EdgeActions + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for EdgeActions. + +--- + +## Getting Started + +To build the SDK for EdgeActions, 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 EdgeActions API. + +``` yaml +title: EdgeActionsManagementClient +description: Edge Actions Management Client +openapi-type: arm +tag: package-2025-09-01-preview +``` + +### Tag: package-2025-09-01-preview + +These settings apply only when `--tag=package-2025-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2025-09-01-preview' +input-file: + - preview/2025-09-01-preview/openapi.json +modelerfour: + lenient-model-deduplication: true + prenamer: true +suppressions: + # Operations endpoint for Microsoft.Cdn already defined in central Cdn swagger, not duplicated here + - code: OperationsAPIImplementation + reason: Operations API implemented in central Cdn swagger (package-preview-2025-09) for provider Microsoft.Cdn. + # LRO POST actions intentionally return 200 (final) and 202 (in-progress) matching 2024-07-22-preview baseline. + - code: PostResponseCodes + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/addAttachment"].post + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/deleteAttachment"].post + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/edgeActions/{edgeActionName}/versions/{version}/swapDefault"].post + reason: Preexisting LRO pattern (200,202) retained for backward compatibility with 2024-07-22-preview. +``` + +--- + +# 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-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + - repo: azure-resource-manager-schemas + - repo: azure-powershell +``` + +## C# + +C# SDK generation is configured via TypeSpec in `tspconfig.yaml`. +The generated SDK uses the `Azure.ResourceManager.EdgeActions` namespace as a separate package. + diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/tspconfig.yaml b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/tspconfig.yaml new file mode 100644 index 000000000000..2854daae6c5f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/EdgeActions/tspconfig.yaml @@ -0,0 +1,57 @@ +parameters: + "service-dir": + default: "sdk/edgeactions" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +output-dir: "{project-root}/preview/2025-09-01-preview" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + emitter-output-dir: "{output-dir}" + output-file: "openapi.json" + azure-resource-provider-folder: "resource-manager" + examples-dir: "{project-root}/examples" + arm-types-dir: "{project-root}/../../../../common-types/resource-management" + new-line: lf + use-read-only-status-schema: true + "@azure-tools/typespec-python": + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-edgeactions" + namespace: "azure.mgmt.edgeactions" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-edgeactions" + namespace: "com.azure.resourcemanager.edgeactions" + service-name: "EdgeActions" + service-dir: "sdk/edgeactions" + flavor: azure + "@azure-tools/typespec-ts": + service-dir: sdk/edgeactions + emitter-output-dir: "{output-dir}/{service-dir}/arm-edgeactions" + is-modular-library: true + flavor: "azure" + experimental-extensible-enums: true + package-details: + name: "@azure/arm-edgeactions" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/edgeactions" + emitter-output-dir: "{output-dir}/{service-dir}/armedgeactions" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armedgeactions" + fix-const-stuttering: true + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + "@azure-tools/typespec-csharp": + service-dir: "sdk/edgeactions" + emitter-output-dir: "{output-dir}/{service-dir}/Azure.ResourceManager.EdgeActions" + namespace: "Azure.ResourceManager.EdgeActions" + flavor: "azure" + clear-output-folder: true + generate-sample-project: true + generate-test-project: true diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/back-compatible.tsp b/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/back-compatible.tsp index 2a912c128d1f..22ae0c8e3f99 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/back-compatible.tsp +++ b/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/back-compatible.tsp @@ -34,3 +34,29 @@ using Microsoft.Chaos; @@clientName(Operations.list, "ListAll", "autorest"); @@clientName(ExperimentExecutions.getExecutionDetails, "ExecutionDetails"); @@clientName(PrivateAccesses.privateLinkResources, "GetPrivateLinkResources"); + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Capability.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CapabilityType.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExperimentExecution.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateAccess.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateEndpointConnection.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateLinkResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Target.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TargetType.properties, + "autorest" +); diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/experiment.models.tsp b/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/experiment.models.tsp index b7bfb4a20ca3..2908bb94385c 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/experiment.models.tsp +++ b/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/experiment.models.tsp @@ -29,8 +29,9 @@ model Experiment extends Azure.ResourceManager.Foundations.TrackedResource { ...Azure.ResourceManager.ManagedServiceIdentityProperty; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Required implementation to avoid breaking .NET SDK changes" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" @doc("The resource-specific properties for this resource.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty @Azure.ResourceManager.Private.armResourcePropertiesOptionality(false) properties?: ExperimentProperties; } diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/tspconfig.yaml b/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/tspconfig.yaml index a8f34b1a28e5..726869a93e27 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/tspconfig.yaml +++ b/specification/chaos/resource-manager/Microsoft.Chaos/Chaos/tspconfig.yaml @@ -7,8 +7,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}" output-file: "{version-status}/{version}/openapi.json" arm-types-dir: "{project-root}/../../../../common-types/resource-management" diff --git a/specification/codesigning/CodeSigning.Management/tspconfig.yaml b/specification/codesigning/CodeSigning.Management/tspconfig.yaml index 1fedabe0c242..99e241e2f602 100644 --- a/specification/codesigning/CodeSigning.Management/tspconfig.yaml +++ b/specification/codesigning/CodeSigning.Management/tspconfig.yaml @@ -9,8 +9,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeSigningAccount.json" "@azure-tools/typespec-java": emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-trustedsigning" diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversations.json deleted file mode 100644 index b7c349c9c4ae..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversations", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "play In the air tonight from Phil Collins" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "play In the air tonight from Phil Collins", - "prediction": { - "topIntent": "PlayMusic", - "projectKind": "Conversation", - "intents": [ - { - "category": "PlayMusic", - "confidenceScore": 1 - }, - { - "category": "SearchCreativeWork", - "confidenceScore": 0 - }, - { - "category": "AddToPlaylist", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Media.Artist", - "text": "Phil Collins", - "offset": 29, - "length": 12, - "confidenceScore": 1 - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index 63886997c41e..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitration", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index b7c39ef12d28..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2023-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 8a06b3663db0..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "AnalyzeConversationsCancelJob", - "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json deleted file mode 100644 index 6855d85571fd..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIExclusionSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "Person" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json deleted file mode 100644 index 140ac9bc453a..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json deleted file mode 100644 index 377aef55f9e3..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIRedactionCharSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionCharacter": "-", - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json deleted file mode 100644 index 083a82355920..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning -------------.", - "itn": "good morning -------------", - "maskedItn": "good morning -------------", - "lexical": "good morning -------------", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIISubmit.json deleted file mode 100644 index d94e207ea7c9..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIISubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index e379a775a24a..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIITaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentSubmit.json deleted file mode 100644 index cd06fcaf794c..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentSubmit.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSentimentSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Sentiment Analysis from a call center conversation", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "I like the service. I do not like the food", - "lexical": "i like the service i do not like the food", - "itn": "", - "maskedItn": "" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Sentiment Analysis", - "kind": "ConversationalSentimentTask", - "parameters": { - "modelVersion": "latest", - "predictionSource": "text" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentTaskStatusRequest.json deleted file mode 100644 index 33bfb6c2f6bb..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSentimentTaskStatusRequest.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSentimentTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2022-04-01T15:00:45Z", - "displayName": "Sentiment Analysis from a call center conversation", - "expirationDateTime": "2022-04-01T15:00:45Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSentimentResults", - "taskName": "Conversation Sentiment", - "lastUpdateDateTime": "2022-04-01T15:00:45Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "participantId": "agent_1", - "sentiment": "mixed", - "confidenceScores": { - "positive": 0.5, - "neutral": 0.01, - "negative": 0.49 - } - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2023-11-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index 73d39d18dd18..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "ConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 07718a8f8779..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index fb8d74f4917b..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 1d06f87a2bed..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarySubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json deleted file mode 100644 index 5ce4948fe18d..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulCustomConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Custom Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "CustomConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Custom Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json deleted file mode 100644 index d68630c0ab7e..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2023-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulCustomConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2023-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Custom Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Custom Conversation Summarization Task 1", - "kind": "CustomConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "narrative" - ], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversations.json deleted file mode 100644 index b4dd75203aff..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversations", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "Book a flight to Seattle on Oct 10th" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Book a flight to Seattle on Oct 10th", - "prediction": { - "topIntent": "BookFlight", - "projectKind": "Conversation", - "intents": [ - { - "category": "None", - "confidenceScore": 1 - }, - { - "category": "BookTrain", - "confidenceScore": 0 - }, - { - "category": "BookFlight", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Geography.Location", - "text": "seattle", - "offset": 17, - "length": 7, - "confidenceScore": 1, - "extraInformation": [ - { - "extraInformationKind": "EntitySubtype", - "value": "geography.location", - "tags": [ - { - "name": "City", - "confidenceScore": 1 - }, - { - "name": "GPE", - "confidenceScore": 1 - }, - { - "name": "Location", - "confidenceScore": 1 - } - ] - } - ] - }, - { - "category": "DateTime", - "text": "oct 10th", - "offset": 28, - "length": 8, - "confidenceScore": 1, - "resolutions": [ - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "XXXX-10-10", - "value": "2023-10-10" - }, - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "XXXX-10-10", - "value": "2024-10-10" - } - ], - "extraInformation": [ - { - "extraInformationKind": "EntitySubtype", - "value": "datetime.date", - "tags": [ - { - "name": "Date", - "confidenceScore": 1 - }, - { - "name": "Temporal", - "confidenceScore": 1 - } - ] - } - ] - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index 33018615d1b3..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitration", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index b0897595ecb7..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-05-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index ab8a77b27c0b..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "AnalyzeConversationsCancelJob", - "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionSubmit.json deleted file mode 100644 index 1236a317bdf2..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionSubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIExclusionSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "Person" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json deleted file mode 100644 index 9e7801933ebc..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json deleted file mode 100644 index 72097e81061c..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIRedactionCharSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionCharacter": "-", - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json deleted file mode 100644 index e2b3ea2499ad..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning -------------.", - "itn": "good morning -------------", - "maskedItn": "good morning -------------", - "lexical": "good morning -------------", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIISubmit.json deleted file mode 100644 index 56c12df8d8b5..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIISubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index c9c0ce430777..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIITaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index eca89232337e..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 2cb92a853eda..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index a9ae7d4dc2a4..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index f7f06e6dcc67..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarySubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json deleted file mode 100644 index bd961e99ed76..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulCustomConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Custom Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "customConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Custom Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json deleted file mode 100644 index e8110f83f168..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-05-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulCustomConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-05-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Custom Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Custom Conversation Summarization Task 1", - "kind": "CustomConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "narrative" - ], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversations.json deleted file mode 100644 index 8616101b455b..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversations.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversations", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "id": "1", - "participantId": "1", - "text": "Book a flight to Seattle on Oct 10th" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Book a flight to Seattle on Oct 10th", - "prediction": { - "topIntent": "BookFlight", - "projectKind": "Conversation", - "intents": [ - { - "category": "None", - "confidenceScore": 1 - }, - { - "category": "BookTrain", - "confidenceScore": 0 - }, - { - "category": "BookFlight", - "confidenceScore": 0 - } - ], - "entities": [ - { - "category": "Geography.Location", - "text": "seattle", - "offset": 17, - "length": 7, - "confidenceScore": 1, - "extraInformation": [ - { - "extraInformationKind": "EntitySubtype", - "value": "geography.location", - "tags": [ - { - "name": "City", - "confidenceScore": 1 - }, - { - "name": "GPE", - "confidenceScore": 1 - }, - { - "name": "Location", - "confidenceScore": 1 - } - ] - } - ] - }, - { - "category": "DateTime", - "text": "oct 10th", - "offset": 28, - "length": 8, - "confidenceScore": 1, - "resolutions": [ - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "XXXX-10-10", - "value": "2023-10-10" - }, - { - "resolutionKind": "DateTimeResolution", - "dateTimeSubKind": "Date", - "timex": "XXXX-10-10", - "value": "2024-10-10" - } - ], - "extraInformation": [ - { - "extraInformationKind": "EntitySubtype", - "value": "datetime.date", - "tags": [ - { - "name": "Date", - "confidenceScore": 1 - }, - { - "name": "Temporal", - "confidenceScore": 1 - } - ] - } - ] - } - ] - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json deleted file mode 100644 index e53d1e73b0df..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitration.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitration", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "participantId": "1", - "id": "1", - "modality": "text", - "language": "en-GB", - "text": "How do I integrate QnA Maker and LUIS?" - } - }, - "parameters": { - "projectName": "{project-name}", - "deploymentName": "{deployment-name}", - "verbose": true, - "isLoggingEnabled": false, - "stringIndexType": "TextElement_V8" - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Rail", - "projectKind": "Orchestration", - "intents": { - "Rail": { - "confidenceScore": 1, - "targetProjectKind": "Conversation", - "result": { - "query": "trains from London", - "prediction": { - "topIntent": "Timetable", - "projectKind": "Conversation", - "intents": [ - { - "category": "Timetable", - "confidenceScore": 0.99968535 - }, - { - "category": "Locomotive", - "confidenceScore": 0.000314623 - } - ], - "entities": [] - } - } - }, - "Tree": { - "confidenceScore": 0.2641529, - "targetProjectKind": "QuestionAnswering" - }, - "None": { - "confidenceScore": 0, - "targetProjectKind": "NonLinked" - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json deleted file mode 100644 index c7fa63683056..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversations", - "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget", - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "Content-Type": "application/json", - "api-version": "2024-11-15-preview", - "body": { - "kind": "Conversation", - "analysisInput": { - "conversationItem": { - "text": "Ports and connectors", - "participantId": "1", - "id": "1" - } - }, - "parameters": { - "projectName": "prj1", - "deploymentName": "dep1", - "directTarget": "qnaProject", - "targetProjectParameters": { - "qnaProject": { - "targetProjectKind": "QuestionAnswering", - "callingOptions": { - "context": { - "previousUserQuery": "Meet Surface Pro 4", - "previousQnaId": 4 - }, - "top": 1, - "question": "App Service overview" - } - } - } - } - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "kind": "ConversationResult", - "result": { - "query": "Ports and connectors", - "prediction": { - "projectKind": "Orchestration", - "topIntent": "qnaTargetApp", - "intents": { - "qnaTargetApp": { - "targetProjectKind": "QuestionAnswering", - "confidenceScore": 1, - "result": { - "answers": [ - { - "questions": [ - "App Service overview" - ], - "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", - "confidenceScore": 0.7384000000000001, - "id": 1, - "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", - "metadata": {}, - "dialog": { - "isContextOnly": false, - "prompts": [] - } - } - ] - } - } - } - } - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json deleted file mode 100644 index 0ba9180e8ccb..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulAnalyzeConversationsJobsCancelRequest.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "AnalyzeConversationsCancelJob", - "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json deleted file mode 100644 index c97624b9d472..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionSubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIExclusionSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "excludePiiCategories": [ - "Person" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-05-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json deleted file mode 100644 index 03866576d9b7..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIExclusionTaskStatusRequest.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json deleted file mode 100644 index b3c7e4333661..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharSubmit.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIIRedactionCharSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionCharacter": "-", - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json deleted file mode 100644 index 5ad8363d2a85..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning -------------.", - "itn": "good morning -------------", - "maskedItn": "good morning -------------", - "lexical": "good morning -------------", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIISubmit.json deleted file mode 100644 index a71e74da84a5..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIISubmit.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationPIISubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Redacting PII data from transcribed audio", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "domain": "generic", - "conversationItems": [ - { - "participantId": "1", - "id": "1", - "text": "Good morning John Doe.", - "itn": "good morning john doe", - "maskedItn": "good morning john doe", - "lexical": "good morning john doe", - "wordLevelTimings": [ - { - "word": "good", - "offset": 390000, - "duration": 2700000 - }, - { - "word": "morning", - "offset": 4500000, - "duration": 920000 - }, - { - "word": "john", - "offset": 590000, - "duration": 2700000 - }, - { - "word": "doe", - "offset": 6300000, - "duration": 920000 - } - ] - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation PII", - "kind": "ConversationalPIITask", - "parameters": { - "modelVersion": "latest", - "piiCategories": [ - "All" - ], - "redactionSource": "lexical", - "redactAudioTiming": true - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json deleted file mode 100644 index 6de863d126a7..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIITaskStatusRequest.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationPIITaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "createdDateTime": "2020-10-01T15:00:45Z", - "displayName": "Redacting PII from transcribed audio", - "expirationDateTime": "2020-10-03T15:01:03Z", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", - "lastUpdatedDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalPIIResults", - "taskName": "Conversation PII", - "lastUpdateDateTime": "2022-01-25T15:01:03Z", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "conversationItems": [ - { - "id": "1", - "redactedContent": { - "text": "Good morning *************.", - "itn": "good morning *************", - "maskedItn": "good morning *************", - "lexical": "good morning *************", - "audioTimings": [ - { - "offset": 590000, - "duration": 920000 - } - ] - }, - "entities": [ - { - "category": "Person", - "confidenceScore": 0.91, - "length": 8, - "offset": 13, - "text": "john doe" - } - ] - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "2022-05-15-preview" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskResult.json deleted file mode 100644 index 80f4c585efc8..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskResult.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "chapterTitle", - "text": "Bug Triage", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - } - ] - }, - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json deleted file mode 100644 index 4319fab4524a..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskStatusRequest.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulConversationSummarizationTaskStatusRequest", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Analyze chat", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "conversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "analyze 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "20220101meeting", - "summaries": [ - { - "aspect": "issue", - "text": "Customer wants to cancel his subscription. Customer doesn't know how" - }, - { - "aspect": "resolution", - "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" - } - ], - "warnings": [], - "statistics": { - "transactionsCount": 1 - } - } - ], - "errors": [], - "modelVersion": "latest" - } - } - ] - }, - "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json deleted file mode 100644 index a3b23cc611c1..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Conversation Summarization Task 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "chapterTitle", - "narrative" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarySubmit.json deleted file mode 100644 index 6b868c22497d..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationSummarySubmit.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulConversationSummarySubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Analyze conversations from Contoso meeting", - "analysisInput": { - "conversations": [ - { - "id": "20220101meeting", - "language": "en", - "modality": "text", - "domain": "generic", - "conversationItems": [ - { - "participantId": "user", - "role": "customer", - "id": "1", - "text": "Hi!" - }, - { - "participantId": "agent", - "role": "agent", - "id": "2", - "text": "Hello, how can I help you?" - }, - { - "participantId": "user", - "role": "customer", - "id": "3", - "text": "I am having trouble issuing a return of a game on my xbox: call of duty" - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "analyze 1", - "kind": "ConversationalSummarizationTask", - "parameters": { - "modelVersion": "latest", - "summaryAspects": [ - "issue", - "resolution" - ] - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json deleted file mode 100644 index ce81f6994e94..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskResult.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "operationId": "AnalyzeConversationsJobStatus", - "title": "SuccessfulCustomConversationSummarizationTaskResult", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "displayName": "Custom Conversation Summarization Example", - "createdDateTime": "2022-04-01T15:00:45Z", - "expirationDateTime": "2022-04-02T15:00:45Z", - "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", - "lastUpdatedDateTime": "2022-04-01T15:00:49Z", - "status": "succeeded", - "tasks": { - "completed": 1, - "failed": 0, - "inProgress": 0, - "total": 1, - "items": [ - { - "kind": "customConversationalSummarizationResults", - "lastUpdateDateTime": "2022-04-01T15:00:49Z", - "taskName": "Custom Conversation Summarization Task 1", - "status": "succeeded", - "results": { - "conversations": [ - { - "id": "1", - "summaries": [ - { - "aspect": "narrative", - "text": "Speaker 3 believes there are 3 remaining bugs.", - "contexts": [ - { - "conversationItemId": "2", - "offset": 4, - "length": 39 - }, - { - "conversationItemId": "3", - "offset": 0, - "length": 7 - } - ] - } - ], - "warnings": [] - } - ], - "errors": [], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json deleted file mode 100644 index 22fa3666bb1b..000000000000 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulCustomConversationSummarizationTaskSubmit.json +++ /dev/null @@ -1,80 +0,0 @@ -{ - "operationId": "AnalyzeConversationsSubmitJob", - "title": "SuccessfulCustomConversationSummarizationTaskSubmit", - "parameters": { - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", - "Endpoint": "{Endpoint}", - "jobId": "{Job ID}", - "body": { - "displayName": "Custom Conversation Summarization Example", - "analysisInput": { - "conversations": [ - { - "id": "1", - "language": "en", - "modality": "transcript", - "conversationItems": [ - { - "participantId": "speaker 1", - "id": "1", - "text": "Let's get started.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 0, - "duration": 20000000 - } - }, - { - "participantId": "speaker 2", - "id": "2", - "text": "OK. How many remaining bugs do we have now?", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 20000000, - "duration": 50000000 - } - }, - { - "participantId": "speaker 3", - "id": "3", - "text": "Only 3.", - "lexical": "", - "itn": "", - "maskedItn": "", - "conversationItemLevelTiming": { - "offset": 50000000, - "duration": 60000000 - } - } - ] - } - ] - }, - "tasks": [ - { - "taskName": "Custom Conversation Summarization Task 1", - "kind": "CustomConversationalSummarizationTask", - "parameters": { - "summaryAspects": [ - "narrative" - ], - "projectName": "my_project", - "deploymentName": "my_deployment" - } - } - ] - } - }, - "responses": { - "202": { - "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp index d7d83474cdd5..b47c5ee68734 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/main.tsp @@ -53,6 +53,9 @@ enum Versions { /** Version 2024-11-01 */ v2024_11_01: "2024-11-01", + /** Version 2025-05-15 */ + v2025_05_15_preview: "2025-05-15-preview", + /** Version 2025-11-15-preview */ v2025_11_15_preview: "2025-11-15-preview", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp index 2d86b4162baa..487c260b8e40 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.tsp @@ -401,7 +401,7 @@ model AnalyzeConversationTaskResult { /** A conversational AI task. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAITask extends AnalyzeConversationTask { /** Task kind. */ kind: AnalyzeConversationTaskKind.ConversationalAI; @@ -415,7 +415,7 @@ model ConversationalAITask extends AnalyzeConversationTask { /** The input ConversationItem and its optional parameters */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIAnalysisInput { /** List of multiple conversations */ conversations: TextConversation[]; @@ -604,7 +604,7 @@ model EntitySubtype extends BaseExtraInformation { value?: string; @doc("List of entity tags. Tags express similarities between entity categories for the extracted entity type.") - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) tags?: Array; } @@ -632,7 +632,7 @@ model RegexKey extends BaseExtraInformation { /** The abstract base class for entity resolutions. */ @doc("Tags express similarities between entity categories for the extracted entity type.") -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityTag { @doc("The name of the tag.") name: string; @@ -864,7 +864,7 @@ model AnalyzeConversationJobsInput { tasks: Array; /** Optional duration in seconds after which the job will be canceled if not completed. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) cancelAfter?: float32; } @@ -1072,7 +1072,7 @@ model ConversationItemLevelTiming is AudioTiming; /** Input parameters base for a Conversation task. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIInputParameters { /** The name of the project to use. */ projectName: string; @@ -1110,7 +1110,7 @@ model ConversationTaskParameters { /** The results of a ConversationalAI task. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAITaskResult extends AnalyzeConversationTaskResult { /** The results of a Conversational AI task. */ kind: AnalyzeConversationTaskResultsKind.ConversationalAIResult; @@ -1121,7 +1121,7 @@ model ConversationalAITaskResult extends AnalyzeConversationTaskResult { /** Represents the conversational analysis response. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIResult { /** Multiple multi-turn conversations analyzed. */ conversations: ConversationalAIAnalysis[]; @@ -1132,7 +1132,7 @@ model ConversationalAIResult { /** Multiple multi-turn conversations analyzed. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIAnalysis { /** The ID of the conversation. */ id: string; @@ -1146,7 +1146,7 @@ model ConversationalAIAnalysis { /** The intent classification result for this conversation. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIIntent { /** The name of the detected intent. */ name: string; @@ -1162,7 +1162,7 @@ model ConversationalAIIntent { } /** The ranges of conversation items where this intent was identified. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationItemRange { /** The starting index of the intent occurrence within the conversation. */ offset: int32; @@ -1173,7 +1173,7 @@ model ConversationItemRange { /** The entity associated with this intent. */ #suppress "@azure-tools/typespec-azure-core/casing-style" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ConversationalAIEntity { /** The entity name or category. */ name: string; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp index 0ebd94d2b50f..e70a5218434a 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/common.union.tsp @@ -21,7 +21,7 @@ union AnalyzeConversationTaskKind { Conversation: "Conversation", /** Conversation task kind */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) ConversationalAI: "ConversationalAI", } @@ -33,7 +33,7 @@ union AnalyzeConversationTaskResultsKind { ConversationResult: "ConversationResult", /** Conversation result task kind */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) ConversationalAIResult: "ConversationalAIResult", } @@ -246,7 +246,7 @@ union projectKind { Orchestration: "Orchestration", /** Conversation type */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) ConversationalAI: "ConversationalAI", } @@ -682,7 +682,7 @@ union AnalyzeConversationLROTaskKind { ConversationalPIITask: "ConversationalPIITask", /** Custom Conversational Summarization Task */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) CustomConversationalSummarizationTask: "CustomConversationalSummarizationTask", } @@ -700,7 +700,7 @@ union AnalyzeConversationResultsKind { ConversationalPIIResults: "conversationalPIIResults", /** Custom Conversational Summarization Results */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) CustomConversationalSummarizationResults: "customConversationalSummarizationResults", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp index f19d973e7fa8..b436cad0afad 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/pii.tsp @@ -35,15 +35,15 @@ model Entity { confidenceScore: float64; /** Exact mask text to mask the PII entity */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) mask?: string; /** Offset of the mask text */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskOffset?: int32; /** Length of the mask text */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskLength?: int32; } @@ -125,12 +125,12 @@ model ConversationPiiTaskParameters is PreBuiltTaskParameters { excludePiiCategories?: Array; /** Optional parameter determine what type of redaction to use. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) redactionPolicy?: BaseRedactionPolicy; } /** Kinds of redaction policies supported. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union RedactionPolicyKind { string, @@ -145,7 +145,7 @@ union RedactionPolicyKind { } /** The abstract base class for RedactionPolicy. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @discriminator("policyKind") model BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ @@ -153,7 +153,7 @@ model BaseRedactionPolicy { } /** Represents the policy of masking with a redaction character */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CharacterMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.characterMask; @@ -163,14 +163,14 @@ model CharacterMaskPolicyType extends BaseRedactionPolicy { } /** Represents the policy of not masking found PII. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model NoMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.noMask; } /** Represents the policy of masking PII with the entity type. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityMaskTypePolicyType extends BaseRedactionPolicy { /** The entity OverlapPolicy object kind. */ policyKind: RedactionPolicyKind.entityMask; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp index 95aae0cd7070..b93153bff5e3 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/models/summarization.tsp @@ -14,7 +14,7 @@ using Azure.Core.Traits; namespace Language.Conversations; /** Task definition for custom conversational summarization. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeCustomConversationSummarizationTask extends AnalyzeConversationLROTask { /** discriminator kind */ @@ -42,7 +42,7 @@ model ConversationSummarizationTaskParametersBase summaryAspects: Array; /** a text field to allow customers to use natural language to describe their needs for summarization. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) instruction?: string; } @@ -53,7 +53,7 @@ model ConversationSummarizationTaskParameters is PreBuiltTaskParameters { } /** Supported parameters for a custom conversation summarization task. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CustomConversationSummarizationTaskParameters is CustomTaskParameters { /** It controls the approximate number of sentences in the output summaries. */ sentenceCount?: int32; @@ -90,7 +90,7 @@ union SummaryAspect { recap: "recap", /** Action items and tasks that arose during a meeting. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) followUpTasks: "follow-up tasks", } @@ -106,7 +106,7 @@ model AnalyzeConversationSummarizationResult } /** Result for the custom summarization task on the conversation. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeCustomConversationSummarizationResult extends AnalyzeConversationJobResult { /** discriminator kind */ @@ -131,7 +131,7 @@ model SummaryResult { } /** Custom Summary Results */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CustomSummaryResult { ...SummaryResultBase; ...CustomResult; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/analyzeconversations.json new file mode 100644 index 000000000000..62589fd4a25c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/analyzeconversations.json @@ -0,0 +1,5501 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations", + "version": "2025-05-15-preview", + "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\\n\\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/:analyze-conversations": { + "post": { + "operationId": "AnalyzeConversations", + "description": "Analyzes the input conversation utterance.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The input for the analyze conversations operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationTask" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAnalyzeConversationalAITask": { + "$ref": "./examples/SuccessfulAnalyzeConversationalAITask.json" + }, + "SuccessfulAnalyzeConversations": { + "$ref": "./examples/SuccessfulAnalyzeConversations.json" + }, + "SuccessfulAnalyzeConversationsArbitration": { + "$ref": "./examples/SuccessfulAnalyzeConversationsArbitration.json" + }, + "SuccessfulAnalyzeConversationsArbitrationDirectTarget": { + "$ref": "./examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" + } + } + } + }, + "/analyze-conversations/jobs": { + "post": { + "operationId": "AnalyzeConversationsSubmitJob", + "description": "Analyzes the input conversation utterance.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The input for the analyze conversations operation.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationJobsInput" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulConversationPIICharacterMask": { + "$ref": "./examples/SuccessfulConversationPIICharacterMask.json" + }, + "SuccessfulConversationPIIEntityMask": { + "$ref": "./examples/SuccessfulConversationPIIEntityMask.json" + }, + "SuccessfulConversationPIIExclusionSubmit": { + "$ref": "./examples/SuccessfulConversationPIIExclusionSubmit.json" + }, + "SuccessfulConversationPIINoMask": { + "$ref": "./examples/SuccessfulConversationPIINoMask.json" + }, + "SuccessfulConversationPIIRedactionCharSubmit": { + "$ref": "./examples/SuccessfulConversationPIIRedactionCharSubmit.json" + }, + "SuccessfulConversationPIISubmit": { + "$ref": "./examples/SuccessfulConversationPIISubmit.json" + }, + "SuccessfulConversationSummarizationTaskSubmit": { + "$ref": "./examples/SuccessfulConversationSummarizationTaskSubmit.json" + }, + "SuccessfulConversationSummarySubmit": { + "$ref": "./examples/SuccessfulConversationSummarySubmit.json" + }, + "SuccessfulCustomConversationSummarizationTaskSubmit": { + "$ref": "./examples/SuccessfulCustomConversationSummarizationTaskSubmit.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-conversations/jobs/{jobId}": { + "get": { + "operationId": "AnalyzeConversationsJobStatus", + "summary": "Get analysis status and results", + "description": "Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "job ID", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulConversationPIICharacterMaskTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json" + }, + "SuccessfulConversationPIIEntityMaskTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json" + }, + "SuccessfulConversationPIIExclusionTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json" + }, + "SuccessfulConversationPIINoMaskTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json" + }, + "SuccessfulConversationPIIRedactionCharTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json" + }, + "SuccessfulConversationPIITaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationPIITaskStatusRequest.json" + }, + "SuccessfulConversationSummarizationTaskResult": { + "$ref": "./examples/SuccessfulConversationSummarizationTaskResult.json" + }, + "SuccessfulConversationSummarizationTaskStatusRequest": { + "$ref": "./examples/SuccessfulConversationSummarizationTaskStatusRequest.json" + }, + "SuccessfulCustomConversationSummarizationTaskResult": { + "$ref": "./examples/SuccessfulCustomConversationSummarizationTaskResult.json" + } + } + } + }, + "/analyze-conversations/jobs/{jobId}:cancel": { + "post": { + "operationId": "AnalyzeConversationsCancelJob", + "summary": "Cancel a long-running Text Analysis conversations job.", + "description": "Cancel a long-running job for text analysis of conversations.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID to cancel.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAnalyzeConversationsJobsCancelRequest": { + "$ref": "./examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AgeResolution": { + "type": "object", + "description": "Represents the Age entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AgeUnit", + "description": "The Age Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "AgeResolution" + }, + "AgeUnit": { + "type": "string", + "description": "The Age Unit of measurement", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified age unit" + }, + { + "name": "Year", + "value": "Year", + "description": "Year age unit" + }, + { + "name": "Month", + "value": "Month", + "description": "Month age unit" + }, + { + "name": "Week", + "value": "Week", + "description": "Week age unit" + }, + { + "name": "Day", + "value": "Day", + "description": "Day age unit" + } + ] + } + }, + "AnalysisParameters": { + "type": "object", + "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", + "properties": { + "targetProjectKind": { + "$ref": "#/definitions/targetProjectKind", + "description": "The type of a target service" + }, + "apiVersion": { + "type": "string", + "description": "The API version to use when call a specific target service." + } + }, + "discriminator": "targetProjectKind", + "required": [ + "targetProjectKind" + ] + }, + "AnalyzeConversationConversationPiiResult": { + "type": "object", + "description": "Result from the personally identifiable information detection and redaction operation performed on a list of conversations.", + "properties": { + "results": { + "$ref": "#/definitions/ConversationPiiResults", + "description": "results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "x-ms-discriminator-value": "conversationalPIIResults" + }, + "AnalyzeConversationJobResult": { + "type": "object", + "description": "Container for results of all tasks in the conversation job.", + "properties": { + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The last updated time in UTC for the task." + }, + "status": { + "$ref": "#/definitions/State", + "description": "The status of the task at the mentioned last update time." + }, + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeConversationResultsKind", + "description": "discriminator kind" + } + }, + "discriminator": "kind", + "required": [ + "lastUpdateDateTime", + "status", + "kind" + ] + }, + "AnalyzeConversationJobState": { + "type": "object", + "description": "Contains the status of the submitted job for analyzing a conversation, along with related statistics.", + "properties": { + "displayName": { + "type": "string", + "description": "display name" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job created" + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job expires" + }, + "jobId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "job ID", + "readOnly": true + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "last updated date and time" + }, + "status": { + "$ref": "#/definitions/State", + "description": "status" + }, + "errors": { + "type": "array", + "description": "errors", + "items": { + "$ref": "#/definitions/Error" + } + }, + "nextLink": { + "type": "string", + "description": "next link" + }, + "tasks": { + "$ref": "#/definitions/Tasks", + "description": "Contains the state for the tasks that are being executed as part of the submitted job for analyzing a conversation." + }, + "statistics": { + "$ref": "#/definitions/ConversationRequestStatistics", + "description": "Contains the statistics for the submitted job." + } + }, + "required": [ + "createdDateTime", + "jobId", + "lastUpdatedDateTime", + "status", + "tasks" + ] + }, + "AnalyzeConversationJobsInput": { + "type": "object", + "description": "It is a wrap up a Question Answering KB response.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for the analysis job." + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageConversationAnalysisInput", + "description": "Analysis Input", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tasks": { + "type": "array", + "description": "Set of tasks to execute on the input conversation.", + "items": { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + }, + "cancelAfter": { + "type": "number", + "format": "float", + "description": "Optional duration in seconds after which the job will be canceled if not completed." + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "AnalyzeConversationLROTask": { + "type": "object", + "description": "Base class for a long-running conversation input task.", + "properties": { + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeConversationLROTaskKind", + "description": "Enumeration of supported analysis tasks on a collection of conversations." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeConversationLROTaskKind": { + "type": "string", + "description": "Enumeration of supported analysis tasks on a collection of conversations.", + "enum": [ + "ConversationalSummarizationTask", + "ConversationalPIITask", + "CustomConversationalSummarizationTask" + ], + "x-ms-enum": { + "name": "AnalyzeConversationLROTaskKind", + "modelAsString": true, + "values": [ + { + "name": "ConversationalSummarizationTask", + "value": "ConversationalSummarizationTask", + "description": "Conversational Summarization Task" + }, + { + "name": "ConversationalPIITask", + "value": "ConversationalPIITask", + "description": "Conversational PII Task" + }, + { + "name": "CustomConversationalSummarizationTask", + "value": "CustomConversationalSummarizationTask", + "description": "Custom Conversational Summarization Task" + } + ] + } + }, + "AnalyzeConversationPiiTask": { + "type": "object", + "description": "Task definition for a PII redaction in conversations.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationPiiTaskParameters", + "description": "parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalPIITask" + }, + "AnalyzeConversationResult": { + "type": "object", + "description": "Represents a conversation analysis response.", + "properties": { + "query": { + "type": "string", + "description": "The conversation utterance given by the caller." + }, + "detectedLanguage": { + "type": "string", + "description": "The system detected language for the query in BCP 47 language representation.." + }, + "prediction": { + "$ref": "#/definitions/BasePrediction", + "description": "The prediction result of a conversation project." + } + }, + "required": [ + "query", + "prediction" + ] + }, + "AnalyzeConversationResultsKind": { + "type": "string", + "description": "Enumeration of results for supported conversation analysis Results.", + "enum": [ + "conversationalSummarizationResults", + "conversationalPIIResults", + "customConversationalSummarizationResults" + ], + "x-ms-enum": { + "name": "AnalyzeConversationResultsKind", + "modelAsString": true, + "values": [ + { + "name": "ConversationalSummarizationResults", + "value": "conversationalSummarizationResults", + "description": "Conversational Summarization Results" + }, + { + "name": "ConversationalPIIResults", + "value": "conversationalPIIResults", + "description": "Conversational PII Results" + }, + { + "name": "CustomConversationalSummarizationResults", + "value": "customConversationalSummarizationResults", + "description": "Custom Conversational Summarization Results" + } + ] + } + }, + "AnalyzeConversationSummarizationResult": { + "type": "object", + "description": "Result for the summarization task on the conversation.", + "properties": { + "results": { + "$ref": "#/definitions/SummaryResult", + "description": "results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "x-ms-discriminator-value": "conversationalSummarizationResults" + }, + "AnalyzeConversationSummarizationTask": { + "type": "object", + "description": "Task definition for conversational summarization.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationSummarizationTaskParameters", + "description": "parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalSummarizationTask" + }, + "AnalyzeConversationTask": { + "type": "object", + "description": "The base class of a conversation input task.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskKind", + "description": "The base class of a conversation input task.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeConversationTaskKind": { + "type": "string", + "description": "Enumeration of supported Conversation tasks.", + "enum": [ + "Conversation", + "ConversationalAI" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Conversation task kind" + }, + { + "name": "ConversationalAI", + "value": "ConversationalAI", + "description": "Conversation task kind" + } + ] + } + }, + "AnalyzeConversationTaskResult": { + "type": "object", + "description": "The base class of a conversation input task result.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskResultsKind", + "description": "The base class of a conversation input task result." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeConversationTaskResultsKind": { + "type": "string", + "description": "Enumeration of supported conversational task results.", + "enum": [ + "ConversationResult", + "ConversationalAIResult" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskResultsKind", + "modelAsString": true, + "values": [ + { + "name": "ConversationResult", + "value": "ConversationResult", + "description": "Conversation result task kind" + }, + { + "name": "ConversationalAIResult", + "value": "ConversationalAIResult", + "description": "Conversation result task kind" + } + ] + } + }, + "AnalyzeCustomConversationSummarizationResult": { + "type": "object", + "description": "Result for the custom summarization task on the conversation.", + "properties": { + "results": { + "$ref": "#/definitions/CustomSummaryResult", + "description": "Custom Summary Result" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "x-ms-discriminator-value": "customConversationalSummarizationResults" + }, + "AnalyzeCustomConversationSummarizationTask": { + "type": "object", + "description": "Task definition for custom conversational summarization.", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomConversationSummarizationTaskParameters", + "description": "parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "CustomConversationalSummarizationTask" + }, + "AnswerSpan": { + "type": "object", + "description": "Answer span object of QnA.", + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Predicted score of answer span, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The answer span offset from the start of answer." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the answer span." + } + } + }, + "AnswersOptions": { + "type": "object", + "description": "Parameters to query a knowledge base.", + "properties": { + "qnaId": { + "type": "integer", + "format": "int32", + "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question." + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "Max number of answers to be returned for the question." + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "description": "Minimum threshold score for answers, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "context": { + "$ref": "#/definitions/KnowledgeBaseAnswerContext", + "description": "Context object with previous QnA's information." + }, + "rankerType": { + "$ref": "#/definitions/RankerKind", + "description": "Type of ranker to be used." + }, + "filters": { + "$ref": "#/definitions/QueryFilters", + "description": "Filter QnAs based on given metadata list and knowledge base sources." + }, + "answerSpanRequest": { + "$ref": "#/definitions/ShortAnswerOptions", + "description": "To configure Answer span prediction feature." + }, + "includeUnstructuredSources": { + "type": "boolean", + "description": "(Optional) Flag to enable Query over Unstructured Sources." + } + } + }, + "AnswersResult": { + "type": "object", + "description": "Represents List of Question Answers.", + "properties": { + "answers": { + "type": "array", + "description": "Represents Answer Result list.", + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswer" + } + } + } + }, + "AreaResolution": { + "type": "object", + "description": "Represents the area entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AreaUnit", + "description": "The area Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "AreaResolution" + }, + "AreaUnit": { + "type": "string", + "description": "The area unit of measurement.", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified area unit" + }, + { + "name": "SquareKilometer", + "value": "SquareKilometer", + "description": "Square kilometer area unit" + }, + { + "name": "SquareHectometer", + "value": "SquareHectometer", + "description": "Square hectometer area unit" + }, + { + "name": "SquareDecameter", + "value": "SquareDecameter", + "description": "Square decameter area unit" + }, + { + "name": "SquareDecimeter", + "value": "SquareDecimeter", + "description": "Square decimeter area unit" + }, + { + "name": "SquareMeter", + "value": "SquareMeter", + "description": "Square meter area unit" + }, + { + "name": "SquareCentimeter", + "value": "SquareCentimeter", + "description": "Square centimeter area unit" + }, + { + "name": "SquareMillimeter", + "value": "SquareMillimeter", + "description": "Square millimeter area unit" + }, + { + "name": "SquareInch", + "value": "SquareInch", + "description": "Square inch area unit" + }, + { + "name": "SquareFoot", + "value": "SquareFoot", + "description": "Square foot area unit" + }, + { + "name": "SquareMile", + "value": "SquareMile", + "description": "Square mile area unit" + }, + { + "name": "SquareYard", + "value": "SquareYard", + "description": "Square yard area unit" + }, + { + "name": "Acre", + "value": "Acre", + "description": "Acre area unit" + } + ] + } + }, + "AudioTiming": { + "type": "object", + "description": "Audio timing information.", + "properties": { + "offset": { + "type": "integer", + "format": "int64", + "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds." + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BaseExtraInformation": { + "type": "object", + "description": "The abstract base object for entity extra information.", + "properties": { + "extraInformationKind": { + "$ref": "#/definitions/ExtraInformationKind", + "description": "The extra information object kind." + } + }, + "discriminator": "extraInformationKind", + "required": [ + "extraInformationKind" + ] + }, + "BasePrediction": { + "type": "object", + "description": "This is the base class of prediction", + "properties": { + "projectKind": { + "$ref": "#/definitions/projectKind", + "description": "The type of the project." + }, + "topIntent": { + "type": "string", + "description": "The intent with the highest score." + } + }, + "discriminator": "projectKind", + "required": [ + "projectKind" + ] + }, + "BaseRedactionPolicy": { + "type": "object", + "description": "The abstract base class for RedactionPolicy.", + "properties": { + "policyKind": { + "type": "string", + "description": "The entity RedactionPolicy object kind.", + "default": "characterMask", + "enum": [ + "noMask", + "characterMask", + "entityMask" + ], + "x-ms-enum": { + "name": "RedactionPolicyKind", + "modelAsString": true, + "values": [ + { + "name": "noMask", + "value": "noMask", + "description": "Do not mask detected entities" + }, + { + "name": "characterMask", + "value": "characterMask", + "description": "Mask detected entities with redaction character" + }, + { + "name": "entityMask", + "value": "entityMask", + "description": "Mask detected entities with entity type" + } + ] + } + } + }, + "discriminator": "policyKind", + "required": [ + "policyKind" + ] + }, + "BaseResolution": { + "type": "object", + "description": "The abstract base class for entity resolutions.", + "properties": { + "resolutionKind": { + "$ref": "#/definitions/ResolutionKind", + "description": "The entity resolution object kind." + } + }, + "discriminator": "resolutionKind", + "required": [ + "resolutionKind" + ] + }, + "BooleanResolution": { + "type": "object", + "description": "A resolution for boolean expressions", + "properties": { + "value": { + "type": "boolean", + "description": "A resolution for boolean expressions" + } + }, + "required": [ + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "BooleanResolution" + }, + "CharacterMaskPolicyType": { + "type": "object", + "description": "Represents the policy of masking with a redaction character", + "properties": { + "redactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "characterMask" + }, + "Conversation": { + "type": "object", + "description": "Complete ordered set of utterances (spoken or written) by one or more speakers to be used for analysis.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the conversation." + }, + "language": { + "type": "string", + "description": "Language of the conversation item in BCP-47 format." + }, + "modality": { + "$ref": "#/definitions/InputModality", + "description": "modality" + }, + "domain": { + "$ref": "#/definitions/ConversationDomain", + "description": "domain" + } + }, + "discriminator": "modality", + "required": [ + "id", + "language", + "modality" + ] + }, + "ConversationAnalysisOptions": { + "type": "object", + "description": "The input ConversationItem and its optional parameters", + "properties": { + "conversationItem": { + "$ref": "#/definitions/TextConversationItem", + "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript)." + } + }, + "required": [ + "conversationItem" + ] + }, + "ConversationCallingOptions": { + "type": "object", + "description": "The option to set to call a Conversation project.", + "properties": { + "language": { + "type": "string", + "description": "The language of the query in BCP 47 language representation." + }, + "verbose": { + "type": "boolean", + "description": "If true, the service will return more detailed information." + }, + "isLoggingEnabled": { + "type": "boolean", + "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality." + } + } + }, + "ConversationDomain": { + "type": "string", + "description": "Enumeration of supported conversational domains.", + "enum": [ + "finance", + "healthcare", + "generic" + ], + "x-ms-enum": { + "name": "ConversationDomain", + "modelAsString": true, + "values": [ + { + "name": "finance", + "value": "finance", + "description": "Enumeration of supported conversational domains." + }, + { + "name": "healthcare", + "value": "healthcare", + "description": "Enumeration of supported conversational domains." + }, + { + "name": "generic", + "value": "generic", + "description": "Enumeration of supported conversational domains." + } + ] + } + }, + "ConversationEntity": { + "type": "object", + "description": "The entity extraction result of a Conversation project.", + "properties": { + "category": { + "type": "string", + "description": "The entity category." + }, + "text": { + "type": "string", + "description": "The predicted entity text." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The starting index of this entity in the query." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the text." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "The entity confidence score." + }, + "resolutions": { + "type": "array", + "description": "The collection of entity resolution objects.", + "items": { + "$ref": "#/definitions/BaseResolution" + } + }, + "extraInformation": { + "type": "array", + "description": "The collection of entity extra information objects.", + "items": { + "$ref": "#/definitions/BaseExtraInformation" + } + } + }, + "required": [ + "category", + "text", + "offset", + "length", + "confidenceScore" + ] + }, + "ConversationIntent": { + "type": "object", + "description": "The intent classification result of a Conversation project.", + "properties": { + "category": { + "type": "string", + "description": "A predicted class." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "The confidence score of the class from 0.0 to 1.0.", + "minimum": 0, + "maximum": 1 + } + }, + "required": [ + "category", + "confidenceScore" + ] + }, + "ConversationItemLevelTiming": { + "type": "object", + "description": "Audio timing at the conversation item level.", + "properties": { + "offset": { + "type": "integer", + "format": "int64", + "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds." + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds." + } + } + }, + "ConversationItemRange": { + "type": "object", + "description": "The ranges of conversation items where this intent was identified.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "The starting index of the intent occurrence within the conversation." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of continuous conversation items for this intent." + } + }, + "required": [ + "offset", + "count" + ] + }, + "ConversationParameters": { + "type": "object", + "description": "This is a set of request parameters for Customized Conversation projects.", + "properties": { + "callingOptions": { + "$ref": "#/definitions/ConversationCallingOptions", + "description": "The option to set to call a Conversation project." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationPiiCategories": { + "type": "string", + "description": "Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.", + "enum": [ + "Address", + "CreditCard", + "Email", + "Person", + "NumericIdentifier", + "Phone", + "USSocialSecurityNumber", + "All", + "Default" + ], + "x-ms-enum": { + "name": "ConversationPiiCategories", + "modelAsString": true, + "values": [ + { + "name": "Address", + "value": "Address", + "description": "Address category" + }, + { + "name": "CreditCard", + "value": "CreditCard", + "description": "Credit card category" + }, + { + "name": "Email", + "value": "Email", + "description": "Email category" + }, + { + "name": "Person", + "value": "Person", + "description": "Person category" + }, + { + "name": "NumericIdentifier", + "value": "NumericIdentifier", + "description": "Numeric identifier category" + }, + { + "name": "Phone", + "value": "Phone", + "description": "Phone category" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US social security number category" + }, + { + "name": "All", + "value": "All", + "description": "All categories" + }, + { + "name": "Default", + "value": "Default", + "description": "Default categories" + } + ] + } + }, + "ConversationPiiCategoriesExclude": { + "type": "string", + "description": "Describes the PII categories to exclude for detection. If not provided, 'default' categories will be returned which will vary with the language.", + "enum": [ + "Address", + "CreditCard", + "Email", + "Person", + "NumericIdentifier", + "Phone", + "USSocialSecurityNumber" + ], + "x-ms-enum": { + "name": "ConversationPiiCategoriesExclude", + "modelAsString": true, + "values": [ + { + "name": "Address", + "value": "Address", + "description": "Address category" + }, + { + "name": "CreditCard", + "value": "CreditCard", + "description": "Credit card category" + }, + { + "name": "Email", + "value": "Email", + "description": "Email category" + }, + { + "name": "Person", + "value": "Person", + "description": "Person category" + }, + { + "name": "NumericIdentifier", + "value": "NumericIdentifier", + "description": "Numeric identifier category" + }, + { + "name": "Phone", + "value": "Phone", + "description": "Phone category" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US social security number category" + } + ] + } + }, + "ConversationPiiItemResult": { + "type": "object", + "description": "The result from PII detection and redaction operation for each conversation.", + "properties": { + "id": { + "type": "string", + "description": "Id of the result" + }, + "redactedContent": { + "$ref": "#/definitions/RedactedTranscriptContent", + "description": "Transcript content response that the service generates, with all necessary personally identifiable information redacted." + }, + "entities": { + "type": "array", + "description": "Array of Entities", + "items": { + "$ref": "#/definitions/Entity" + } + } + }, + "required": [ + "id", + "redactedContent", + "entities" + ] + }, + "ConversationPiiResults": { + "type": "object", + "description": "The result from PII detection and redaction operation for each conversation.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "statistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "conversations": { + "type": "array", + "description": "array of conversations", + "items": { + "$ref": "#/definitions/ConversationalPiiResultWithResultBase" + } + } + }, + "required": [ + "errors", + "modelVersion", + "conversations" + ] + }, + "ConversationPiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a conversational pii task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "piiCategories": { + "type": "array", + "description": "Array of ConversationPIICategories", + "items": { + "$ref": "#/definitions/ConversationPiiCategories" + } + }, + "redactAudioTiming": { + "type": "boolean", + "description": "Flag to indicate if response should include audio stream offset and duration for any detected entities to be redacted. By default, audio timing of redacted entities are not included." + }, + "redactionSource": { + "$ref": "#/definitions/TranscriptContentType", + "description": "For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here." + }, + "redactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } + }, + "excludePiiCategories": { + "type": "array", + "description": "List of categories that need to be excluded instead of included.", + "items": { + "$ref": "#/definitions/ConversationPiiCategoriesExclude" + } + }, + "redactionPolicy": { + "$ref": "#/definitions/BaseRedactionPolicy", + "description": "Optional parameter determine what type of redaction to use." + } + } + }, + "ConversationPrediction": { + "type": "object", + "description": "Represents the prediction section of a Conversation project.", + "properties": { + "intents": { + "type": "array", + "description": "The intent classification results.", + "items": { + "$ref": "#/definitions/ConversationIntent" + } + }, + "entities": { + "type": "array", + "description": "The entity extraction results.", + "items": { + "$ref": "#/definitions/ConversationEntity" + } + } + }, + "required": [ + "intents", + "entities" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationRequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request, this field contains information about the request payload.", + "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." + }, + "conversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of conversations submitted in the request." + }, + "validConversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of conversation documents. This excludes documents that are empty, over the size limit, or in unsupported languages." + }, + "erroneousConversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes documents that are empty, over the size limit, or in unsupported languages." + } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount", + "conversationsCount", + "validConversationsCount", + "erroneousConversationsCount" + ] + }, + "ConversationResult": { + "type": "object", + "description": "The response returned by a Conversation project.", + "properties": { + "query": { + "type": "string", + "description": "The same query given in request." + }, + "detectedLanguage": { + "type": "string", + "description": "The detected language from the query in BCP 47 language representation." + }, + "prediction": { + "$ref": "#/definitions/ConversationPrediction", + "description": "The predicted result for the query." + } + }, + "required": [ + "query" + ] + }, + "ConversationStatistics": { + "type": "object", + "description": "If showStats=true was specified in the request, this field contains information about the conversation payload.", + "properties": { + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of text units for the request." + } + }, + "required": [ + "transactionsCount" + ] + }, + "ConversationSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for pre-build conversational summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "It controls the approximate number of sentences in the output summaries." + }, + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries." + }, + "summaryAspects": { + "type": "array", + "description": "Array of Summary Aspects", + "items": { + "$ref": "#/definitions/SummaryAspect" + } + }, + "instruction": { + "type": "string", + "description": "a text field to allow customers to use natural language to describe their needs for summarization." + } + }, + "required": [ + "summaryAspects" + ] + }, + "ConversationTargetIntentResult": { + "type": "object", + "description": "A wrap up of Conversation project response.", + "properties": { + "result": { + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationTaskParameters": { + "type": "object", + "description": "Input parameters necessary for a Conversation task.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the project to use." + }, + "deploymentName": { + "type": "string", + "description": "The name of the deployment to use." + }, + "verbose": { + "type": "boolean", + "description": "If true, the service will return more detailed information in the response." + }, + "isLoggingEnabled": { + "type": "boolean", + "description": "If true, the service will keep the query for further review." + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "directTarget": { + "type": "string", + "description": "The name of a target project to forward the request to." + }, + "targetProjectParameters": { + "type": "object", + "description": "A dictionary representing the parameters for each target project.", + "additionalProperties": { + "$ref": "#/definitions/AnalysisParameters" + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "ConversationalAIAnalysis": { + "type": "object", + "description": "Multiple multi-turn conversations analyzed.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the conversation." + }, + "intents": { + "type": "array", + "description": "The intent classification results for this conversation.", + "items": { + "$ref": "#/definitions/ConversationalAIIntent" + } + }, + "entities": { + "type": "array", + "description": "Global entities that are matched but not associated with any specific intent.", + "items": { + "$ref": "#/definitions/ConversationalAIEntity" + } + } + }, + "required": [ + "id", + "intents" + ] + }, + "ConversationalAIAnalysisInput": { + "type": "object", + "description": "The input ConversationItem and its optional parameters", + "properties": { + "conversations": { + "type": "array", + "description": "List of multiple conversations", + "items": { + "$ref": "#/definitions/TextConversation" + } + } + }, + "required": [ + "conversations" + ] + }, + "ConversationalAIEntity": { + "type": "object", + "description": "The entity associated with this intent.", + "properties": { + "name": { + "type": "string", + "description": "The entity name or category." + }, + "text": { + "type": "string", + "description": "The detected text of the entity." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "The confidence score of the entity detection (0.0 to 1.0)." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The starting index of the entity in the query." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the detected entity text." + }, + "conversationItemId": { + "type": "string", + "description": "The ID of the conversation item where the entity appears." + }, + "conversationItemIndex": { + "type": "integer", + "format": "int32", + "description": "The index of the conversation item where the entity appears." + }, + "resolutions": { + "type": "array", + "description": "Entity resolution details, if available.", + "items": { + "$ref": "#/definitions/BaseResolution" + } + }, + "extraInformation": { + "type": "array", + "description": "Additional entity metadata.", + "items": { + "$ref": "#/definitions/BaseExtraInformation" + } + } + }, + "required": [ + "name", + "text", + "confidenceScore", + "offset", + "length", + "conversationItemId" + ] + }, + "ConversationalAIInputParameters": { + "type": "object", + "description": "Input parameters base for a Conversation task.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the project to use." + }, + "deploymentName": { + "type": "string", + "description": "The name of the deployment to use." + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "ConversationalAIIntent": { + "type": "object", + "description": "The intent classification result for this conversation.", + "properties": { + "name": { + "type": "string", + "description": "The name of the detected intent." + }, + "type": { + "type": "string", + "description": "The type of intent, either \"action\" or \"question\"." + }, + "conversationItemRanges": { + "type": "array", + "description": "The ranges of conversation items where this intent was identified.", + "items": { + "$ref": "#/definitions/ConversationItemRange" + } + }, + "entities": { + "type": "array", + "description": "The entities associated with this intent.", + "items": { + "$ref": "#/definitions/ConversationalAIEntity" + } + } + }, + "required": [ + "name", + "type", + "conversationItemRanges", + "entities" + ] + }, + "ConversationalAIResult": { + "type": "object", + "description": "Represents the conversational analysis response.", + "properties": { + "conversations": { + "type": "array", + "description": "Multiple multi-turn conversations analyzed.", + "items": { + "$ref": "#/definitions/ConversationalAIAnalysis" + } + }, + "warnings": { + "type": "array", + "description": "Any warnings encountered during processing.", + "items": { + "type": "string" + } + } + }, + "required": [ + "conversations" + ] + }, + "ConversationalAITask": { + "type": "object", + "description": "A conversational AI task.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/ConversationalAIAnalysisInput", + "description": "The input ConversationItem and its optional parameters" + }, + "parameters": { + "$ref": "#/definitions/ConversationalAIInputParameters", + "description": "Input parameters necessary for a Conversation language understanding task." + } + }, + "required": [ + "analysisInput", + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTask" + } + ], + "x-ms-discriminator-value": "ConversationalAI" + }, + "ConversationalAITaskResult": { + "type": "object", + "description": "The results of a ConversationalAI task.", + "properties": { + "result": { + "$ref": "#/definitions/ConversationalAIResult", + "description": "Represents the conversational analysis response." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + ], + "x-ms-discriminator-value": "ConversationalAIResult" + }, + "ConversationalPiiResultWithResultBase": { + "type": "object", + "description": "Conversation PII result item", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty conversation identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered in processing the document.", + "items": { + "$ref": "#/definitions/InputWarning" + } + }, + "statistics": { + "$ref": "#/definitions/ConversationStatistics", + "description": "If showStats=true was specified in the request this field will contain information about the conversation payload." + }, + "conversationItems": { + "type": "array", + "description": "List of conversationItems", + "items": { + "$ref": "#/definitions/ConversationPiiItemResult" + } + } + }, + "required": [ + "id", + "warnings", + "conversationItems" + ] + }, + "ConversationalTask": { + "type": "object", + "description": "The input for a conversation language understanding task.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/ConversationAnalysisOptions", + "description": "The input ConversationItem and its optional parameters" + }, + "parameters": { + "$ref": "#/definitions/ConversationTaskParameters", + "description": "Input parameters necessary for a Conversation language understanding task." + } + }, + "required": [ + "analysisInput", + "parameters" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTask" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "ConversationalTaskResult": { + "type": "object", + "description": "The results of a Conversation task.", + "properties": { + "result": { + "$ref": "#/definitions/AnalyzeConversationResult", + "description": "Represents a conversation analysis response." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + ], + "x-ms-discriminator-value": "ConversationResult" + }, + "ConversationsSummaryResult": { + "type": "object", + "description": "Conversations Summary Result", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty conversation identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered in processing the document.", + "items": { + "$ref": "#/definitions/InputWarning" + } + }, + "statistics": { + "$ref": "#/definitions/ConversationStatistics", + "description": "If showStats=true was specified in the request this field will contain information about the conversation payload." + }, + "summaries": { + "type": "array", + "description": "array of summaries", + "items": { + "$ref": "#/definitions/SummaryResultItem" + } + } + }, + "required": [ + "id", + "warnings", + "summaries" + ] + }, + "CurrencyResolution": { + "type": "object", + "description": "Represents the currency entity resolution model.", + "properties": { + "ISO4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name.", + "x-ms-client-name": "iso4217" + }, + "value": { + "type": "number", + "format": "double", + "description": "The money amount captured in the extracted entity" + }, + "unit": { + "type": "string", + "description": "The unit of the amount captured in the extracted entity" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "CurrencyResolution" + }, + "CustomConversationSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for a custom conversation summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "It controls the approximate number of sentences in the output summaries." + }, + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "Controls the approximate length of the output summaries. Recommended to use summaryLength over sentenceCount" + }, + "summaryAspects": { + "type": "array", + "description": "Array of Summary Aspects", + "items": { + "$ref": "#/definitions/SummaryAspect" + } + } + }, + "required": [ + "projectName", + "deploymentName", + "summaryAspects" + ] + }, + "CustomSummaryResult": { + "type": "object", + "description": "Custom Summary Results", + "properties": { + "conversations": { + "type": "array", + "description": "array of conversations", + "items": { + "$ref": "#/definitions/ConversationsSummaryResult" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "conversations", + "errors", + "projectName", + "deploymentName" + ] + }, + "DateTimeResolution": { + "type": "object", + "description": "A resolution for datetime entity instances.", + "properties": { + "timex": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "dateTimeSubKind": { + "$ref": "#/definitions/DateTimeSubKind", + "description": "The DateTime SubKind" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "An optional modifier of a date/time instance." + } + }, + "required": [ + "timex", + "dateTimeSubKind", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "DateTimeResolution" + }, + "DateTimeSubKind": { + "type": "string", + "description": "The Datetime SubKind.", + "enum": [ + "Time", + "Date", + "DateTime", + "Duration", + "Set" + ], + "x-ms-enum": { + "name": "DateTimeSubKind", + "modelAsString": true, + "values": [ + { + "name": "Time", + "value": "Time", + "description": "Time subkind" + }, + { + "name": "Date", + "value": "Date", + "description": "Date subkind" + }, + { + "name": "DateTime", + "value": "DateTime", + "description": "DateTime subkind" + }, + { + "name": "Duration", + "value": "Duration", + "description": "Duration subkind" + }, + { + "name": "Set", + "value": "Set", + "description": "Set subkind" + } + ] + } + }, + "DocumentError": { + "type": "object", + "description": "Contains details of errors encountered during a job execution.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the input document." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error encountered." + } + }, + "required": [ + "id", + "error" + ] + }, + "Entity": { + "type": "object", + "description": "Text that has been categorized into pre-defined classes or types such as: person, location, event, product, and organization.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "mask": { + "type": "string", + "description": "Exact mask text to mask the PII entity" + }, + "maskOffset": { + "type": "integer", + "format": "int32", + "description": "Offset of the mask text" + }, + "maskLength": { + "type": "integer", + "format": "int32", + "description": "Length of the mask text" + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "EntityMaskTypePolicyType": { + "type": "object", + "description": "Represents the policy of masking PII with the entity type.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "entityMask" + }, + "EntitySubtype": { + "type": "object", + "description": "The concrete entity Subtype model of extra information.", + "properties": { + "value": { + "type": "string", + "description": "The Subtype of an extracted entity type." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags express similarities between entity categories for the extracted entity type.", + "items": { + "$ref": "#/definitions/EntityTag" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "x-ms-discriminator-value": "EntitySubtype" + }, + "EntityTag": { + "type": "object", + "description": "Tags express similarities between entity categories for the extracted entity type.", + "properties": { + "name": { + "type": "string", + "description": "The name of the tag." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "The confidence score of the tag for the extracted entity between 0.0 and 1.0." + } + }, + "required": [ + "name" + ] + }, + "Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument", + "description": "Invalid argument error" + }, + { + "name": "Unauthorized", + "value": "Unauthorized", + "description": "Unauthorized access error" + }, + { + "name": "Forbidden", + "value": "Forbidden", + "description": "Forbidden access error" + }, + { + "name": "NotFound", + "value": "NotFound", + "description": "Not found error" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound", + "description": "Project not found error" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound", + "description": "Operation not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound", + "description": "Azure Cognitive Search index not found error" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests", + "description": "Too many requests error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached", + "description": "Azure Cognitive Search index limit reached error" + }, + { + "name": "InternalServerError", + "value": "InternalServerError", + "description": "Internal server error" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable", + "description": "Service unavailable error" + }, + { + "name": "Timeout", + "value": "Timeout", + "description": "Timeout error" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "Quota exceeded error" + }, + { + "name": "Conflict", + "value": "Conflict", + "description": "Conflict error" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning error" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ExtraInformationKind": { + "type": "string", + "description": "The extra information object kind.", + "enum": [ + "EntitySubtype", + "ListKey", + "RegexKey" + ], + "x-ms-enum": { + "name": "ExtraInformationKind", + "modelAsString": true, + "values": [ + { + "name": "EntitySubtype", + "value": "EntitySubtype", + "description": "Entity subtype extra information kind" + }, + { + "name": "ListKey", + "value": "ListKey", + "description": "List key extra information kind" + }, + { + "name": "RegexKey", + "value": "RegexKey", + "description": "Regex key extra information kind" + } + ] + } + }, + "InformationResolution": { + "type": "object", + "description": "Represents the information (data) entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/InformationUnit", + "description": "The information (data) Unit of measurement." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "InformationResolution" + }, + "InformationUnit": { + "type": "string", + "description": "The information (data) Unit of measurement.", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified information unit" + }, + { + "name": "Bit", + "value": "Bit", + "description": "Bit information unit" + }, + { + "name": "Kilobit", + "value": "Kilobit", + "description": "Kilobit information unit" + }, + { + "name": "Megabit", + "value": "Megabit", + "description": "Megabit information unit" + }, + { + "name": "Gigabit", + "value": "Gigabit", + "description": "Gigabit information unit" + }, + { + "name": "Terabit", + "value": "Terabit", + "description": "Terabit information unit" + }, + { + "name": "Petabit", + "value": "Petabit", + "description": "Petabit information unit" + }, + { + "name": "Byte", + "value": "Byte", + "description": "Byte information unit" + }, + { + "name": "Kilobyte", + "value": "Kilobyte", + "description": "Kilobyte information unit" + }, + { + "name": "Megabyte", + "value": "Megabyte", + "description": "Megabyte information unit" + }, + { + "name": "Gigabyte", + "value": "Gigabyte", + "description": "Gigabyte information unit" + }, + { + "name": "Terabyte", + "value": "Terabyte", + "description": "Terabyte information unit" + }, + { + "name": "Petabyte", + "value": "Petabyte", + "description": "Petabyte information unit" + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue", + "description": "Invalid parameter value error" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound", + "description": "Knowledge base not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure", + "description": "Extraction failure error" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format error" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest", + "description": "Empty request error" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments", + "description": "Missing input documents error" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument", + "description": "Invalid document error" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect", + "description": "Model version incorrect error" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch", + "description": "Invalid document batch error" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code error" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint", + "description": "Invalid country hint error" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "InputModality": { + "type": "string", + "description": "Enumeration of supported conversational modalities.", + "enum": [ + "transcript", + "text" + ], + "x-ms-enum": { + "name": "InputModality", + "modelAsString": true, + "values": [ + { + "name": "transcript", + "value": "transcript", + "description": "Transcript input modality" + }, + { + "name": "text", + "value": "text", + "description": "Text input modality" + } + ] + } + }, + "InputWarning": { + "type": "object", + "description": "Contains details of warnings encountered during a job execution.", + "properties": { + "code": { + "type": "string", + "description": "Warning code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + }, + "required": [ + "code", + "message" + ] + }, + "ItemizedSummaryContext": { + "type": "object", + "description": "Context of the summary with a conversation item ID.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." + }, + "conversationItemId": { + "type": "string", + "description": "Reference to the ID of ConversationItem." + } + }, + "required": [ + "offset", + "length", + "conversationItemId" + ] + }, + "KnowledgeBaseAnswer": { + "type": "object", + "description": "Represents knowledge base answer.", + "properties": { + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer text." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Answer confidence score, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "id": { + "type": "integer", + "format": "int32", + "description": "ID of the QnA result." + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "$ref": "#/definitions/KnowledgeBaseAnswerDialog", + "description": "Dialog associated with Answer." + }, + "answerSpan": { + "$ref": "#/definitions/AnswerSpan", + "description": "Answer span object of QnA with respect to user's question." + } + } + }, + "KnowledgeBaseAnswerContext": { + "type": "object", + "description": "Context object with previous QnA's information.", + "properties": { + "previousQnaId": { + "type": "integer", + "format": "int32", + "description": "Previous turn top answer result QnA ID." + }, + "previousUserQuery": { + "type": "string", + "description": "Previous user query." + } + }, + "required": [ + "previousQnaId" + ] + }, + "KnowledgeBaseAnswerDialog": { + "type": "object", + "description": "Dialog associated with Answer.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" + } + } + } + }, + "KnowledgeBaseAnswerPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "format": "int32", + "description": "Index of the prompt - used in ordering of the prompts." + }, + "qnaId": { + "type": "integer", + "format": "int32", + "description": "QnA ID corresponding to the prompt." + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "LengthResolution": { + "type": "object", + "description": "Represents the length entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/LengthUnit", + "description": "The length Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "LengthResolution" + }, + "LengthUnit": { + "type": "string", + "description": "The length unit of measurement.", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Pt" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified length unit" + }, + { + "name": "Kilometer", + "value": "Kilometer", + "description": "Kilometer length unit" + }, + { + "name": "Hectometer", + "value": "Hectometer", + "description": "Hectometer length unit" + }, + { + "name": "Decameter", + "value": "Decameter", + "description": "Decameter length unit" + }, + { + "name": "Meter", + "value": "Meter", + "description": "Meter length unit" + }, + { + "name": "Decimeter", + "value": "Decimeter", + "description": "Decimeter length unit" + }, + { + "name": "Centimeter", + "value": "Centimeter", + "description": "Centimeter length unit" + }, + { + "name": "Millimeter", + "value": "Millimeter", + "description": "Millimeter length unit" + }, + { + "name": "Micrometer", + "value": "Micrometer", + "description": "Micrometer length unit" + }, + { + "name": "Nanometer", + "value": "Nanometer", + "description": "Nanometer length unit" + }, + { + "name": "Picometer", + "value": "Picometer", + "description": "Picometer length unit" + }, + { + "name": "Mile", + "value": "Mile", + "description": "Mile length unit" + }, + { + "name": "Yard", + "value": "Yard", + "description": "Yard length unit" + }, + { + "name": "Inch", + "value": "Inch", + "description": "Inch length unit" + }, + { + "name": "Foot", + "value": "Foot", + "description": "Foot length unit" + }, + { + "name": "LightYear", + "value": "LightYear", + "description": "Light year length unit" + }, + { + "name": "Pt", + "value": "Pt", + "description": "Point length unit" + } + ] + } + }, + "ListKey": { + "type": "object", + "description": "The list key extra data kind.", + "properties": { + "key": { + "type": "string", + "description": "The canonical form of the extracted entity." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "x-ms-discriminator-value": "ListKey" + }, + "LuisCallingOptions": { + "type": "object", + "description": "This customizes how the service calls LUIS Generally Available projects.", + "properties": { + "verbose": { + "type": "boolean", + "description": "Enable verbose response." + }, + "log": { + "type": "boolean", + "description": "Save log to add in training utterances later." + }, + "show-all-intents": { + "type": "boolean", + "description": "Set true to show all intents." + }, + "timezoneOffset": { + "type": "integer", + "format": "int32", + "description": "The timezone offset for the location of the request." + }, + "spellCheck": { + "type": "boolean", + "description": "Enable spell checking." + }, + "bing-spell-check-subscription-key": { + "type": "string", + "description": "The subscription key to use when enabling Bing spell check" + } + } + }, + "LuisParameters": { + "type": "object", + "description": "This is a set of request parameters for LUIS Generally Available projects.", + "properties": { + "query": { + "type": "string", + "description": "The utterance to predict.", + "maxLength": 500 + }, + "callingOptions": { + "$ref": "#/definitions/LuisCallingOptions", + "description": "This customizes how the service calls LUIS Generally Available projects." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "x-ms-discriminator-value": "Luis" + }, + "LuisResult": { + "type": "object", + "description": "It is the response from a LUIS Generally Available application.", + "additionalProperties": {} + }, + "LuisTargetIntentResult": { + "type": "object", + "description": "It is a wrap up of LUIS Generally Available response.", + "properties": { + "result": { + "$ref": "#/definitions/LuisResult", + "description": "The actual response from a LUIS Generally Available application." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "Luis" + }, + "MetadataFilter": { + "type": "object", + "description": "Find QnAs that are associated with the given list of metadata.", + "properties": { + "metadata": { + "type": "array", + "description": "List of metadata.", + "items": { + "$ref": "#/definitions/MetadataRecord" + } + }, + "logicalOperation": { + "type": "string", + "description": "Operation used to join metadata filters.", + "default": "AND", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true, + "values": [ + { + "name": "AND", + "value": "AND", + "description": "Logical AND" + }, + { + "name": "OR", + "value": "OR", + "description": "Logical OR" + } + ] + } + } + } + }, + "MetadataRecord": { + "type": "object", + "description": "Object to provide the key value pair for each metadata.", + "properties": { + "key": { + "type": "string", + "description": "Metadata Key from Metadata dictionary used in the QnA." + }, + "value": { + "type": "string", + "description": "Metadata Value from Metadata dictionary used in the QnA." + } + }, + "required": [ + "key", + "value" + ] + }, + "MultiLanguageConversationAnalysisInput": { + "type": "object", + "description": "Multi Language Conversation Analysis Input", + "properties": { + "conversations": { + "type": "array", + "description": "Array of conversation items", + "items": { + "$ref": "#/definitions/Conversation" + } + } + }, + "required": [ + "conversations" + ] + }, + "NoMaskPolicyType": { + "type": "object", + "description": "Represents the policy of not masking found PII.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "noMask" + }, + "NoneLinkedTargetIntentResult": { + "type": "object", + "description": "A wrap up of non-linked intent response.", + "properties": { + "result": { + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "NonLinked" + }, + "NumberKind": { + "type": "string", + "description": "The type of the extracted number entity.", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true, + "values": [ + { + "name": "Integer", + "value": "Integer", + "description": "Integer number" + }, + { + "name": "Decimal", + "value": "Decimal", + "description": "Decimal number" + }, + { + "name": "Power", + "value": "Power", + "description": "Power number" + }, + { + "name": "Fraction", + "value": "Fraction", + "description": "Fraction number" + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percent number" + }, + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified number kind" + } + ] + } + }, + "NumberResolution": { + "type": "object", + "description": "A resolution for numeric entity instances.", + "properties": { + "numberKind": { + "$ref": "#/definitions/NumberKind", + "description": "The type of the extracted number entity." + }, + "value": { + "type": "number", + "format": "double", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "NumberResolution" + }, + "NumericRangeResolution": { + "type": "object", + "description": "represents the resolution of numeric intervals.", + "properties": { + "rangeKind": { + "$ref": "#/definitions/RangeKind", + "description": "The kind of range that the resolution object represents." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "NumericRangeResolution" + }, + "OrchestrationPrediction": { + "type": "object", + "description": "This represents the prediction result of an Orchestration project.", + "properties": { + "intents": { + "type": "object", + "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", + "additionalProperties": { + "$ref": "#/definitions/TargetIntentResult" + } + } + }, + "required": [ + "intents" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "x-ms-discriminator-value": "Orchestration" + }, + "OrdinalResolution": { + "type": "object", + "description": "A resolution for ordinal numbers entity instances.", + "properties": { + "offset": { + "type": "string", + "description": "The offset with respect to the reference (e.g., offset = -1 indicates the second to last)" + }, + "relativeTo": { + "$ref": "#/definitions/RelativeTo", + "description": "The reference point that the ordinal number denotes." + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "OrdinalResolution" + }, + "QueryFilters": { + "type": "object", + "description": "filters over knowledge base.", + "properties": { + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter", + "description": "filters over knowledge base." + }, + "sourceFilter": { + "$ref": "#/definitions/SourceFilter", + "description": "filters over knowledge base." + }, + "logicalOperation": { + "type": "string", + "description": "Logical operation used to join metadata filter with source filter.", + "default": "AND", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true, + "values": [ + { + "name": "AND", + "value": "AND", + "description": "Logical AND" + }, + { + "name": "OR", + "value": "OR", + "description": "Logical OR" + } + ] + } + } + } + }, + "QuestionAnsweringParameters": { + "type": "object", + "description": "This is a set of request parameters for Question Answering knowledge bases.", + "properties": { + "callingOptions": { + "$ref": "#/definitions/AnswersOptions", + "description": "The options sent to a Question Answering KB." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "x-ms-discriminator-value": "QuestionAnswering" + }, + "QuestionAnsweringTargetIntentResult": { + "type": "object", + "description": "It is a wrap up a Question Answering KB response.", + "properties": { + "result": { + "$ref": "#/definitions/AnswersResult", + "description": "The generated answer by a Question Answering KB." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "x-ms-discriminator-value": "QuestionAnswering" + }, + "RangeKind": { + "type": "string", + "description": "The kind of range that the resolution object represents.", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true, + "values": [ + { + "name": "Number", + "value": "Number", + "description": "Number range" + }, + { + "name": "Speed", + "value": "Speed", + "description": "Speed range" + }, + { + "name": "Weight", + "value": "Weight", + "description": "Weight range" + }, + { + "name": "Length", + "value": "Length", + "description": "Length range" + }, + { + "name": "Volume", + "value": "Volume", + "description": "Volume range" + }, + { + "name": "Area", + "value": "Area", + "description": "Area range" + }, + { + "name": "Age", + "value": "Age", + "description": "Age range" + }, + { + "name": "Information", + "value": "Information", + "description": "Information range" + }, + { + "name": "Temperature", + "value": "Temperature", + "description": "Temperature range" + }, + { + "name": "Currency", + "value": "Currency", + "description": "Currency range" + } + ] + } + }, + "RankerKind": { + "type": "string", + "description": "Type of ranker to be used", + "enum": [ + "Default", + "QuestionOnly" + ], + "x-ms-enum": { + "name": "RankerKind", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default ranker." + }, + { + "name": "QuestionOnly", + "value": "QuestionOnly", + "description": "Question only ranker." + } + ] + } + }, + "RedactedTranscriptContent": { + "type": "object", + "description": "Transcript content response that the service generates, with all necessary personally identifiable information redacted.", + "properties": { + "itn": { + "type": "string", + "description": "Redacted output for input in inverse-text-normalized format." + }, + "maskedItn": { + "type": "string", + "description": "Redacted output for input in masked inverse-text-normalized format." + }, + "text": { + "type": "string", + "description": "Redacted output for input in text (Microsoft's speech-to-text 'display') format." + }, + "lexical": { + "type": "string", + "description": "Redacted output for input in lexical format." + }, + "audioTimings": { + "type": "array", + "description": "List of redacted audio segments.", + "items": { + "$ref": "#/definitions/AudioTiming" + } + } + } + }, + "RegexKey": { + "type": "object", + "description": "The regex key extra data kind.", + "properties": { + "key": { + "type": "string", + "description": "The key of the regex pattern used in extracting the entity." + }, + "regexPattern": { + "type": "string", + "description": "The .NET regex pattern used in extracting the entity. Please visit https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions for more information about .NET regular expressions." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "x-ms-discriminator-value": "RegexKey" + }, + "RelativeTo": { + "type": "string", + "description": "The reference point that the ordinal number denotes.", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true, + "values": [ + { + "name": "Current", + "value": "Current", + "description": "Current state" + }, + { + "name": "End", + "value": "End", + "description": "End state" + }, + { + "name": "Start", + "value": "Start", + "description": "Start state" + } + ] + } + }, + "RequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the request payload.", + "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." + } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ] + }, + "ResolutionKind": { + "type": "string", + "description": "The entity resolution object kind.", + "enum": [ + "BooleanResolution", + "DateTimeResolution", + "NumberResolution", + "OrdinalResolution", + "SpeedResolution", + "WeightResolution", + "LengthResolution", + "VolumeResolution", + "AreaResolution", + "AgeResolution", + "InformationResolution", + "TemperatureResolution", + "CurrencyResolution", + "NumericRangeResolution", + "TemporalSpanResolution" + ], + "x-ms-enum": { + "name": "ResolutionKind", + "modelAsString": true, + "values": [ + { + "name": "BooleanResolution", + "value": "BooleanResolution", + "description": "Resolution of a boolean entity" + }, + { + "name": "DateTimeResolution", + "value": "DateTimeResolution", + "description": "Resolution of a date/time entity" + }, + { + "name": "NumberResolution", + "value": "NumberResolution", + "description": "Resolution of a number entity" + }, + { + "name": "OrdinalResolution", + "value": "OrdinalResolution", + "description": "Resolution of an ordinal entity" + }, + { + "name": "SpeedResolution", + "value": "SpeedResolution", + "description": "Resolution of a speed entity" + }, + { + "name": "WeightResolution", + "value": "WeightResolution", + "description": "Resolution of a weight entity" + }, + { + "name": "LengthResolution", + "value": "LengthResolution", + "description": "Resolution of a length entity" + }, + { + "name": "VolumeResolution", + "value": "VolumeResolution", + "description": "Resolution of a volume entity" + }, + { + "name": "AreaResolution", + "value": "AreaResolution", + "description": "Resolution of an area entity" + }, + { + "name": "AgeResolution", + "value": "AgeResolution", + "description": "Resolution of an age entity" + }, + { + "name": "InformationResolution", + "value": "InformationResolution", + "description": "Resolution of an information entity" + }, + { + "name": "TemperatureResolution", + "value": "TemperatureResolution", + "description": "Resolution of a temperature entity" + }, + { + "name": "CurrencyResolution", + "value": "CurrencyResolution", + "description": "Resolution of a currency entity" + }, + { + "name": "NumericRangeResolution", + "value": "NumericRangeResolution", + "description": "Resolution of a numeric range entity" + }, + { + "name": "TemporalSpanResolution", + "value": "TemporalSpanResolution", + "description": "Resolution of a temporal span entity" + } + ] + } + }, + "ShortAnswerOptions": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or disable Answer Span prediction.", + "default": true + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", + "minimum": 0, + "maximum": 1 + }, + "topAnswersWithSpan": { + "type": "integer", + "format": "int32", + "description": "Number of Top answers to be considered for span prediction from 1 to 10.", + "minimum": 1, + "maximum": 10 + } + } + }, + "SourceFilter": { + "type": "array", + "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", + "items": { + "type": "string" + } + }, + "SpeedResolution": { + "type": "object", + "description": "Represents the speed entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/SpeedUnit", + "description": "The speed Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "SpeedResolution" + }, + "SpeedUnit": { + "type": "string", + "description": "The speed Unit of measurement", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knot", + "FootPerSecond", + "FootPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified speed unit" + }, + { + "name": "MetersPerSecond", + "value": "MetersPerSecond", + "description": "Meters per second speed unit" + }, + { + "name": "KilometersPerHour", + "value": "KilometersPerHour", + "description": "Kilometers per hour speed unit" + }, + { + "name": "KilometersPerMinute", + "value": "KilometersPerMinute", + "description": "Kilometers per minute speed unit" + }, + { + "name": "KilometersPerSecond", + "value": "KilometersPerSecond", + "description": "Kilometers per second speed unit" + }, + { + "name": "MilesPerHour", + "value": "MilesPerHour", + "description": "Miles per hour speed unit" + }, + { + "name": "Knot", + "value": "Knot", + "description": "Knot speed unit" + }, + { + "name": "FootPerSecond", + "value": "FootPerSecond", + "description": "Foot per second speed unit" + }, + { + "name": "FootPerMinute", + "value": "FootPerMinute", + "description": "Foot per minute speed unit" + }, + { + "name": "YardsPerMinute", + "value": "YardsPerMinute", + "description": "Yards per minute speed unit" + }, + { + "name": "YardsPerSecond", + "value": "YardsPerSecond", + "description": "Yards per second speed unit" + }, + { + "name": "MetersPerMillisecond", + "value": "MetersPerMillisecond", + "description": "Meters per millisecond speed unit" + }, + { + "name": "CentimetersPerMillisecond", + "value": "CentimetersPerMillisecond", + "description": "Centimeters per millisecond speed unit" + }, + { + "name": "KilometersPerMillisecond", + "value": "KilometersPerMillisecond", + "description": "Kilometers per millisecond speed unit" + } + ] + } + }, + "State": { + "type": "string", + "description": "The status of the task at the mentioned last update time.", + "enum": [ + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted", + "description": "Not started state" + }, + { + "name": "running", + "value": "running", + "description": "Running state" + }, + { + "name": "succeeded", + "value": "succeeded", + "description": "Succeeded state" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted", + "description": "Partially completed state" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed state" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Cancelled state" + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Cancelling state" + } + ] + } + }, + "SummaryAspect": { + "type": "string", + "description": "Supported parameters for a conversational summarization task.", + "enum": [ + "issue", + "resolution", + "chapterTitle", + "narrative", + "recap", + "follow-up tasks" + ], + "x-ms-enum": { + "name": "SummaryAspect", + "modelAsString": true, + "values": [ + { + "name": "issue", + "value": "issue", + "description": "Summary of issues in transcripts of web chats and service calls between customer-service agents and customers." + }, + { + "name": "resolution", + "value": "resolution", + "description": "Summary of resolutions in transcripts of web chats and service calls between customer-service agents and customers." + }, + { + "name": "chapterTitle", + "value": "chapterTitle", + "description": "Chapter title of any conversation. It's usually one phrase or several phrases naturally combined. Long conversations tend to have more chapters. You can find the chapter boundary from the summary context." + }, + { + "name": "narrative", + "value": "narrative", + "description": "Generic narrative summary of any conversation. It generally converts the conversational language into formal written language, compresses the text length, and keeps the salient information." + }, + { + "name": "recap", + "value": "recap", + "description": "A concise one-paragraph summary to provide a quick overview." + }, + { + "name": "followUpTasks", + "value": "follow-up tasks", + "description": "Action items and tasks that arose during a meeting." + } + ] + } + }, + "SummaryLengthBucket": { + "type": "string", + "description": "Enum that defines the length of the output summaries.", + "enum": [ + "short", + "medium", + "long" + ], + "x-ms-enum": { + "name": "SummaryLengthBucket", + "modelAsString": true, + "values": [ + { + "name": "short", + "value": "short", + "description": "Instructs model to generate shorter length summaries." + }, + { + "name": "medium", + "value": "medium", + "description": "Instructs model to generate medium length summaries." + }, + { + "name": "long", + "value": "long", + "description": "Instructs model to generate longer length summaries." + } + ] + } + }, + "SummaryResult": { + "type": "object", + "description": "Summary Results", + "properties": { + "conversations": { + "type": "array", + "description": "array of conversations", + "items": { + "$ref": "#/definitions/ConversationsSummaryResult" + } + }, + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "statistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + }, + "required": [ + "conversations", + "errors", + "modelVersion" + ] + }, + "SummaryResultItem": { + "type": "object", + "description": "Summary Result Item", + "properties": { + "aspect": { + "type": "string", + "description": "aspect" + }, + "text": { + "type": "string", + "description": "text" + }, + "contexts": { + "type": "array", + "description": "Context list of the summary.", + "items": { + "$ref": "#/definitions/ItemizedSummaryContext" + } + } + }, + "required": [ + "aspect", + "text" + ] + }, + "TargetIntentResult": { + "type": "object", + "description": "This is the base class of an intent prediction", + "properties": { + "targetProjectKind": { + "$ref": "#/definitions/targetProjectKind", + "description": "This is the base class of an intent prediction" + }, + "apiVersion": { + "type": "string", + "description": "The API version used to call a target service." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "The prediction score and it ranges from 0.0 to 1.0.", + "minimum": 0, + "maximum": 1 + } + }, + "discriminator": "targetProjectKind", + "required": [ + "targetProjectKind", + "confidenceScore" + ] + }, + "Tasks": { + "type": "object", + "description": "Contains the state for the tasks that are being executed as part of the submitted job for analyzing a conversation.", + "properties": { + "completed": { + "type": "integer", + "format": "int32", + "description": "Count of tasks that finished successfully." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "Count of tasks that failed." + }, + "inProgress": { + "type": "integer", + "format": "int32", + "description": "Count of tasks that are currently in progress." + }, + "total": { + "type": "integer", + "format": "int32", + "description": "Total count of tasks submitted as part of the job." + }, + "items": { + "type": "array", + "description": "List of results from tasks (if available).", + "items": { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + } + }, + "required": [ + "completed", + "failed", + "inProgress", + "total" + ] + }, + "TemperatureResolution": { + "type": "object", + "description": "Represents the temperature entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/TemperatureUnit", + "description": "The temperature Unit of measurement." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "TemperatureResolution" + }, + "TemperatureUnit": { + "type": "string", + "description": "The temperature Unit of measurement.", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified temperature unit" + }, + { + "name": "Fahrenheit", + "value": "Fahrenheit", + "description": "Fahrenheit temperature unit" + }, + { + "name": "Kelvin", + "value": "Kelvin", + "description": "Kelvin temperature unit" + }, + { + "name": "Rankine", + "value": "Rankine", + "description": "Rankine temperature unit" + }, + { + "name": "Celsius", + "value": "Celsius", + "description": "Celsius temperature unit" + } + ] + } + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true, + "values": [ + { + "name": "AfterApprox", + "value": "AfterApprox", + "description": "AfterApprox temporal modifier" + }, + { + "name": "Before", + "value": "Before", + "description": "Before temporal modifier" + }, + { + "name": "BeforeStart", + "value": "BeforeStart", + "description": "BeforeStart temporal modifier" + }, + { + "name": "Approx", + "value": "Approx", + "description": "Approx temporal modifier" + }, + { + "name": "ReferenceUndefined", + "value": "ReferenceUndefined", + "description": "ReferenceUndefined temporal modifier" + }, + { + "name": "SinceEnd", + "value": "SinceEnd", + "description": "SinceEnd temporal modifier" + }, + { + "name": "AfterMid", + "value": "AfterMid", + "description": "AfterMid temporal modifier" + }, + { + "name": "Start", + "value": "Start", + "description": "Start temporal modifier" + }, + { + "name": "After", + "value": "After", + "description": "After temporal modifier" + }, + { + "name": "BeforeEnd", + "value": "BeforeEnd", + "description": "BeforeEnd temporal modifier" + }, + { + "name": "Until", + "value": "Until", + "description": "Until temporal modifier" + }, + { + "name": "End", + "value": "End", + "description": "End temporal modifier" + }, + { + "name": "Less", + "value": "Less", + "description": "Less temporal modifier" + }, + { + "name": "Since", + "value": "Since", + "description": "Since temporal modifier" + }, + { + "name": "AfterStart", + "value": "AfterStart", + "description": "AfterStart temporal modifier" + }, + { + "name": "BeforeApprox", + "value": "BeforeApprox", + "description": "BeforeApprox temporal modifier" + }, + { + "name": "Mid", + "value": "Mid", + "description": "Mid temporal modifier" + }, + { + "name": "More", + "value": "More", + "description": "More temporal modifier" + } + ] + } + }, + "TemporalSpanResolution": { + "type": "object", + "description": "represents the resolution of a date and/or time span.", + "properties": { + "begin": { + "type": "string", + "description": "represents the resolution of a date and/or time span. An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "end": { + "type": "string", + "description": "represents the resolution of a date and/or time span. An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "An optional modifier of a date/time instance." + }, + "timex": { + "type": "string", + "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "TemporalSpanResolution" + }, + "TextConversation": { + "type": "object", + "description": "model for text conversation", + "properties": { + "conversationItems": { + "type": "array", + "description": "Ordered list of text conversation items in the conversation.", + "items": { + "$ref": "#/definitions/TextConversationItem" + } + } + }, + "required": [ + "conversationItems" + ], + "allOf": [ + { + "$ref": "#/definitions/Conversation" + } + ], + "x-ms-discriminator-value": "text" + }, + "TextConversationItem": { + "type": "object", + "description": "The text modality of an input conversation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of a conversation item." + }, + "participantId": { + "type": "string", + "description": "The participant ID of a conversation item." + }, + "language": { + "type": "string", + "description": "The override language of a conversation item in BCP 47 language representation." + }, + "modality": { + "$ref": "#/definitions/InputModality", + "description": "Enumeration of supported conversational modalities." + }, + "role": { + "$ref": "#/definitions/role", + "description": "Role of the participant." + }, + "text": { + "type": "string", + "description": "The text input" + } + }, + "required": [ + "id", + "participantId", + "text" + ] + }, + "TranscriptContentType": { + "type": "string", + "description": "Enumeration of supported transcript content types.", + "enum": [ + "lexical", + "itn", + "maskedItn", + "text" + ], + "x-ms-enum": { + "name": "TranscriptContentType", + "modelAsString": true, + "values": [ + { + "name": "lexical", + "value": "lexical", + "description": "Lexical content type" + }, + { + "name": "itn", + "value": "itn", + "description": "ITN content type" + }, + { + "name": "maskedItn", + "value": "maskedItn", + "description": "Masked ITN content type" + }, + { + "name": "text", + "value": "text", + "description": "Text content type" + } + ] + } + }, + "TranscriptConversation": { + "type": "object", + "description": "model for transcript conversation", + "properties": { + "conversationItems": { + "type": "array", + "description": "Ordered list of transcript conversation items in the conversation.", + "items": { + "$ref": "#/definitions/TranscriptConversationItem" + } + } + }, + "required": [ + "conversationItems" + ], + "allOf": [ + { + "$ref": "#/definitions/Conversation" + } + ], + "x-ms-discriminator-value": "transcript" + }, + "TranscriptConversationItem": { + "type": "object", + "description": "Additional properties for supporting transcript conversation.", + "properties": { + "id": { + "type": "string", + "description": "The ID of a conversation item." + }, + "participantId": { + "type": "string", + "description": "The participant ID of a conversation item." + }, + "language": { + "type": "string", + "description": "The override language of a conversation item in BCP 47 language representation." + }, + "modality": { + "$ref": "#/definitions/InputModality", + "description": "Enumeration of supported conversational modalities." + }, + "role": { + "$ref": "#/definitions/role", + "description": "Role of the participant." + }, + "itn": { + "type": "string", + "description": "Inverse text normalization (ITN) representation of input. The inverse-text-normalized form is the recognized text from Microsoft's speech-to-text API, with phone numbers, numbers, abbreviations, and other transformations applied." + }, + "maskedItn": { + "type": "string", + "description": "Inverse-text-normalized format with profanity masking applied." + }, + "text": { + "type": "string", + "description": "Display form of the recognized text from the speech-to-text API, with punctuation and capitalization added." + }, + "lexical": { + "type": "string", + "description": "Lexical form of the recognized text from the speech-to-text API, with the actual words recognized." + }, + "wordLevelTimings": { + "type": "array", + "description": "List of word-level audio timing information.", + "items": { + "$ref": "#/definitions/WordLevelTiming" + } + }, + "conversationItemLevelTiming": { + "$ref": "#/definitions/ConversationItemLevelTiming", + "description": "Audio timing at the conversation item level. This still can help with AI quality if word-level audio timings are not available." + } + }, + "required": [ + "id", + "participantId", + "itn", + "maskedItn", + "text", + "lexical" + ] + }, + "VolumeResolution": { + "type": "object", + "description": "Represents the volume entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/VolumeUnit", + "description": "The Volume Unit of measurement" + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "VolumeResolution" + }, + "VolumeUnit": { + "type": "string", + "description": "The Volume Unit of measurement", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified volume unit." + }, + { + "name": "CubicMeter", + "value": "CubicMeter", + "description": "Volume unit in cubic meters." + }, + { + "name": "CubicCentimeter", + "value": "CubicCentimeter", + "description": "Volume unit in cubic centimeters." + }, + { + "name": "CubicMillimeter", + "value": "CubicMillimeter", + "description": "Volume unit in cubic millimeters." + }, + { + "name": "Hectoliter", + "value": "Hectoliter", + "description": "Volume unit in hectoliters." + }, + { + "name": "Decaliter", + "value": "Decaliter", + "description": "Volume unit in decaliters." + }, + { + "name": "Liter", + "value": "Liter", + "description": "Volume unit in liters." + }, + { + "name": "Centiliter", + "value": "Centiliter", + "description": "Volume unit in centiliters." + }, + { + "name": "Milliliter", + "value": "Milliliter", + "description": "Volume unit in milliliters." + }, + { + "name": "CubicYard", + "value": "CubicYard", + "description": "Volume unit in cubic yards." + }, + { + "name": "CubicInch", + "value": "CubicInch", + "description": "Volume unit in cubic inches." + }, + { + "name": "CubicFoot", + "value": "CubicFoot", + "description": "Volume unit in cubic feet." + }, + { + "name": "CubicMile", + "value": "CubicMile", + "description": "Volume unit in cubic miles." + }, + { + "name": "FluidOunce", + "value": "FluidOunce", + "description": "Volume unit in fluid ounces." + }, + { + "name": "Teaspoon", + "value": "Teaspoon", + "description": "Volume unit in teaspoons." + }, + { + "name": "Tablespoon", + "value": "Tablespoon", + "description": "Volume unit in tablespoons." + }, + { + "name": "Pint", + "value": "Pint", + "description": "Volume unit in pints." + }, + { + "name": "Quart", + "value": "Quart", + "description": "Volume unit in quarts." + }, + { + "name": "Cup", + "value": "Cup", + "description": "Volume unit in cups." + }, + { + "name": "Gill", + "value": "Gill", + "description": "Volume unit in gills." + }, + { + "name": "Pinch", + "value": "Pinch", + "description": "Volume unit in pinches." + }, + { + "name": "FluidDram", + "value": "FluidDram", + "description": "Volume unit in fluid drams." + }, + { + "name": "Barrel", + "value": "Barrel", + "description": "Volume unit in barrels." + }, + { + "name": "Minim", + "value": "Minim", + "description": "Volume unit in minims." + }, + { + "name": "Cord", + "value": "Cord", + "description": "Volume unit in cords." + }, + { + "name": "Peck", + "value": "Peck", + "description": "Volume unit in pecks." + }, + { + "name": "Bushel", + "value": "Bushel", + "description": "Volume unit in bushels." + }, + { + "name": "Hogshead", + "value": "Hogshead", + "description": "Volume unit in hogsheads." + } + ] + } + }, + "WeightResolution": { + "type": "object", + "description": "Represents the weight entity resolution model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/WeightUnit", + "description": "The weight Unit of measurement." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "x-ms-discriminator-value": "WeightResolution" + }, + "WeightUnit": { + "type": "string", + "description": "The weight Unit of measurement.", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified weight unit" + }, + { + "name": "Kilogram", + "value": "Kilogram", + "description": "Weight unit in kilograms" + }, + { + "name": "Gram", + "value": "Gram", + "description": "Weight unit in grams" + }, + { + "name": "Milligram", + "value": "Milligram", + "description": "Weight unit in milligrams" + }, + { + "name": "Gallon", + "value": "Gallon", + "description": "Volume unit in gallons" + }, + { + "name": "MetricTon", + "value": "MetricTon", + "description": "Weight unit in metric tons" + }, + { + "name": "Ton", + "value": "Ton", + "description": "Weight unit in tons" + }, + { + "name": "Pound", + "value": "Pound", + "description": "Weight unit in pounds" + }, + { + "name": "Ounce", + "value": "Ounce", + "description": "Weight unit in ounces" + }, + { + "name": "Grain", + "value": "Grain", + "description": "Weight unit in grains" + }, + { + "name": "PennyWeight", + "value": "PennyWeight", + "description": "Weight unit in pennyweights" + }, + { + "name": "LongTonBritish", + "value": "LongTonBritish", + "description": "Weight unit in long tons (British)" + }, + { + "name": "ShortTonUS", + "value": "ShortTonUS", + "description": "Weight unit in short tons (US)" + }, + { + "name": "ShortHundredWeightUS", + "value": "ShortHundredWeightUS", + "description": "Weight unit in short hundredweights (US)" + }, + { + "name": "Stone", + "value": "Stone", + "description": "Weight unit in stones" + }, + { + "name": "Dram", + "value": "Dram", + "description": "Weight unit in drams" + } + ] + } + }, + "WordLevelTiming": { + "type": "object", + "description": "Word-level timing information that the speech-to-text API generates. The words in this object should have 1:1 correspondence with the lexical input to allow for audio redaction.", + "properties": { + "offset": { + "type": "integer", + "format": "int64", + "description": "Offset from the start of speech audio, in ticks. 1 tick = 100 nanoseconds." + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Duration of word articulation, in ticks. 1 tick = 100 nanoseconds." + }, + "word": { + "type": "string", + "description": "Recognized word." + } + } + }, + "projectKind": { + "type": "string", + "description": "The type of the project.", + "enum": [ + "Conversation", + "Orchestration", + "ConversationalAI" + ], + "x-ms-enum": { + "name": "projectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Conversation type" + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "Orchestration type" + }, + { + "name": "ConversationalAI", + "value": "ConversationalAI", + "description": "Conversation type" + } + ] + } + }, + "role": { + "type": "string", + "description": "Role of the participant.", + "enum": [ + "customer", + "agent", + "generic" + ], + "x-ms-enum": { + "name": "role", + "modelAsString": true, + "values": [ + { + "name": "customer", + "value": "customer", + "description": "The participant is a customer." + }, + { + "name": "agent", + "value": "agent", + "description": "The participant is an agent." + }, + { + "name": "generic", + "value": "generic", + "description": "The is a generic participant." + } + ] + } + }, + "targetProjectKind": { + "type": "string", + "description": "The type of a target service.", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering", + "NonLinked" + ], + "x-ms-enum": { + "name": "targetProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Luis", + "value": "Luis", + "description": "Luis target service type" + }, + { + "name": "Conversation", + "value": "Conversation", + "description": "Conversation target service type" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering", + "description": "QuestionAnswering target service type" + }, + { + "name": "NonLinked", + "value": "NonLinked", + "description": "NonLinked target service type" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationalAITask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationalAITask.json new file mode 100644 index 000000000000..4dc47676d868 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationalAITask.json @@ -0,0 +1,228 @@ +{ + "operationId": "AnalyzeConversations", + "title": "SuccessfulAnalyzeConversationalAITask", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2025-05-15-preview", + "body": { + "kind": "ConversationalAI", + "parameters": { + "projectName": "project1", + "deploymentName": "deployment1", + "stringIndexType": "Utf16CodeUnit" + }, + "analysisInput": { + "conversations": [ + { + "id": "order", + "language": "en", + "modality": "text", + "conversationItems": [ + { + "participantId": "user", + "id": "1", + "text": "Hi!" + }, + { + "participantId": "bot", + "id": "2", + "text": "Hello, how can I help you?" + }, + { + "participantId": "user", + "id": "3", + "text": "I would like to book a flight from Paris to Berlin on Oct 10th." + }, + { + "participantId": "bot", + "id": "4", + "text": "Do you have any airline preference?" + }, + { + "participantId": "user", + "id": "5", + "text": "No." + }, + { + "participantId": "user", + "id": "6", + "text": "I like New York and Boston." + }, + { + "participantId": "user", + "id": "7", + "text": "Actualy, change the destination to New York." + }, + { + "participantId": "user", + "id": "8", + "text": "Wait, I do not like the food in New York." + }, + { + "participantId": "user", + "id": "9", + "text": "Ok, change the destination back to Berlin." + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationalAIResult", + "result": { + "conversations": [ + { + "id": "OrderAndQuestion", + "intents": [ + { + "type": "action", + "name": "BookFlight", + "conversationItemRanges": [ + { + "offset": 2, + "count": 3 + }, + { + "offset": 6, + "count": 1 + }, + { + "offset": 8, + "count": 1 + } + ], + "entities": [ + { + "name": "Source", + "text": "Paris", + "confidenceScore": 0.8, + "offset": 35, + "length": 5, + "conversationItemIndex": 2, + "conversationItemId": "3" + }, + { + "name": "Geography.Location", + "text": "Berlin", + "confidenceScore": 0.8, + "offset": 35, + "length": 6, + "conversationItemIndex": 8, + "conversationItemId": "9", + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "geography.location", + "tags": [ + { + "name": "City", + "confidenceScore": 1 + }, + { + "name": "GPE", + "confidenceScore": 1 + }, + { + "name": "Location", + "confidenceScore": 1 + } + ] + } + ] + }, + { + "name": "Geography.Location", + "text": "New York", + "confidenceScore": 0.8, + "offset": 32, + "length": 8, + "conversationItemIndex": 6, + "conversationItemId": "7", + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "geography.location", + "tags": [ + { + "name": "City", + "confidenceScore": 1 + }, + { + "name": "GPE", + "confidenceScore": 1 + }, + { + "name": "Location", + "confidenceScore": 1 + } + ] + } + ] + }, + { + "name": "DateTime", + "text": "Oct 10th", + "confidenceScore": 0.8, + "offset": 54, + "length": 8, + "conversationItemIndex": 2, + "conversationItemId": "3", + "resolutions": [ + { + "resolutionKind": "DateTimeResolution", + "dateTimeSubKind": "Date", + "timex": "XXXX-10-10", + "value": "2024-10-10" + }, + { + "resolutionKind": "DateTimeResolution", + "dateTimeSubKind": "Date", + "timex": "XXXX-10-10", + "value": "2025-10-10" + } + ], + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "datetime.date", + "tags": [ + { + "name": "Date", + "confidenceScore": 1 + }, + { + "name": "Temporal", + "confidenceScore": 1 + } + ] + } + ] + } + ] + } + ], + "entities": [ + { + "name": "Geography.Location", + "text": "Boston", + "confidenceScore": 0.8, + "offset": 20, + "length": 8, + "conversationItemId": "6" + } + ] + } + ], + "warnings": [] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversations.json new file mode 100644 index 000000000000..ec8f107f4282 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversations.json @@ -0,0 +1,120 @@ +{ + "operationId": "AnalyzeConversations", + "title": "SuccessfulAnalyzeConversations", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2025-05-15-preview", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "id": "1", + "participantId": "1", + "text": "Book a flight to Seattle on Oct 10th" + } + }, + "parameters": { + "projectName": "{project-name}", + "deploymentName": "{deployment-name}", + "stringIndexType": "TextElement_V8" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "Book a flight to Seattle on Oct 10th", + "prediction": { + "topIntent": "BookFlight", + "projectKind": "Conversation", + "intents": [ + { + "category": "None", + "confidenceScore": 1 + }, + { + "category": "BookTrain", + "confidenceScore": 0 + }, + { + "category": "BookFlight", + "confidenceScore": 0 + } + ], + "entities": [ + { + "category": "Geography.Location", + "text": "seattle", + "offset": 17, + "length": 7, + "confidenceScore": 1, + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "geography.location", + "tags": [ + { + "name": "City", + "confidenceScore": 1 + }, + { + "name": "GPE", + "confidenceScore": 1 + }, + { + "name": "Location", + "confidenceScore": 1 + } + ] + } + ] + }, + { + "category": "DateTime", + "text": "oct 10th", + "offset": 28, + "length": 8, + "confidenceScore": 1, + "resolutions": [ + { + "resolutionKind": "DateTimeResolution", + "dateTimeSubKind": "Date", + "timex": "XXXX-10-10", + "value": "2023-10-10" + }, + { + "resolutionKind": "DateTimeResolution", + "dateTimeSubKind": "Date", + "timex": "XXXX-10-10", + "value": "2024-10-10" + } + ], + "extraInformation": [ + { + "extraInformationKind": "EntitySubtype", + "value": "datetime.date", + "tags": [ + { + "name": "Date", + "confidenceScore": 1 + }, + { + "name": "Temporal", + "confidenceScore": 1 + } + ] + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitration.json new file mode 100644 index 000000000000..b9fb0b63a9eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitration.json @@ -0,0 +1,76 @@ +{ + "operationId": "AnalyzeConversations", + "title": "SuccessfulAnalyzeConversationsArbitration", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2025-05-15-preview", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "participantId": "1", + "id": "1", + "modality": "text", + "language": "en-GB", + "text": "How do I integrate QnA Maker and LUIS?" + } + }, + "parameters": { + "projectName": "{project-name}", + "deploymentName": "{deployment-name}", + "verbose": true, + "isLoggingEnabled": false, + "stringIndexType": "TextElement_V8" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "trains from London", + "prediction": { + "topIntent": "Rail", + "projectKind": "Orchestration", + "intents": { + "Rail": { + "confidenceScore": 1, + "targetProjectKind": "Conversation", + "result": { + "query": "trains from London", + "prediction": { + "topIntent": "Timetable", + "projectKind": "Conversation", + "intents": [ + { + "category": "Timetable", + "confidenceScore": 0.99968535 + }, + { + "category": "Locomotive", + "confidenceScore": 0.000314623 + } + ], + "entities": [] + } + } + }, + "Tree": { + "confidenceScore": 0.2641529, + "targetProjectKind": "QuestionAnswering" + }, + "None": { + "confidenceScore": 0, + "targetProjectKind": "NonLinked" + } + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json new file mode 100644 index 000000000000..9e30bda0712e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json @@ -0,0 +1,77 @@ +{ + "operationId": "AnalyzeConversations", + "title": "SuccessfulAnalyzeConversationsArbitrationDirectTarget", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2025-05-15-preview", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "text": "Ports and connectors", + "participantId": "1", + "id": "1" + } + }, + "parameters": { + "projectName": "prj1", + "deploymentName": "dep1", + "directTarget": "qnaProject", + "targetProjectParameters": { + "qnaProject": { + "targetProjectKind": "QuestionAnswering", + "callingOptions": { + "context": { + "previousUserQuery": "Meet Surface Pro 4", + "previousQnaId": 4 + }, + "top": 1, + "question": "App Service overview" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "Ports and connectors", + "prediction": { + "projectKind": "Orchestration", + "topIntent": "qnaTargetApp", + "intents": { + "qnaTargetApp": { + "targetProjectKind": "QuestionAnswering", + "confidenceScore": 1, + "result": { + "answers": [ + { + "questions": [ + "App Service overview" + ], + "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", + "confidenceScore": 0.7384000000000001, + "id": 1, + "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", + "metadata": {}, + "dialog": { + "isContextOnly": false, + "prompts": [] + } + } + ] + } + } + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json new file mode 100644 index 000000000000..034f13022014 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulAnalyzeConversationsJobsCancelRequest.json @@ -0,0 +1,17 @@ +{ + "operationId": "AnalyzeConversationsCancelJob", + "title": "SuccessfulAnalyzeConversationsJobsCancelRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMask.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMask.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMask.json index d7cb037984ad..af9a1c6b1257 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMask.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMask.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIICharacterMask", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -73,7 +73,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json index 14ac4c6fb1d3..78aa5de34778 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIICharacterMaskTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIICharacterMaskTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMask.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMask.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMask.json index 8089b3ad3d5c..da90a5955322 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMask.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMask.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIEntityMask", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -72,7 +72,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json index 273289f3b259..6fd2102512ac 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIEntityMaskTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIIEntityMaskTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionSubmit.json new file mode 100644 index 000000000000..a6b20a7f8e66 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionSubmit.json @@ -0,0 +1,76 @@ +{ + "operationId": "AnalyzeConversationsSubmitJob", + "title": "SuccessfulConversationPIIExclusionSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redacting PII data from transcribed audio", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "domain": "generic", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "Good morning John Doe.", + "itn": "good morning john doe", + "maskedItn": "good morning john doe", + "lexical": "good morning john doe", + "wordLevelTimings": [ + { + "word": "good", + "offset": 390000, + "duration": 2700000 + }, + { + "word": "morning", + "offset": 4500000, + "duration": 920000 + }, + { + "word": "john", + "offset": 590000, + "duration": 2700000 + }, + { + "word": "doe", + "offset": 6300000, + "duration": 920000 + } + ] + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation PII", + "kind": "ConversationalPIITask", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "Person" + ], + "redactionSource": "lexical", + "redactAudioTiming": true + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json new file mode 100644 index 000000000000..81405c0d194d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIExclusionTaskStatusRequest.json @@ -0,0 +1,68 @@ +{ + "operationId": "AnalyzeConversationsJobStatus", + "title": "SuccessfulConversationPIIExclusionTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Redacting PII from transcribed audio", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "conversationalPIIResults", + "taskName": "Conversation PII", + "lastUpdateDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "redactedContent": { + "text": "Good morning *************.", + "itn": "good morning *************", + "maskedItn": "good morning *************", + "lexical": "good morning *************", + "audioTimings": [ + { + "offset": 590000, + "duration": 920000 + } + ] + }, + "entities": [] + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2022-05-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMask.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMask.json similarity index 95% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMask.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMask.json index 427d6196183d..6c30cd64723d 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMask.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMask.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIINoMask", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "{Job ID}", "body": { @@ -72,7 +72,7 @@ "responses": { "202": { "headers": { - "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2024-11-15-preview" + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" } } } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMaskTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json similarity index 98% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMaskTaskStatusRequest.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json index fe157ff95d5a..3581d0fc989c 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/examples/2024-11-15-preview/SuccessfulConversationPIINoMaskTaskStatusRequest.json +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIINoMaskTaskStatusRequest.json @@ -3,7 +3,7 @@ "title": "SuccessfulConversationPIINoMaskTaskStatusRequest", "parameters": { "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2024-11-15-preview", + "api-version": "2025-05-15-preview", "Endpoint": "{Endpoint}", "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" }, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharSubmit.json new file mode 100644 index 000000000000..0e2d09c1806c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharSubmit.json @@ -0,0 +1,77 @@ +{ + "operationId": "AnalyzeConversationsSubmitJob", + "title": "SuccessfulConversationPIIRedactionCharSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redacting PII data from transcribed audio", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "domain": "generic", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "Good morning John Doe.", + "itn": "good morning john doe", + "maskedItn": "good morning john doe", + "lexical": "good morning john doe", + "wordLevelTimings": [ + { + "word": "good", + "offset": 390000, + "duration": 2700000 + }, + { + "word": "morning", + "offset": 4500000, + "duration": 920000 + }, + { + "word": "john", + "offset": 590000, + "duration": 2700000 + }, + { + "word": "doe", + "offset": 6300000, + "duration": 920000 + } + ] + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation PII", + "kind": "ConversationalPIITask", + "parameters": { + "modelVersion": "latest", + "piiCategories": [ + "All" + ], + "redactionCharacter": "-", + "redactionSource": "lexical", + "redactAudioTiming": true + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json new file mode 100644 index 000000000000..b54fa42c2e94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json @@ -0,0 +1,76 @@ +{ + "operationId": "AnalyzeConversationsJobStatus", + "title": "SuccessfulConversationPIIRedactionCharTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Redacting PII from transcribed audio", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "conversationalPIIResults", + "taskName": "Conversation PII", + "lastUpdateDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "redactedContent": { + "text": "Good morning -------------.", + "itn": "good morning -------------", + "maskedItn": "good morning -------------", + "lexical": "good morning -------------", + "audioTimings": [ + { + "offset": 590000, + "duration": 920000 + } + ] + }, + "entities": [ + { + "category": "Person", + "confidenceScore": 0.91, + "length": 8, + "offset": 13, + "text": "john doe" + } + ] + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2022-05-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIISubmit.json new file mode 100644 index 000000000000..947e9ead2b75 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIISubmit.json @@ -0,0 +1,76 @@ +{ + "operationId": "AnalyzeConversationsSubmitJob", + "title": "SuccessfulConversationPIISubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redacting PII data from transcribed audio", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "domain": "generic", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "Good morning John Doe.", + "itn": "good morning john doe", + "maskedItn": "good morning john doe", + "lexical": "good morning john doe", + "wordLevelTimings": [ + { + "word": "good", + "offset": 390000, + "duration": 2700000 + }, + { + "word": "morning", + "offset": 4500000, + "duration": 920000 + }, + { + "word": "john", + "offset": 590000, + "duration": 2700000 + }, + { + "word": "doe", + "offset": 6300000, + "duration": 920000 + } + ] + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation PII", + "kind": "ConversationalPIITask", + "parameters": { + "modelVersion": "latest", + "piiCategories": [ + "All" + ], + "redactionSource": "lexical", + "redactAudioTiming": true + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIITaskStatusRequest.json new file mode 100644 index 000000000000..fe7c7edbe67f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationPIITaskStatusRequest.json @@ -0,0 +1,76 @@ +{ + "operationId": "AnalyzeConversationsJobStatus", + "title": "SuccessfulConversationPIITaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Redacting PII from transcribed audio", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "conversationalPIIResults", + "taskName": "Conversation PII", + "lastUpdateDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "redactedContent": { + "text": "Good morning *************.", + "itn": "good morning *************", + "maskedItn": "good morning *************", + "lexical": "good morning *************", + "audioTimings": [ + { + "offset": 590000, + "duration": 920000 + } + ] + }, + "entities": [ + { + "category": "Person", + "confidenceScore": 0.91, + "length": 8, + "offset": 13, + "text": "john doe" + } + ] + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2022-05-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskResult.json new file mode 100644 index 000000000000..e610d0537b33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskResult.json @@ -0,0 +1,77 @@ +{ + "operationId": "AnalyzeConversationsJobStatus", + "title": "SuccessfulConversationSummarizationTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "Conversation Summarization Example", + "createdDateTime": "2022-04-01T15:00:45Z", + "expirationDateTime": "2022-04-02T15:00:45Z", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", + "lastUpdatedDateTime": "2022-04-01T15:00:49Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "conversationalSummarizationResults", + "lastUpdateDateTime": "2022-04-01T15:00:49Z", + "taskName": "Conversation Summarization Task 1", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "summaries": [ + { + "aspect": "chapterTitle", + "text": "Bug Triage", + "contexts": [ + { + "conversationItemId": "2", + "offset": 4, + "length": 39 + } + ] + }, + { + "aspect": "narrative", + "text": "Speaker 3 believes there are 3 remaining bugs.", + "contexts": [ + { + "conversationItemId": "2", + "offset": 4, + "length": 39 + }, + { + "conversationItemId": "3", + "offset": 0, + "length": 7 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + }, + "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskStatusRequest.json new file mode 100644 index 000000000000..b4480b5b1723 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskStatusRequest.json @@ -0,0 +1,61 @@ +{ + "operationId": "AnalyzeConversationsJobStatus", + "title": "SuccessfulConversationSummarizationTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "Analyze chat", + "createdDateTime": "2022-04-01T15:00:45Z", + "expirationDateTime": "2022-04-02T15:00:45Z", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", + "lastUpdatedDateTime": "2022-04-01T15:00:49Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "conversationalSummarizationResults", + "lastUpdateDateTime": "2022-04-01T15:00:49Z", + "taskName": "analyze 1", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "20220101meeting", + "summaries": [ + { + "aspect": "issue", + "text": "Customer wants to cancel his subscription. Customer doesn't know how" + }, + { + "aspect": "resolution", + "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + }, + "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskSubmit.json new file mode 100644 index 000000000000..248cfb670b10 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarizationTaskSubmit.json @@ -0,0 +1,79 @@ +{ + "operationId": "AnalyzeConversationsSubmitJob", + "title": "SuccessfulConversationSummarizationTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Conversation Summarization Example", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "conversationItems": [ + { + "participantId": "speaker 1", + "id": "1", + "text": "Let's get started.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 0, + "duration": 20000000 + } + }, + { + "participantId": "speaker 2", + "id": "2", + "text": "OK. How many remaining bugs do we have now?", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 20000000, + "duration": 50000000 + } + }, + { + "participantId": "speaker 3", + "id": "3", + "text": "Only 3.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 50000000, + "duration": 60000000 + } + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation Summarization Task 1", + "kind": "ConversationalSummarizationTask", + "parameters": { + "summaryAspects": [ + "chapterTitle", + "narrative" + ] + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarySubmit.json new file mode 100644 index 000000000000..edd8c4d31423 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulConversationSummarySubmit.json @@ -0,0 +1,63 @@ +{ + "operationId": "AnalyzeConversationsSubmitJob", + "title": "SuccessfulConversationSummarySubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Analyze conversations from Contoso meeting", + "analysisInput": { + "conversations": [ + { + "id": "20220101meeting", + "language": "en", + "modality": "text", + "domain": "generic", + "conversationItems": [ + { + "participantId": "user", + "role": "customer", + "id": "1", + "text": "Hi!" + }, + { + "participantId": "agent", + "role": "agent", + "id": "2", + "text": "Hello, how can I help you?" + }, + { + "participantId": "user", + "role": "customer", + "id": "3", + "text": "I am having trouble issuing a return of a game on my xbox: call of duty" + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "analyze 1", + "kind": "ConversationalSummarizationTask", + "parameters": { + "modelVersion": "latest", + "summaryAspects": [ + "issue", + "resolution" + ] + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskResult.json new file mode 100644 index 000000000000..0364df663456 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskResult.json @@ -0,0 +1,66 @@ +{ + "operationId": "AnalyzeConversationsJobStatus", + "title": "SuccessfulCustomConversationSummarizationTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "Custom Conversation Summarization Example", + "createdDateTime": "2022-04-01T15:00:45Z", + "expirationDateTime": "2022-04-02T15:00:45Z", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", + "lastUpdatedDateTime": "2022-04-01T15:00:49Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "customConversationalSummarizationResults", + "lastUpdateDateTime": "2022-04-01T15:00:49Z", + "taskName": "Custom Conversation Summarization Task 1", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "summaries": [ + { + "aspect": "narrative", + "text": "Speaker 3 believes there are 3 remaining bugs.", + "contexts": [ + { + "conversationItemId": "2", + "offset": 4, + "length": 39 + }, + { + "conversationItemId": "3", + "offset": 0, + "length": 7 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "projectName": "my_project", + "deploymentName": "my_deployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskSubmit.json new file mode 100644 index 000000000000..23d62289ed19 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/preview/2025-05-15-preview/examples/SuccessfulCustomConversationSummarizationTaskSubmit.json @@ -0,0 +1,80 @@ +{ + "operationId": "AnalyzeConversationsSubmitJob", + "title": "SuccessfulCustomConversationSummarizationTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Custom Conversation Summarization Example", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "conversationItems": [ + { + "participantId": "speaker 1", + "id": "1", + "text": "Let's get started.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 0, + "duration": 20000000 + } + }, + { + "participantId": "speaker 2", + "id": "2", + "text": "OK. How many remaining bugs do we have now?", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 20000000, + "duration": 50000000 + } + }, + { + "participantId": "speaker 3", + "id": "3", + "text": "Only 3.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 50000000, + "duration": 60000000 + } + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Custom Conversation Summarization Task 1", + "kind": "CustomConversationalSummarizationTask", + "parameters": { + "summaryAspects": [ + "narrative" + ], + "projectName": "my_project", + "deploymentName": "my_deployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md index ef30b75c8bab..00eed55235c4 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversations/readme.md @@ -38,6 +38,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Release 2025-05-15-preview + +These settings apply only when `--tag=release_2025-05-15-preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/analyzeconversations.json +title: + Microsoft Cognitive Language Service - Conversations +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2024-11-01 These settings apply only when `--tag=release_2024-11-01` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulAssignDeploymentResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCopyProjectAuthorization.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateExportedModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateExportedModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateExportedModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulCreateProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulCreateProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeployment.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteDeploymentFromResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteExportedModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeleteProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeleteProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeployProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulDeployProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulDeployProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulEvaluationProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulEvaluationProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulEvaluationProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulExportProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulExportProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulExportProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetCopyProjectStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeployment.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeployment.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetEvaluationStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModelStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetExportedModelStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetImportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetImportStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetLoadSnapshotStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModel.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModel.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetTrainStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetTrainStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulImportProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulImportProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulImportProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListAssignedResourceDeployments.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeploymentResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeploymentResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeploymentResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListDeployments.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListDeployments.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListExportedModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListExportedModels.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListExportedModels.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListExportedModels.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListModels.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListModels.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListModels.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListProjects.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListProjects.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListProjects.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListTrainingJobs.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulListTrainingJobs.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulLoadSnapshot.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulLoadSnapshot.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulLoadSnapshot.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulSwapDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulSwapDeployments.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulTrainProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulTrainProject.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulTrainProject.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json similarity index 100% rename from specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/SuccessfulUnassignDeploymentResources.json rename to specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/examples/2025-05-15-preview/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp index 186ac0e30467..cb0268ce61f7 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/main.tsp @@ -49,6 +49,11 @@ enum Versions { /** Version 2025-11-01 */ v2025_11_01: "2025-11-01", + /** + * The 2025-05-15-preview API version. + */ + v2025_05_15_preview: "2025-05-15-preview", + /** * The 2025-11-15-preview API version. */ diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp index 0156a5817f15..2354b76c5e7f 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/common.tsp @@ -30,7 +30,7 @@ union ProjectKind { /** * A project to build conversation summarization models which are able to summarize long conversations. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) CustomConversationSummarization: "CustomConversationSummarization", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp index 0f065f1007a6..3b0f8df3933f 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/models/project.tsp @@ -69,7 +69,7 @@ model AnalyzeConversationAuthoringProjectMetadata { * The storage container name in case of conversation summarization. */ @visibility(Lifecycle.Create, Lifecycle.Read) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) storageInputContainerName?: string; /** @@ -156,7 +156,7 @@ model AnalyzeConversationAuthoringCreateProjectOptions { /** * The storage container name in case of conversation summarization. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) storageInputContainerName?: string; /** @@ -183,7 +183,7 @@ model AnalyzeConversationAuthoringCreateProjectOptions { /** * Represents the options for authorizing a project copy to the current Azure resource. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringCopyAuthorizationOptions { /** * Represents the project kind. @@ -204,7 +204,7 @@ model AnalyzeConversationAuthoringCopyAuthorizationOptions { /** * Represents the options for copying an existing project to another Azure resource. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringCopiedProjectOptions { /** * Represents the project kind. @@ -300,7 +300,7 @@ model AnalyzeConversationAuthoringTrainingJobOptions { /** * For customers to populate if they wish to use data generation for their model training job. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) dataGenerationSettings?: AnalyzeConversationAuthoringDataGenerationSettings; } @@ -327,7 +327,7 @@ model AnalyzeConversationAuthoringEvaluationOptions { /** * Represents the state of a copy job. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @resource("copy/jobs") @parentResource(AnalyzeConversationAuthoringProjectMetadata) model AnalyzeConversationAuthoringCopiedProjectJobState { @@ -433,13 +433,20 @@ model AnalyzeConversationAuthoringProjectDeployment { * Represents the metadata of the assigned Azure resources. */ @added(Versions.v2025_11_01) + @typeChangedFrom( + Versions.v2025_05_15_preview, + AnalyzeConversationAuthoringProjectResourceInfo[] + ) + @typeChangedFrom( + Versions.v2025_11_15_preview, + AnalyzeConversationAuthoringDeploymentResource[] + ) assignedResources: AnalyzeConversationAuthoringProjectResourceInfo[]; } /** * Represents an Azure resource assigned to a deployment. */ -@added(Versions.v2025_11_15_preview) model AnalyzeConversationAuthoringDeploymentResource { /** * Represents the Azure resource Id. @@ -454,7 +461,7 @@ model AnalyzeConversationAuthoringDeploymentResource { /** * Represents the AOAI resource assigned for data generation. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) assignedAoaiResource?: AnalyzeConversationAuthoringDataGenerationConnectionInfo; } @@ -471,13 +478,13 @@ model AnalyzeConversationAuthoringCreateDeploymentOptions { * Represents the Language or AIService resource IDs that if provided,\n the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. */ @added(Versions.v2025_11_01) - @removed(Versions.v2025_11_15_preview) + @removed(Versions.v2025_05_15_preview) assignedResourceIds?: string[]; /** * Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) assignedResources?: AnalyzeConversationAuthoringDeploymentResource[]; } @@ -485,8 +492,12 @@ model AnalyzeConversationAuthoringCreateDeploymentOptions { * Represents the payload for deleting a project deployment. */ @renamedFrom( - Versions.v2025_11_01, - "AnalyzeConversationAuthoringDeleteDeploymentOptions" + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectAzureResourceIds" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignedDeploymentResources" ) model AnalyzeConversationAuthoringProjectAzureResourceIds { /** @@ -495,6 +506,16 @@ model AnalyzeConversationAuthoringProjectAzureResourceIds { assignedResourceIds?: string[]; } +/** + * Represents the options for deleting a project deployment. + */ +model AnalyzeConversationAuthoringDeleteDeploymentOptions { + /** + * Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest. + */ + assignedResourceIds?: string[]; +} + /** * Represents the state of a deployment job. */ @@ -1006,6 +1027,14 @@ model AnalyzeConversationAuthoringLoadSnapshotJobState { * Represents the assigned deployment resources. */ @added(Versions.v2025_11_01) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringDeploymentResourcesInfoList" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignedDeploymentResources" +) model AnalyzeConversationAuthoringDeploymentResourcesInfoList { /** * The list of assigned deployment resources. @@ -1024,6 +1053,14 @@ model AnalyzeConversationAuthoringDeploymentResourcesInfoList { @added(Versions.v2025_11_01) @resource("resources") @parentResource(AnalyzeConversationAuthoringProjectMetadata) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourceInfo" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignedDeploymentResource" +) model AnalyzeConversationAuthoringProjectResourceInfo { /** * The Azure resource ID of the language or AI resource. @@ -1042,10 +1079,20 @@ model AnalyzeConversationAuthoringProjectResourceInfo { * Represents the payload for assigning Azure resources to a project. */ @added(Versions.v2025_11_01) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourceAssignments" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringAssignDeploymentResourcesOptions" +) model AnalyzeConversationAuthoringProjectResourceAssignments { /** * Represents the metadata for the project resources to be assigned. */ + @renamedFrom(Versions.v2025_05_15_preview, "projectResources") + @renamedFrom(Versions.v2025_11_15_preview, "resourcesMetadata") projectResources: AnalyzeConversationAuthoringProjectResourceAssignmentInfo[]; } @@ -1053,7 +1100,11 @@ model AnalyzeConversationAuthoringProjectResourceAssignments { * Represents metadata for the Azure resource.. */ @renamedFrom( - Versions.v2025_11_01, + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourceAssignmentInfo" +) +@renamedFrom( + Versions.v2025_11_15_preview, "AnalyzeConversationAuthoringResourceMetadata" ) model AnalyzeConversationAuthoringProjectResourceAssignmentInfo { @@ -1076,7 +1127,7 @@ model AnalyzeConversationAuthoringProjectResourceAssignmentInfo { /** * Represents the options to unassign Azure resources from a project. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions { /** * Represents the assigned resource IDs to be unassigned. @@ -1090,6 +1141,14 @@ model AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions { @added(Versions.v2025_11_01) @resource("resources/assign/jobs") @parentResource(AnalyzeConversationAuthoringProjectMetadata) +@renamedFrom( + Versions.v2025_05_15_preview, + "AnalyzeConversationAuthoringProjectResourcesJobState" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "AnalyzeConversationAuthoringDeploymentResourcesJobState" +) model AnalyzeConversationAuthoringProjectResourcesJobState { ...AnalyzeConversationAuthoringJobState; } @@ -1150,7 +1209,7 @@ model AnalyzeConversationAuthoringTrainingJobResult { /** * Represents the model data generation status. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) dataGenerationStatus: AnalyzeConversationAuthoringSubTrainingJobState; /** @@ -1368,7 +1427,7 @@ model AnalyzeConversationAuthoringConversationExportedEntity { /** * The entity description. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) description?: string; /** @@ -1489,20 +1548,20 @@ model AnalyzeConversationAuthoringConversationExportedIntent { /** * The intent description. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) description?: string; /** * The list of associated entities. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) associatedEntities?: AnalyzeConversationExportedAssociatedEntityLabel[]; } /** * Represents an associated entity label for an intent. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationExportedAssociatedEntityLabel { /** * The category of the entity label. @@ -1752,7 +1811,7 @@ model AnalyzeConversationAuthoringOrchestrationExportedIntent { /** * The intent description. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) description?: string; } @@ -1843,7 +1902,7 @@ model AnalyzeConversationAuthoringExportedTrainedModel { /** * Represents the state of a job to create or updated an exported model. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @resource("jobs") @parentResource(AnalyzeConversationAuthoringExportedTrainedModel) model AnalyzeConversationAuthoringExportedModelJobState { @@ -1852,7 +1911,7 @@ model AnalyzeConversationAuthoringExportedModelJobState { /** * Represents the properties for the model file. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringModelFile { /** * The name of the file. @@ -1867,7 +1926,7 @@ model AnalyzeConversationAuthoringModelFile { /** * Represents the options for creating or replacing an exported model. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ExportedModelOptions { /** * The trained model label. @@ -1879,7 +1938,7 @@ model ExportedModelOptions { * Represents the connection kind for Azure OpenAI deployment. */ #suppress "@azure-tools/typespec-azure-core/documentation-required" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union AnalyzeConversationAuthoringDataGenerationConnectionKind { string, AzureOpenAI: "AzureOpenAI", @@ -1888,7 +1947,7 @@ union AnalyzeConversationAuthoringDataGenerationConnectionKind { /** * Represents the connection info for the Azure resource to use during data generation. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringDataGenerationConnectionInfo { /** * Connection type for data generation settings. Currently only supports Azure OpenAI. @@ -1910,7 +1969,7 @@ model AnalyzeConversationAuthoringDataGenerationConnectionInfo { /** * Settings to enable data generation for training augmentation. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AnalyzeConversationAuthoringDataGenerationSettings { /** * Must be explicitly set to True to enable data generation to augment training data. diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/analyzeconversations-authoring.json new file mode 100644 index 000000000000..0ccdd406b56d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/analyzeconversations-authoring.json @@ -0,0 +1,5726 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", + "version": "2025-05-15-preview", + "description": "The language service API is a suite of natural language processing (NLP) skills 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, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint e.g., https://.api.cognitiveservices.azure.com.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/authoring/analyze-conversations/projects": { + "get": { + "operationId": "ConversationAuthoringListProjects", + "description": "Lists the existing projects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}": { + "get": { + "operationId": "ConversationAuthoringProject_GetProject", + "description": "Gets the details of a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + } + } + }, + "patch": { + "operationId": "ConversationAuthoringProject_CreateProject", + "description": "Creates a new project or updates an existing one.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + } + } + }, + "delete": { + "operationId": "ConversationAuthoringProject_DeleteProject", + "description": "Deletes a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { + "post": { + "operationId": "ConversationAuthoringProject_CopyProjectAuthorization", + "description": "Generates a copy project operation authorization to the current target Azure resource.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopyAuthorizationOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Copy Project Authorization": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:copy": { + "post": { + "operationId": "ConversationAuthoringProject_CopyProject", + "description": "Copies an existing project to another Azure resource.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The copy project info.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Copy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:export": { + "post": { + "operationId": "ConversationAuthoringProject_Export", + "description": "Triggers a job to export a project's data.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit", + "Utf8CodeUnit", + "Utf32CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + }, + { + "name": "Utf8CodeUnit", + "value": "Utf8CodeUnit" + }, + { + "name": "Utf32CodeUnit", + "value": "Utf32CodeUnit" + } + ] + } + }, + { + "name": "assetKind", + "in": "query", + "description": "Kind of asset to export.", + "required": false, + "type": "string" + }, + { + "name": "trainedModelLabel", + "in": "query", + "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:import": { + "post": { + "operationId": "ConversationAuthoringProject_Import", + "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "body", + "in": "body", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProject" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:train": { + "post": { + "operationId": "ConversationAuthoringProject_Train", + "description": "Triggers a training job for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetCopyProjectStatus", + "description": "Gets the status of an existing copy project job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCopiedProjectJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Copy Project Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments": { + "get": { + "operationId": "ConversationAuthoringListDeployments", + "description": "Lists the deployments belonging to a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { + "get": { + "operationId": "ConversationAuthoringDeployment_GetDeployment", + "description": "Gets the details of a deployment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + } + } + }, + "put": { + "operationId": "ConversationAuthoringDeployment_DeployProject", + "description": "Creates a new deployment or replaces an existing one.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCreateDeploymentOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConversationAuthoringDeployment_DeleteDeployment", + "description": "Deletes a project deployment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { + "post": { + "operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources", + "description": "Deletes a deployment from the specified project-assigned resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The Language or AIService resource list for deleting the deployment.\\r\\n The deployment will only be deleted from the specified resources, and will remain for the rest.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeleteDeploymentOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment From Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", + "description": "Gets the status of an existing delete deployment from specific resources job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringDeployment_GetDeploymentStatus", + "description": "Gets the status of an existing deployment job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "operationId": "ConversationAuthoringProject_SwapDeployments", + "description": "Swaps two existing deployments with each other.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus", + "description": "Gets the status of an existing swap deployment job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetExportStatus", + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportProjectJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/exported-models": { + "get": { + "operationId": "ConversationAuthoringListExportedModels", + "description": "Lists the exported models belonging to a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringExportedTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Exported Models": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListExportedModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}": { + "get": { + "operationId": "ConversationAuthoringExportedModel_GetExportedModel", + "description": "Gets the details of an exported model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json" + } + } + }, + "put": { + "operationId": "ConversationAuthoringExportedModel_CreateOrUpdateExportedModel", + "description": "Creates a new exported model or replaces an existing one.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The exported model info.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportedModelOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Create Exported Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConversationAuthoringExportedModel_DeleteExportedModel", + "description": "Deletes an existing exported model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string" + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Exported Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringExportedModel_GetExportedModelJobStatus", + "description": "Gets the status for an existing job to create or update an exported model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "exportedModelName", + "in": "path", + "description": "The exported model name.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedModelJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetImportStatus", + "description": "Gets the status for an import.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringImportProjectJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models": { + "get": { + "operationId": "ConversationAuthoringListTrainedModels", + "description": "Lists the trained models belonging to a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetTrainedModel", + "description": "Gets the details of a trained model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + } + } + }, + "delete": { + "operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel", + "description": "Deletes an existing trained model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { + "post": { + "operationId": "ConversationAuthoringTrainedModel_EvaluateModel", + "description": "Triggers evaluation operation on a trained model.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Evaluation Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { + "post": { + "operationId": "ConversationAuthoringTrainedModel_LoadSnapshot", + "description": "Restores the snapshot of this trained model to be the current working directory of the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Load Snapshot": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetEvaluationStatus", + "description": "Gets the status for an evaluation job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Evaluation Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults", + "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/StringIndexTypeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringUtteranceEvaluationResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary", + "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus", + "description": "Gets the status for loading a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringLoadSnapshotJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Load Snapshot Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources": { + "get": { + "operationId": "ConversationAuthoringListDeploymentResources", + "description": "Lists the Language or AIService resources assigned to the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedDeploymentResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { + "post": { + "operationId": "ConversationAuthoringProject_AssignDeploymentResources", + "description": "Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The new project resources to be assigned.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignDeploymentResourcesOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Assign Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { + "post": { + "operationId": "ConversationAuthoringProject_UnassignDeploymentResources", + "description": "Unassign resources from a project. This disallows deployment to these resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The list of Language or AIService Azure resource IDs to be unassigned.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Unassign Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus", + "description": "Gets the status of an existing assign project resources job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Assign Deployment Resources Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus", + "description": "Gets the status of an existing unassign project resources job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Unassign Deployment Resources Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { + "get": { + "operationId": "ConversationAuthoringListTrainingJobs", + "description": "Lists the non-expired training jobs created for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetTrainingStatus", + "description": "Gets the status for a training job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "operationId": "ConversationAuthoringProject_CancelTrainingJob", + "description": "Triggers a cancellation for a running training job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { + "get": { + "operationId": "ConversationAuthoringProject_GetProjectDeletionStatus", + "description": "Gets the status for a project deletion job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeletionJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/global/deployments/resources": { + "get": { + "operationId": "ConversationAuthoringListAssignedResourceDeployments", + "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful List Assigned Resource Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/global/languages": { + "get": { + "operationId": "ConversationAuthoringListSupportedLanguages", + "description": "Lists the supported languages for the given project type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/ProjectKindQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringSupportedLanguage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Supported Languages": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/global/prebuilt-entities": { + "get": { + "operationId": "ConversationAuthoringListSupportedPrebuiltEntities", + "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.language" + }, + { + "$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.multilingual" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringPrebuiltEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Supported Prebuilt Entities": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/authoring/analyze-conversations/projects/global/training-config-versions": { + "get": { + "operationId": "ConversationAuthoringListTrainingConfigVersions", + "description": "Lists the support training config version for a given project type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + }, + { + "$ref": "#/parameters/ProjectKindQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingConfigVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AnalyzeConversationAuthoringAssignDeploymentResourcesOptions": { + "type": "object", + "description": "Represents the payload for assigning Azure resources to a project.", + "properties": { + "resourcesMetadata": { + "type": "array", + "description": "Represents the metadata for the project resources to be assigned.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringResourceMetadata" + } + } + }, + "required": [ + "resourcesMetadata" + ] + }, + "AnalyzeConversationAuthoringAssignedDeploymentResource": { + "type": "object", + "description": "Represents the assigned project resource.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The Azure resource ID of the language or AI resource.", + "readOnly": true + }, + "region": { + "type": "string", + "description": "The Azure resource region." + } + }, + "required": [ + "azureResourceId", + "region" + ] + }, + "AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata": { + "type": "object", + "description": "Represents the metadata for an assigned deployment", + "properties": { + "deploymentName": { + "type": "string", + "description": "Represents the deployment name." + }, + "lastDeployedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents deployment last deployed time." + }, + "deploymentExpirationDate": { + "type": "string", + "format": "date", + "description": "Represents deployment expiration date in the runtime." + } + }, + "required": [ + "deploymentName", + "lastDeployedDateTime", + "deploymentExpirationDate" + ] + }, + "AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": { + "type": "object", + "description": "Represents the metadata for assigned deployments for a project.", + "properties": { + "projectName": { + "type": "string", + "description": "Represents the project name.", + "readOnly": true + }, + "deploymentsMetadata": { + "type": "array", + "description": "Represents the resource region.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata" + } + } + }, + "required": [ + "projectName", + "deploymentsMetadata" + ] + }, + "AnalyzeConversationAuthoringConfusionMatrixCell": { + "type": "object", + "description": "Represents a cell in a confusion matrix.", + "properties": { + "normalizedValue": { + "type": "number", + "format": "float", + "description": "Represents normalized value in percentages." + }, + "rawValue": { + "type": "number", + "format": "float", + "description": "Represents raw value." + } + }, + "required": [ + "normalizedValue", + "rawValue" + ] + }, + "AnalyzeConversationAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixCell" + } + }, + "AnalyzeConversationAuthoringConversationExportedEntity": { + "type": "object", + "description": "Represents an entity with its components.", + "properties": { + "category": { + "type": "string", + "description": "The category of the entity." + }, + "description": { + "type": "string", + "description": "The entity description." + }, + "compositionSetting": { + "$ref": "#/definitions/CompositionSetting", + "description": "The behavior to follow when the entity's components overlap with each other." + }, + "entities": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityList", + "description": "The list component of the entity." + }, + "prebuilts": { + "type": "array", + "description": "The prebuilt entities components.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedPrebuiltEntity" + } + }, + "regex": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegex", + "description": "The regex component of the entity." + }, + "requiredComponents": { + "type": "array", + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", + "items": { + "type": "string" + } + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringConversationExportedIntent": { + "type": "object", + "description": "Represents an exported intent of a conversational project.", + "properties": { + "category": { + "type": "string", + "description": "The intent category." + }, + "description": { + "type": "string", + "description": "The intent description." + }, + "associatedEntities": { + "type": "array", + "description": "The list of associated entities.", + "items": { + "$ref": "#/definitions/AnalyzeConversationExportedAssociatedEntityLabel" + } + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringConversationExportedProjectAsset": { + "type": "object", + "description": "Represents the exported assets of a conversational project.", + "properties": { + "intents": { + "type": "array", + "description": "The intents defined in the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedIntent" + } + }, + "entities": { + "type": "array", + "description": "The entities defined in the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedEntity" + } + }, + "utterances": { + "type": "array", + "description": "The utterances defined in the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedUtterance" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "AnalyzeConversationAuthoringConversationExportedUtterance": { + "type": "object", + "description": "Represents an exported utterance for a conversational project.", + "properties": { + "entities": { + "type": "array", + "description": "Represents the entity labels of the utterance.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedUtteranceEntityLabel" + } + }, + "text": { + "type": "string", + "description": "The utterance text." + }, + "language": { + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "intent": { + "type": "string", + "description": "The intent of the utterance." + }, + "dataset": { + "$ref": "#/definitions/DatasetType", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." + } + }, + "required": [ + "text", + "intent" + ] + }, + "AnalyzeConversationAuthoringCopiedProjectJobState": { + "type": "object", + "description": "Represents the state of a copy job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringCopiedProjectOptions": { + "type": "object", + "description": "Represents the options for copying an existing project to another Azure resource.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." + }, + "targetProjectName": { + "type": "string", + "description": "The project name to be copied-into." + }, + "accessToken": { + "type": "string", + "description": "The access token." + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "The expiration of the access token." + }, + "targetResourceId": { + "type": "string", + "description": "Represents the target Azure resource ID." + }, + "targetResourceRegion": { + "type": "string", + "description": "Represents the target Azure resource region." + } + }, + "required": [ + "projectKind", + "targetProjectName", + "accessToken", + "expiresAt", + "targetResourceId", + "targetResourceRegion" + ] + }, + "AnalyzeConversationAuthoringCopyAuthorizationOptions": { + "type": "object", + "description": "Represents the options for authorizing a project copy to the current Azure resource.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." + }, + "storageInputContainerName": { + "type": "string", + "description": "The name of the storage container." + }, + "allowOverwrite": { + "type": "boolean", + "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization." + } + }, + "required": [ + "projectKind" + ] + }, + "AnalyzeConversationAuthoringCreateDeploymentOptions": { + "type": "object", + "description": "Represents the options for creating or updating a project deployment.", + "properties": { + "trainedModelLabel": { + "type": "string", + "description": "Represents the trained model label." + }, + "assignedResources": { + "type": "array", + "description": "Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResource" + } + } + }, + "required": [ + "trainedModelLabel" + ] + }, + "AnalyzeConversationAuthoringCreateProjectOptions": { + "type": "object", + "description": "Represents the options used to create or update a project.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." + }, + "settings": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings", + "description": "The project settings." + }, + "storageInputContainerName": { + "type": "string", + "description": "The storage container name in case of conversation summarization." + }, + "projectName": { + "type": "string", + "description": "The new project name." + }, + "multilingual": { + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not." + }, + "description": { + "type": "string", + "description": "The project description." + }, + "language": { + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + } + }, + "required": [ + "projectKind", + "projectName", + "language" + ] + }, + "AnalyzeConversationAuthoringDataGenerationConnectionInfo": { + "type": "object", + "description": "Represents the connection info for the Azure resource to use during data generation.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationConnectionKind", + "description": "Connection type for data generation settings. Currently only supports Azure OpenAI." + }, + "deploymentName": { + "type": "string", + "description": "Deployment name of model to be used for synthetic data generation." + }, + "resourceId": { + "type": "string", + "description": "Resource ID for the data generation resource. Looks something like\n\"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}\"." + } + }, + "required": [ + "kind", + "deploymentName" + ] + }, + "AnalyzeConversationAuthoringDataGenerationConnectionKind": { + "type": "string", + "description": "Represents the connection kind for Azure OpenAI deployment.", + "enum": [ + "AzureOpenAI" + ], + "x-ms-enum": { + "name": "AnalyzeConversationAuthoringDataGenerationConnectionKind", + "modelAsString": true, + "values": [ + { + "name": "AzureOpenAI", + "value": "AzureOpenAI" + } + ] + } + }, + "AnalyzeConversationAuthoringDataGenerationSettings": { + "type": "object", + "description": "Settings to enable data generation for training augmentation.", + "properties": { + "enableDataGeneration": { + "type": "boolean", + "description": "Must be explicitly set to True to enable data generation to augment training data." + }, + "dataGenerationConnectionInfo": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationConnectionInfo", + "description": "Must be filled out to enable data generation to augment training data." + } + }, + "required": [ + "enableDataGeneration", + "dataGenerationConnectionInfo" + ] + }, + "AnalyzeConversationAuthoringDeleteDeploymentOptions": { + "type": "object", + "description": "Represents the options for deleting a project deployment.", + "properties": { + "assignedResourceIds": { + "type": "array", + "description": "Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", + "items": { + "type": "string" + } + } + } + }, + "AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState": { + "type": "object", + "description": "Represents the state of an existing delete deployment from specific resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringDeploymentJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringDeploymentResource": { + "type": "object", + "description": "Represents an Azure resource assigned to a deployment.", + "properties": { + "resourceId": { + "type": "string", + "description": "Represents the Azure resource Id." + }, + "region": { + "type": "string", + "description": "Represents the resource region." + }, + "assignedAoaiResource": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationConnectionInfo", + "description": "Represents the AOAI resource assigned for data generation." + } + }, + "required": [ + "resourceId", + "region" + ] + }, + "AnalyzeConversationAuthoringDeploymentResourcesJobState": { + "type": "object", + "description": "Represents the state of a project resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringEntitiesEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation result summary for the project's entities.", + "properties": { + "confusionMatrix": { + "type": "object", + "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow" + } + }, + "entities": { + "type": "object", + "description": "Represents the entities evaluation summary.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEntityEvaluationSummary" + } + }, + "microF1": { + "type": "number", + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." + }, + "microPrecision": { + "type": "number", + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." + }, + "microRecall": { + "type": "number", + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." + }, + "macroF1": { + "type": "number", + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." + }, + "macroPrecision": { + "type": "number", + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." + }, + "macroRecall": { + "type": "number", + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." + } + }, + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "AnalyzeConversationAuthoringEntityEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation result for an entity.", + "properties": { + "f1": { + "type": "number", + "format": "double", + "description": "Represents the model F1 score" + }, + "precision": { + "type": "number", + "format": "double", + "description": "Represents the model precision" + }, + "recall": { + "type": "number", + "format": "double", + "description": "Represents the model precision" + }, + "truePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true positive" + }, + "trueNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true negative" + }, + "falsePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false positive" + }, + "falseNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false negative" + } + }, + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] + }, + "AnalyzeConversationAuthoringEvaluationJobResult": { + "type": "object", + "properties": { + "evaluationOptions": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", + "description": "Represents the options used running the evaluation." + }, + "modelLabel": { + "type": "string", + "description": "Represents trained model label." + }, + "trainingConfigVersion": { + "type": "string", + "description": "Represents training config version." + }, + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." + } + }, + "required": [ + "evaluationOptions", + "modelLabel", + "trainingConfigVersion", + "percentComplete" + ] + }, + "AnalyzeConversationAuthoringEvaluationJobState": { + "type": "object", + "description": "Represents the state of a evaluation job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "result": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationJobResult", + "description": "Represents evaluation task detailed result." + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", + "result" + ] + }, + "AnalyzeConversationAuthoringEvaluationOptions": { + "type": "object", + "description": "Represents the options used running the evaluation.", + "properties": { + "kind": { + "$ref": "#/definitions/EvaluationKind", + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage." + }, + "trainingSplitPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage." + }, + "testingSplitPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage." + } + } + }, + "AnalyzeConversationAuthoringEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation result summary.", + "properties": { + "entitiesEvaluation": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEntitiesEvaluationSummary", + "description": "Contains the data related to entities evaluation." + }, + "intentsEvaluation": { + "$ref": "#/definitions/AnalyzeConversationAuthoringIntentsEvaluationSummary", + "description": "Contains the data related to intents evaluation." + }, + "evaluationOptions": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", + "description": "The options that were used while running the evaluation." + } + }, + "required": [ + "entitiesEvaluation", + "intentsEvaluation" + ] + }, + "AnalyzeConversationAuthoringExportProjectJobState": { + "type": "object", + "description": "Represents the state of an export job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "resultUrl": { + "type": "string", + "description": "The URL to use in order to download the exported project." + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringExportedConversationOrchestration": { + "type": "object", + "description": "Defines the orchestration details for a Conversational project target.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the targeted project." + }, + "deploymentName": { + "type": "string", + "description": "The name of the targeted deployment." + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "AnalyzeConversationAuthoringExportedConversationOrchestrationOptions": { + "type": "object", + "description": "Represents the orchestration options for a Conversational project target.", + "properties": { + "conversationOrchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedConversationOrchestration", + "description": "The Conversational project target details." + } + }, + "required": [ + "conversationOrchestration" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" + } + ], + "x-ms-discriminator-value": "Conversation" + }, + "AnalyzeConversationAuthoringExportedEntityList": { + "type": "object", + "description": "Represents a list component of an entity.", + "properties": { + "sublists": { + "type": "array", + "description": "The sub-lists of the list component.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntitySublist" + } + } + } + }, + "AnalyzeConversationAuthoringExportedEntityListSynonym": { + "type": "object", + "description": "Represents a list of synonyms inside a list component", + "properties": { + "language": { + "type": "string", + "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "values": { + "type": "array", + "description": "The list of synonyms.", + "items": { + "type": "string" + } + } + } + }, + "AnalyzeConversationAuthoringExportedEntityRegex": { + "type": "object", + "description": "Represents a regex component of an entity.", + "properties": { + "expressions": { + "type": "array", + "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegexExpression" + } + } + } + }, + "AnalyzeConversationAuthoringExportedEntityRegexExpression": { + "type": "object", + "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", + "properties": { + "regexKey": { + "type": "string", + "description": "The key of the regex expression." + }, + "language": { + "type": "string", + "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "regexPattern": { + "type": "string", + "description": "The regex pattern." + } + } + }, + "AnalyzeConversationAuthoringExportedEntitySublist": { + "type": "object", + "description": "Represents a sub-list inside a list component.", + "properties": { + "listKey": { + "type": "string", + "description": "The key of the sub-list." + }, + "synonyms": { + "type": "array", + "description": "The phrases of that correspond to the sub-list.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityListSynonym" + } + } + } + }, + "AnalyzeConversationAuthoringExportedLuisOrchestration": { + "type": "object", + "description": "Defines the orchestration details for a LUIS application target.", + "properties": { + "appId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The LUIS application ID." + }, + "appVersion": { + "type": "string", + "description": "The targeted version Id." + }, + "slotName": { + "type": "string", + "description": "The targeted slot name." + } + }, + "required": [ + "appId" + ] + }, + "AnalyzeConversationAuthoringExportedLuisOrchestrationOptions": { + "type": "object", + "description": "Represents the orchestration options for a LUIS application target.", + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedLuisOrchestration", + "description": "The LUIS application target details." + } + }, + "required": [ + "luisOrchestration" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" + } + ], + "x-ms-discriminator-value": "Luis" + }, + "AnalyzeConversationAuthoringExportedModelJobState": { + "type": "object", + "description": "Represents the state of a job to create or updated an exported model.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringExportedOrchestrationOptions": { + "type": "object", + "description": "Represents the options used to define the orchestration behavior of an intent.", + "properties": { + "targetProjectKind": { + "$ref": "#/definitions/OrchestrationTargetProjectKind" + } + }, + "discriminator": "targetProjectKind", + "required": [ + "targetProjectKind" + ] + }, + "AnalyzeConversationAuthoringExportedPrebuiltEntity": { + "type": "object", + "description": "Represents an exported prebuilt entity component", + "properties": { + "category": { + "type": "string", + "description": "The prebuilt entity category." + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringExportedProject": { + "type": "object", + "description": "Represents an exported project.", + "properties": { + "projectFileVersion": { + "type": "string", + "description": "The version of the exported file." + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." + }, + "metadata": { + "$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions", + "description": "Represents the project metadata." + }, + "assets": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets", + "description": "Represents the project assets." + } + }, + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ] + }, + "AnalyzeConversationAuthoringExportedProjectAssets": { + "type": "object", + "description": "Represents the assets of an exported project.", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "The type of project containing the assets." + } + }, + "discriminator": "projectKind", + "required": [ + "projectKind" + ] + }, + "AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration": { + "type": "object", + "description": "Defines the orchestration details for a Question Answering project target.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the target project." + } + }, + "required": [ + "projectName" + ] + }, + "AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "type": "object", + "description": "Represents the orchestration options for a Question Answering project target.", + "properties": { + "questionAnsweringOrchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration", + "description": "The Question Answering project details." + } + }, + "required": [ + "questionAnsweringOrchestration" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions" + } + ], + "x-ms-discriminator-value": "QuestionAnswering" + }, + "AnalyzeConversationAuthoringExportedTrainedModel": { + "type": "object", + "description": "Represents an exported trained model.", + "properties": { + "exportedModelName": { + "type": "string", + "description": "The exported model name.", + "readOnly": true + }, + "modelId": { + "type": "string", + "description": "The model ID." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last trained date time of the model." + }, + "lastExportedModelDateTime": { + "type": "string", + "format": "date-time", + "description": "The last exported date time of the model." + }, + "modelExpirationDate": { + "type": "string", + "format": "date", + "description": "The model expiration date." + }, + "modelTrainingConfigVersion": { + "type": "string", + "description": "The model training config version." + } + }, + "required": [ + "exportedModelName", + "modelId", + "lastTrainedDateTime", + "lastExportedModelDateTime", + "modelExpirationDate", + "modelTrainingConfigVersion" + ] + }, + "AnalyzeConversationAuthoringExportedUtteranceEntityLabel": { + "type": "object", + "description": "Represents an entity label for an utterance.", + "properties": { + "category": { + "type": "string", + "description": "The category of the entity label." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text." + } + }, + "required": [ + "category", + "offset", + "length" + ] + }, + "AnalyzeConversationAuthoringImportProjectJobState": { + "type": "object", + "description": "Represents the state of an import job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringIntentEvaluationSummary": { + "type": "object", + "description": "The evaluation summary for an intent.", + "properties": { + "f1": { + "type": "number", + "format": "double", + "description": "Represents the model precision" + }, + "precision": { + "type": "number", + "format": "double", + "description": "Represents the model recall" + }, + "recall": { + "type": "number", + "format": "double", + "description": "Represents the model F1 score" + }, + "truePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true positive" + }, + "trueNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of true negative" + }, + "falsePositiveCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false positive" + }, + "falseNegativeCount": { + "type": "integer", + "format": "int32", + "description": "Represents the count of false negative" + } + }, + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] + }, + "AnalyzeConversationAuthoringIntentsEvaluationSummary": { + "type": "object", + "description": "Represents the evaluation summary for the project's intents.", + "properties": { + "confusionMatrix": { + "type": "object", + "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow" + } + }, + "intents": { + "type": "object", + "description": "Represents the intents evaluation summary.", + "additionalProperties": { + "$ref": "#/definitions/AnalyzeConversationAuthoringIntentEvaluationSummary" + } + }, + "microF1": { + "type": "number", + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." + }, + "microPrecision": { + "type": "number", + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive." + }, + "microRecall": { + "type": "number", + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive." + }, + "macroF1": { + "type": "number", + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." + }, + "macroPrecision": { + "type": "number", + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive." + }, + "macroRecall": { + "type": "number", + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive." + } + }, + "required": [ + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "AnalyzeConversationAuthoringLoadSnapshotJobState": { + "type": "object", + "description": "Represents the state of loading a snapshot job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringOrchestrationExportedIntent": { + "type": "object", + "description": "Represents an exported intent for an orchestration project.", + "properties": { + "orchestration": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions", + "description": "Specifies the behavior of this intent in the orchestration flow." + }, + "category": { + "type": "string", + "description": "The intent category." + }, + "description": { + "type": "string", + "description": "The intent description." + } + }, + "required": [ + "category" + ] + }, + "AnalyzeConversationAuthoringOrchestrationExportedProjectAsset": { + "type": "object", + "description": "Represents the assets of an orchestration project.", + "properties": { + "intents": { + "type": "array", + "description": "Represents the intents of the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedIntent" + } + }, + "utterances": { + "type": "array", + "description": "Represents the utterances of the project.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedUtterance" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Orchestration" + }, + "AnalyzeConversationAuthoringOrchestrationExportedUtterance": { + "type": "object", + "description": "Represents an utterance of an orchestration project.", + "properties": { + "text": { + "type": "string", + "description": "The utterance text." + }, + "language": { + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "intent": { + "type": "string", + "description": "The intent of the utterance." + }, + "dataset": { + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." + } + }, + "required": [ + "text", + "intent" + ] + }, + "AnalyzeConversationAuthoringPrebuiltEntity": { + "type": "object", + "description": "Represents a supported prebuilt entity.", + "properties": { + "category": { + "type": "string", + "description": "The prebuilt entity category.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description." + }, + "examples": { + "type": "string", + "description": "English examples for the entity." + } + }, + "required": [ + "category", + "description", + "examples" + ] + }, + "AnalyzeConversationAuthoringProjectDeletionJobState": { + "type": "object", + "description": "Represents the state of a project deletion job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringProjectDeployment": { + "type": "object", + "description": "Represents a project deployment.", + "properties": { + "deploymentName": { + "type": "string", + "description": "Represents deployment name.", + "readOnly": true + }, + "modelId": { + "type": "string", + "description": "Represents deployment modelId." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents deployment last trained time." + }, + "lastDeployedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents deployment last deployed time." + }, + "deploymentExpirationDate": { + "type": "string", + "format": "date", + "description": "Represents deployment expiration date in the runtime." + }, + "modelTrainingConfigVersion": { + "type": "string", + "description": "Represents model training config version." + }, + "assignedResources": { + "type": "array", + "description": "Represents the metadata of the assigned Azure resources.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentResource" + } + } + }, + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion", + "assignedResources" + ] + }, + "AnalyzeConversationAuthoringProjectMetadata": { + "type": "object", + "description": "Represents the metadata of a project.", + "properties": { + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project creation datetime." + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project creation datetime." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project last trained datetime." + }, + "lastDeployedDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the project last deployed datetime." + }, + "projectKind": { + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "settings": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings", + "description": "The project settings.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageInputContainerName": { + "type": "string", + "description": "The storage container name in case of conversation summarization.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "projectName": { + "type": "string", + "description": "The new project name.", + "maxLength": 100, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "multilingual": { + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "The project description.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "language": { + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ] + }, + "AnalyzeConversationAuthoringProjectSettings": { + "type": "object", + "description": "Represents the settings used to define the project behavior.", + "properties": { + "confidenceThreshold": { + "type": "number", + "format": "float", + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." + } + }, + "required": [ + "confidenceThreshold" + ] + }, + "AnalyzeConversationAuthoringProjectTrainedModel": { + "type": "object", + "description": "Represents a trained model.", + "properties": { + "label": { + "type": "string", + "description": "The trained model label.", + "readOnly": true + }, + "modelId": { + "type": "string", + "description": "The model ID." + }, + "lastTrainedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last trained date time of the model." + }, + "lastTrainingDurationInSeconds": { + "type": "integer", + "format": "int32", + "description": "The duration of the model's last training request in seconds." + }, + "modelExpirationDate": { + "type": "string", + "format": "date", + "description": "The model expiration date." + }, + "modelTrainingConfigVersion": { + "type": "string", + "description": "The model training config version." + }, + "hasSnapshot": { + "type": "boolean", + "description": "The flag to indicate if the trained model has a snapshot ready." + } + }, + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ] + }, + "AnalyzeConversationAuthoringResourceMetadata": { + "type": "object", + "description": "Represents metadata for the Azure resource..", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Represents the Azure resource ID." + }, + "customDomain": { + "type": "string", + "description": "Represents the Azure resource custom domain." + }, + "region": { + "type": "string", + "description": "Represents the Azure resource region." + } + }, + "required": [ + "azureResourceId", + "customDomain", + "region" + ] + }, + "AnalyzeConversationAuthoringSubTrainingJobState": { + "type": "object", + "description": "Represents the detailed state of a training sub-operation.", + "properties": { + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the start date time." + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the end date time." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "Represents the status of the sub-operation." + } + }, + "required": [ + "percentComplete", + "status" + ] + }, + "AnalyzeConversationAuthoringSupportedLanguage": { + "type": "object", + "description": "Represents a supported language.", + "properties": { + "languageName": { + "type": "string", + "description": "The language name.", + "readOnly": true + }, + "languageCode": { + "type": "string", + "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + } + }, + "required": [ + "languageName", + "languageCode" + ] + }, + "AnalyzeConversationAuthoringSwapDeploymentsJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "AnalyzeConversationAuthoringSwapDeploymentsOptions": { + "type": "object", + "description": "Represents the options for swapping two deployments together.", + "properties": { + "firstDeploymentName": { + "type": "string", + "description": "Represents the first deployment name." + }, + "secondDeploymentName": { + "type": "string", + "description": "Represents the second deployment name." + } + }, + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ] + }, + "AnalyzeConversationAuthoringTrainingConfigVersion": { + "type": "object", + "description": "Represents a training config version.", + "properties": { + "trainingConfigVersion": { + "type": "string", + "description": "Represents the version of the config.", + "readOnly": true + }, + "modelExpirationDate": { + "type": "string", + "format": "date", + "description": "Represents the training config version expiration date." + } + }, + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ] + }, + "AnalyzeConversationAuthoringTrainingJobOptions": { + "type": "object", + "description": "Represents the options for starting a new training job.", + "properties": { + "modelLabel": { + "type": "string", + "description": "Represents the output model label." + }, + "trainingConfigVersion": { + "type": "string", + "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version." + }, + "trainingMode": { + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." + }, + "evaluationOptions": { + "$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions", + "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20." + }, + "dataGenerationSettings": { + "$ref": "#/definitions/AnalyzeConversationAuthoringDataGenerationSettings", + "description": "For customers to populate if they wish to use data generation for their model training job." + } + }, + "required": [ + "modelLabel", + "trainingMode" + ] + }, + "AnalyzeConversationAuthoringTrainingJobResult": { + "type": "object", + "description": "Represents the output of a training job.", + "properties": { + "modelLabel": { + "type": "string", + "description": "Represents trained model label." + }, + "trainingConfigVersion": { + "type": "string", + "description": "Represents training config version." + }, + "trainingMode": { + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." + }, + "trainingStatus": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", + "description": "Represents the model training status." + }, + "dataGenerationStatus": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", + "description": "Represents the model data generation status." + }, + "evaluationStatus": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState", + "description": "Represents model evaluation status." + }, + "estimatedEndDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the estimated end date time for training and evaluation." + } + }, + "required": [ + "modelLabel", + "trainingConfigVersion", + "trainingStatus", + "dataGenerationStatus" + ] + }, + "AnalyzeConversationAuthoringTrainingJobState": { + "type": "object", + "description": "Represents the state of a training job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "result": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobResult", + "description": "Represents training tasks detailed result." + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", + "result" + ] + }, + "AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions": { + "type": "object", + "description": "Represents the options to unassign Azure resources from a project.", + "properties": { + "assignedResourceIds": { + "type": "array", + "description": "Represents the assigned resource IDs to be unassigned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "assignedResourceIds" + ] + }, + "AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult": { + "type": "object", + "description": "Represents the comparison between the expected and predicted entities for an utterance.", + "properties": { + "expectedEntities": { + "type": "array", + "description": "Represents the expected entity labels.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult" + } + }, + "predictedEntities": { + "type": "array", + "description": "Represents the predicted entity labels.", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult" + } + } + }, + "required": [ + "expectedEntities", + "predictedEntities" + ] + }, + "AnalyzeConversationAuthoringUtteranceEntityEvaluationResult": { + "type": "object", + "description": "Represents the evaluation output of an entity label or prediction.", + "properties": { + "category": { + "type": "string", + "description": "Represents the entity category." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Represents the entity offset index relative to the original text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Represents the entity length." + } + }, + "required": [ + "category", + "offset", + "length" + ] + }, + "AnalyzeConversationAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Represents the evaluation result for an utterance.", + "properties": { + "text": { + "type": "string", + "description": "Represents the utterance text.", + "readOnly": true + }, + "language": { + "type": "string", + "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." + }, + "entitiesResult": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult", + "description": "Represents the entities results for the utterance." + }, + "intentsResult": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult", + "description": "Represents the intents results for the utterance." + } + }, + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ] + }, + "AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult": { + "type": "object", + "description": "Represents the comparison between the expected and the predicted intent for an utterance.", + "properties": { + "expectedIntent": { + "type": "string", + "description": "Represents the utterance's expected intent." + }, + "predictedIntent": { + "type": "string", + "description": "Represents the utterance's predicted intent." + } + }, + "required": [ + "expectedIntent", + "predictedIntent" + ] + }, + "AnalyzeConversationExportedAssociatedEntityLabel": { + "type": "object", + "description": "Represents an associated entity label for an intent.", + "properties": { + "category": { + "type": "string", + "description": "The category of the entity label." + } + }, + "required": [ + "category" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + } + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CompositionSetting": { + "type": "string", + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" + ], + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "name": "returnLongestOverlap", + "value": "returnLongestOverlap", + "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." + }, + { + "name": "requireExactOverlap", + "value": "requireExactOverlap", + "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." + }, + { + "name": "separateComponents", + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the entity." + }, + { + "name": "combineComponents", + "value": "combineComponents", + "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." + } + ] + } + }, + "DatasetType": { + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "enum": [ + "Train", + "Test" + ], + "x-ms-enum": { + "name": "DatasetType", + "modelAsString": true, + "values": [ + { + "name": "Train", + "value": "Train", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "name": "Test", + "value": "Test", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "EvaluationKind": { + "type": "string", + "enum": [ + "percentage", + "manual" + ], + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "name": "percentage", + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "name": "manual", + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "ExportedModelOptions": { + "type": "object", + "description": "Represents the options for creating or replacing an exported model.", + "properties": { + "trainedModelLabel": { + "type": "string", + "description": "The trained model label." + } + }, + "required": [ + "trainedModelLabel" + ] + }, + "JobStatus": { + "type": "string", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted" + }, + { + "name": "running", + "value": "running" + }, + { + "name": "succeeded", + "value": "succeeded" + }, + { + "name": "failed", + "value": "failed" + }, + { + "name": "cancelled", + "value": "cancelled" + }, + { + "name": "cancelling", + "value": "cancelling" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted" + } + ] + } + }, + "OrchestrationTargetProjectKind": { + "type": "string", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering" + ], + "x-ms-enum": { + "name": "OrchestrationTargetProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Luis", + "value": "Luis" + }, + { + "name": "Conversation", + "value": "Conversation" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering" + } + ] + } + }, + "PagedAnalyzeConversationAuthoringAssignedDeploymentResource": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringAssignedDeploymentResource items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringAssignedDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedDeploymentResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringExportedTrainedModel": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringExportedTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringExportedTrainedModel items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringExportedTrainedModel" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringPrebuiltEntity": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringPrebuiltEntity items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringPrebuiltEntity items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringPrebuiltEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringProjectDeployment": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringProjectDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringProjectDeployment items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringProjectMetadata": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringProjectMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringProjectMetadata items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringProjectTrainedModel": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringProjectTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringProjectTrainedModel items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringSupportedLanguage": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringSupportedLanguage items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringSupportedLanguage items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringSupportedLanguage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringTrainingConfigVersion": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringTrainingConfigVersion items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringTrainingConfigVersion items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingConfigVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringTrainingJobState": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringTrainingJobState items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringTrainingJobState items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedAnalyzeConversationAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Paged collection of AnalyzeConversationAuthoringUtteranceEvaluationResult items", + "properties": { + "value": { + "type": "array", + "description": "The AnalyzeConversationAuthoringUtteranceEvaluationResult items on this page", + "items": { + "$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEvaluationResult" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProjectKind": { + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + } + }, + "StringIndexType": { + "type": "string", + "enum": [ + "Utf16CodeUnit", + "Utf8CodeUnit", + "Utf32CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + }, + { + "name": "Utf8CodeUnit", + "value": "Utf8CodeUnit" + }, + { + "name": "Utf32CodeUnit", + "value": "Utf32CodeUnit" + } + ] + } + }, + "TrainingMode": { + "type": "string", + "enum": [ + "advanced", + "standard" + ], + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "name": "advanced", + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." + }, + { + "name": "standard", + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ProjectKindQueryParameter": { + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-parameter-location": "method", + "x-ms-client-name": "ProjectKind" + }, + "StringIndexTypeQueryParameter": { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit", + "Utf8CodeUnit", + "Utf32CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + }, + { + "name": "Utf8CodeUnit", + "value": "Utf8CodeUnit" + }, + { + "name": "Utf32CodeUnit", + "value": "Utf32CodeUnit" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "SupportedPrebuiltEntitiesQueryParameter.language": { + "name": "language", + "in": "query", + "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SupportedPrebuiltEntitiesQueryParameter.multilingual": { + "name": "multilingual", + "in": "query", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json new file mode 100644 index 000000000000..a435e5a1c82e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json @@ -0,0 +1,31 @@ +{ + "operationId": "ConversationAuthoringProject_AssignDeploymentResources", + "title": "Successful Assign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "resourcesMetadata": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "customDomain": "lang-test-weu.cognitiveservices.azure.com", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "customDomain": "lang-test-eus.cognitiveservices.azure.com", + "region": "eastus" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..c3bac54d4702 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringProject_CancelTrainingJob", + "title": "Successful Cancel Training Job", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json new file mode 100644 index 000000000000..41c577632647 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationAuthoringProject_CopyProject", + "title": "Successful Copy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json new file mode 100644 index 000000000000..64a202abd0b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationAuthoringProject_CopyProjectAuthorization", + "title": "Successful Copy Project Authorization", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "allowOverwrite": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json new file mode 100644 index 000000000000..7632cae53c42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationAuthoringExportedModel_CreateOrUpdateExportedModel", + "title": "Successful Create Exported Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1", + "body": { + "trainedModelLabel": "model1" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..53b4caeddac3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json @@ -0,0 +1,46 @@ +{ + "operationId": "ConversationAuthoringProject_CreateProject", + "title": "Successful Create Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2025-05-15-preview", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..e7e433aae67a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringDeployment_DeleteDeployment", + "title": "Successful Delete Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json new file mode 100644 index 000000000000..b60b0dff9781 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources", + "title": "Successful Delete Deployment From Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json new file mode 100644 index 000000000000..d95b78d0cf68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringExportedModel_DeleteExportedModel", + "title": "Successful Delete Exported Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..7db8c7aaa28b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json @@ -0,0 +1,14 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel", + "title": "Successful Delete Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..c027454cd829 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "operationId": "ConversationAuthoringProject_DeleteProject", + "title": "Successful Delete Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..558ecfae062c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json @@ -0,0 +1,41 @@ +{ + "operationId": "ConversationAuthoringDeployment_DeployProject", + "title": "Successful Deploy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json new file mode 100644 index 000000000000..bf3ba5dd9665 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_EvaluateModel", + "title": "Successful Evaluation Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "body": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..90cbab3df3c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringProject_Export", + "title": "Successful Export Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..496d921de59c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus", + "title": "Successful Get Assign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json new file mode 100644 index 000000000000..6c7c4db33689 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetCopyProjectStatus", + "title": "Successful Get Copy Project Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..8d8401adc0c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json @@ -0,0 +1,44 @@ +{ + "operationId": "ConversationAuthoringDeployment_GetDeployment", + "title": "Successful Get Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-15-preview", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json new file mode 100644 index 000000000000..3ab793576218 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..fa3b907aef41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringDeployment_GetDeploymentStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json new file mode 100644 index 000000000000..e2db66f43308 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json @@ -0,0 +1,34 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetEvaluationStatus", + "title": "Successful Get Evaluation Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 60, + "testingSplitPercentage": 40 + }, + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "percentComplete": 30 + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..c0e08bbdce29 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringProject_GetExportStatus", + "title": "Successful Get Export Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2025-05-15-preview", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json new file mode 100644 index 000000000000..bee3d7b6f90e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringExportedModel_GetExportedModel", + "title": "Successful Get Exported Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "exportedModelName": "exported-model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2023-04-18T15:47:49Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json new file mode 100644 index 000000000000..146c7095af02 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringExportedModel_GetExportedModelJobStatus", + "title": "Successful Get Exported Model Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2023-04-18T15:44:44Z", + "lastUpdatedDateTime": "2023-04-18T15:45:48Z", + "expirationDateTime": "2023-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..ae448ec3cb84 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetImportStatus", + "title": "Successful Get Import Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..fb66a69173f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..7052d47d9972 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetTrainedModel", + "title": "Successful Get Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..7ab05b79f48f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json @@ -0,0 +1,286 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2025-05-15-preview&top=2147483637&skip=100&maxpagesize=100" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..38c662c35618 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,528 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..31a17667e0cb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json @@ -0,0 +1,26 @@ +{ + "operationId": "ConversationAuthoringProject_GetProject", + "title": "Successful Get Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..5182b4338774 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "operationId": "ConversationAuthoringProject_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..285b8507d662 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,400 @@ +{ + "operationId": "ConversationAuthoringListSupportedLanguages", + "title": "Successful Get Supported Languages", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..a5665ca9e912 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,100 @@ +{ + "operationId": "ConversationAuthoringListSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..ede9a26b0a4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationAuthoringListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..0527074d2585 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..8e40c31168e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,43 @@ +{ + "operationId": "ConversationAuthoringProject_GetTrainingStatus", + "title": "Successful Get Train Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "dataGenerationStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..594e0dd24fd5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus", + "title": "Successful Get Unassign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..77f4b59155c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json @@ -0,0 +1,89 @@ +{ + "operationId": "ConversationAuthoringProject_Import", + "title": "Successful Import Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read", + "description": "The read intent", + "associatedEntities": [ + { + "category": "Sender" + } + ] + }, + { + "category": "Delete", + "description": "The delete intent" + } + ], + "entities": [ + { + "category": "Sender", + "description": "The description of Sender" + }, + { + "category": "Number", + "description": "The description of Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json new file mode 100644 index 000000000000..f8c1e4b62c8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json @@ -0,0 +1,28 @@ +{ + "operationId": "ConversationAuthoringListAssignedResourceDeployments", + "title": "Successful List Assigned Resource Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "projectName": "Booking", + "deploymentsMetadata": [ + { + "deploymentName": "staging", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "deploymentExpirationDate": "2023-10-28" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json new file mode 100644 index 000000000000..8400b97522c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationAuthoringListDeploymentResources", + "title": "Successful List Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..dd4350fff5ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json @@ -0,0 +1,61 @@ +{ + "operationId": "ConversationAuthoringListDeployments", + "title": "Successful List Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus", + "assignedAoaiResource": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + ] + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListExportedModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListExportedModels.json new file mode 100644 index 000000000000..d856f152cd96 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListExportedModels.json @@ -0,0 +1,36 @@ +{ + "operationId": "ConversationAuthoringListExportedModels", + "title": "Successful List Exported Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "exportedModelName": "exported-model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2023-04-18T15:47:49Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "exportedModelName": "exported-model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2023-04-18T17:25:22Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json new file mode 100644 index 000000000000..96808b9bcdad --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationAuthoringListTrainedModels", + "title": "Successful List Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..502463b4f035 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "operationId": "ConversationAuthoringListProjects", + "title": "Successful List Projects", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..f43ed77250a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json @@ -0,0 +1,110 @@ +{ + "operationId": "ConversationAuthoringListTrainingJobs", + "title": "Successful List Training Jobs", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "dataGenerationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "dataGenerationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "dataGenerationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..3075f64097de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationAuthoringTrainedModel_LoadSnapshot", + "title": "Successful Load Snapshot", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..d36d0e0f5204 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationAuthoringProject_SwapDeployments", + "title": "Successful Swap Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..ee6f4e1fb8d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json @@ -0,0 +1,35 @@ +{ + "operationId": "ConversationAuthoringProject_Train", + "title": "Successful Train Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + }, + "dataGenerationSettings": { + "enableDataGeneration": true, + "dataGenerationConnectionInfo": { + "kind": "AzureOpenAI", + "resourceId": "/subscriptions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/resourceGroups/resource-group-name/providers/Microsoft.CognitiveServices/accounts/aoai-account-name", + "deploymentName": "model-deployment-name" + } + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json new file mode 100644 index 000000000000..bf386aeb0d09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/preview/2025-05-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationAuthoringProject_UnassignDeploymentResources", + "title": "Successful Unassign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md index a0b9a7e45320..4b60dc87d3d0 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/readme.md @@ -51,6 +51,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Release 2025-05-15-preview + +These settings apply only when `--tag=release_2025-05-15-preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/analyzeconversations-authoring.json +title: + Microsoft Cognitive Language Service - Conversations Authoring +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2023-04-01 These settings apply only when `--tag=release_2023-04-01` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp index d9c22a0f3388..8371893af780 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeConversationsAuthoring/routes.tsp @@ -67,6 +67,14 @@ op conversationAuthoringListAssignedResourceDeployments is languageOperations.Re */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" @added(Versions.v2025_11_01) +@renamedFrom( + Versions.v2025_05_15_preview, + "conversationAuthoringListProjectResources" +) +@renamedFrom( + Versions.v2025_11_15_preview, + "ConversationAuthoringListDeploymentResources" +) op conversationAuthoringListProjectResources is languageOperations.ResourceList< AnalyzeConversationAuthoringProjectResourceInfo, ListQueryParametersTrait @@ -114,7 +122,7 @@ op conversationAuthoringListTrainedModels is languageOperations.ResourceList< * Lists the exported models belonging to a project. */ #suppress "@azure-tools/typespec-azure-core/use-standard-names" -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) op conversationAuthoringListExportedModels is languageOperations.ResourceList< AnalyzeConversationAuthoringExportedTrainedModel, ListQueryParametersTrait @@ -221,6 +229,14 @@ interface ConversationAuthoringDeployment { */ @body @clientName("details", "csharp") + @typeChangedFrom( + Versions.v2025_05_15_preview, + AnalyzeConversationAuthoringProjectAzureResourceIds + ) + @typeChangedFrom( + Versions.v2025_11_15_preview, + AnalyzeConversationAuthoringDeleteDeploymentOptions + ) body: AnalyzeConversationAuthoringProjectAzureResourceIds; }, AcceptedResponse, @@ -252,6 +268,8 @@ interface ConversationAuthoringProject { ) @access(Access.internal, "python") @added(Versions.v2025_11_01) + @renamedFrom(Versions.v2025_05_15_preview, "assignProjectResources") + @renamedFrom(Versions.v2025_11_15_preview, "AssignDeploymentResources") assignProjectResources is Foundations.LongRunningOperation< { /** @@ -284,6 +302,8 @@ interface ConversationAuthoringProject { ) @access(Access.internal, "python") @added(Versions.v2025_11_01) + @renamedFrom(Versions.v2025_05_15_preview, "unassignProjectResources") + @renamedFrom(Versions.v2025_11_15_preview, "unassignDeploymentResources") unassignProjectResources is Foundations.LongRunningOperation< { /** @@ -298,6 +318,14 @@ interface ConversationAuthoringProject { */ @body @clientName("details", "csharp") + @typeChangedFrom( + Versions.v2025_05_15_preview, + AnalyzeConversationAuthoringProjectAzureResourceIds + ) + @typeChangedFrom( + Versions.v2025_11_15_preview, + AnalyzeConversationAuthoringUnassignDeploymentResourcesOptions + ) body: AnalyzeConversationAuthoringProjectAzureResourceIds; }, AcceptedResponse, @@ -309,6 +337,11 @@ interface ConversationAuthoringProject { * Gets the status of an existing assign project resources job. */ @added(Versions.v2025_11_01) + @renamedFrom(Versions.v2025_05_15_preview, "getAssignProjectResourcesStatus") + @renamedFrom( + Versions.v2025_11_15_preview, + "getAssignDeploymentResourcesStatus" + ) getAssignProjectResourcesStatus is languageOperations.ResourceRead; /** @@ -318,6 +351,14 @@ interface ConversationAuthoringProject { @route("/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}") @get @added(Versions.v2025_11_01) + @renamedFrom( + Versions.v2025_05_15_preview, + "getUnassignProjectResourcesStatus" + ) + @renamedFrom( + Versions.v2025_11_15_preview, + "getUnassignDeploymentResourcesStatus" + ) getUnassignProjectResourcesStatus is Azure.Core.Foundations.Operation< { /** @@ -535,7 +576,7 @@ interface ConversationAuthoringProject { */ #suppress "@azure-tools/typespec-azure-core/casing-style" @post - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) @actionSeparator("/:") @action("authorize-copy") copyProjectAuthorization is languageOperations.ResourceAction< @@ -552,7 +593,7 @@ interface ConversationAuthoringProject { @post @pollingOperation(ConversationAuthoringProject.getCopyProjectStatus) @access(Access.internal, "python") - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) copyProject is Foundations.LongRunningOperation< { /** @@ -577,7 +618,7 @@ interface ConversationAuthoringProject { /** * Gets the status of an existing copy project job. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getCopyProjectStatus is languageOperations.ResourceRead; /** @@ -645,7 +686,7 @@ interface ConversationAuthoringExportedModel { /** * Gets the details of an exported model. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getExportedModel is languageOperations.ResourceRead; /** @@ -657,7 +698,7 @@ interface ConversationAuthoringExportedModel { @pollingOperation( ConversationAuthoringExportedModel.getExportedModelJobStatus ) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) @access(Access.internal, "python") deleteExportedModel is Foundations.LongRunningOperation< { @@ -686,7 +727,7 @@ interface ConversationAuthoringExportedModel { @pollingOperation( ConversationAuthoringExportedModel.getExportedModelJobStatus ) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) @access(Access.internal, "python") createOrUpdateExportedModel is Foundations.LongRunningOperation< { @@ -716,7 +757,7 @@ interface ConversationAuthoringExportedModel { /** * Gets the status for an existing job to create or update an exported model. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getExportedModelJobStatus is languageOperations.ResourceRead; } interface ConversationAuthoringTrainedModel { @@ -737,7 +778,7 @@ interface ConversationAuthoringTrainedModel { @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate") @post @pollingOperation(ConversationAuthoringTrainedModel.getEvaluationStatus) - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) evaluateModel is Foundations.LongRunningOperation< { /** @@ -795,7 +836,7 @@ interface ConversationAuthoringTrainedModel { /** * Gets the status for an evaluation job. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) getEvaluationStatus is languageOperations.ResourceRead; /** diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json new file mode 100644 index 000000000000..0aa480cacbde --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "XYZ-code is a joint representation of human cognition and language, which Microsoft aims to develop for cross-domain transfer learning. Learn how XYz-code can help Microsoft achieve cross-sensory and multilingual learning with human-centric approach.", + "contexts": [ + { + "offset": 0, + "length": 1619 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json new file mode 100644 index 000000000000..754dee836340 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json @@ -0,0 +1,39 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "summaryLength": "medium", + "instruction": "XYZ-code" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskResult.json new file mode 100644 index 000000000000..41581ae7d7d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", + "contexts": [ + { + "offset": 0, + "length": 1629 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskSubmit.json new file mode 100644 index 000000000000..74cf057dcbc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAbstractiveSummarizationTaskSubmit.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "sentenceCount": 1 + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsCancelRequest.json new file mode 100644 index 000000000000..13ad6a087245 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsCancelRequest.json @@ -0,0 +1,17 @@ +{ + "operationId": "AnalyzeTextCancelJob", + "title": "SuccessfulAnalyzeTextJobsCancelRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json new file mode 100644 index 000000000000..eec46a940eaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json @@ -0,0 +1,180 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "EntityRecognitionLROResults", + "taskName": "Recognize Entities", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "type": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip", + "tags": [ + { + "name": "Event", + "confidenceScore": 0.61 + } + ] + }, + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ], + "text": "Seattle" + }, + { + "category": "Temporal", + "type": "DateRange", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "text": "last week", + "tags": [ + { + "name": "DateRange", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "text": "NYC", + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ] + }, + { + "category": "Temporal", + "type": "Date", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "text": "tomorrow", + "tags": [ + { + "name": "Date", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + }, + { + "kind": "CustomEntityRecognitionLROResults", + "taskName": "Recognize US Regions", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.85, + "length": 17, + "offset": 45, + "text": "Pacific Northwest" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.88, + "length": 10, + "offset": 63, + "text": "East Coast" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json new file mode 100644 index 000000000000..8da4921853e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json @@ -0,0 +1,51 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": [ + { + "kind": "EntityRecognition", + "taskName": "Recognize Entities", + "parameters": { + "modelVersion": "latest" + } + }, + { + "kind": "CustomEntityRecognition", + "taskName": "Recognize US Regions", + "parameters": { + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..12939588e3d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,130 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityLinkingRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityLinking", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityLinkingResults", + "results": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..a0a0464c9ad4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionExclusionRequest.json @@ -0,0 +1,136 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "exclusionList": [ + "Numeric" + ], + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Airport", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInclusionRequest.json new file mode 100644 index 000000000000..d9ac4bd22910 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInclusionRequest.json @@ -0,0 +1,133 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inclusionList": [ + "Location" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInferenceOptionsRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInferenceOptionsRequest.json new file mode 100644 index 000000000000..03f9e9c7d832 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionInferenceOptionsRequest.json @@ -0,0 +1,83 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInferenceOptionsRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inferenceOptions": { + "excludeNormalizedValues": true + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ] + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-09-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionOverlapPolicy.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionOverlapPolicy.json new file mode 100644 index 000000000000..a266f02e7e6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionOverlapPolicy.json @@ -0,0 +1,79 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionOverlapPolicy", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "matchLongest" + } + }, + "analysisInput": { + "documents": [ + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.59, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.59 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionRequest.json new file mode 100644 index 000000000000..6b8d169d0594 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulEntityRecognitionRequest.json @@ -0,0 +1,339 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + }, + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + }, + { + "id": "5", + "language": "en", + "text": "My IP is 127.12.1.1 and my phone number is 5555555555" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "AgeMetadata", + "unit": "Year", + "value": 5.0 + } + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "CurrencyMetadata", + "unit": "Dollar", + "iso4217": "USD", + "value": 90.0 + } + } + ], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "10 meters per second", + "category": "Numeric", + "type": "Speed", + "offset": 55, + "length": 20, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Dimension", + "confidenceScore": 0.84 + }, + { + "name": "Numeric", + "confidenceScore": 0.84 + }, + { + "name": "Speed", + "confidenceScore": 0.8 + } + ], + "metadata": { + "metadataKind": "SpeedMetadata", + "unit": "MetersPerSecond", + "value": 10.0 + } + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + }, + { + "entities": [ + { + "text": "25th April", + "category": "Temporal", + "type": "Date", + "offset": 0, + "length": 10, + "confidenceScore": 0.58, + "tags": [ + { + "name": "Temporal", + "confidenceScore": 0.9 + }, + { + "name": "Date", + "confidenceScore": 0.58 + } + ], + "metadata": { + "metadataKind": "DateMetadata", + "dateValues": [ + { + "timex": "XXXX-04-25", + "value": "2022-04-25" + }, + { + "timex": "XXXX-04-25", + "value": "2023-04-25" + } + ] + } + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "CulturalEvent", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "CulturalEvent", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + }, + { + "entities": [ + { + "text": "127.12.1.1", + "category": "IP", + "type": "IP", + "offset": 9, + "length": 10, + "confidenceScore": 0.8, + "tags": [ + { + "name": "IP", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "5555555555", + "category": "PhoneNumber", + "type": "PhoneNumber", + "offset": 45, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "5", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypePostRequest.json new file mode 100644 index 000000000000..3c7aff2de00f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypePostRequest.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcareDocumentTypePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest", + "fhirVersion": "4.0.1", + "documentType": "DischargeSummary" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json new file mode 100644 index 000000000000..5121c8443744 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json @@ -0,0 +1,554 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareDocumentTypeTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-09-06T23:47:43Z", + "displayName": "Providing Document Type", + "expirationDateTime": "2022-09-07T23:47:43Z", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", + "lastUpdatedDateTime": "2022-09-06T23:48:10Z", + "status": "succeeded", + "errors": [], + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "a", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1.0, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1.0 + } + ], + "relations": [ + { + "confidenceScore": 1.0, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1.0, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [], + "fhirBundle": { + "resourceType": "Bundle", + "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", + "meta": { + "profile": [ + "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" + ] + }, + "identifier": { + "system": "urn:ietf:rfc:3986", + "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" + }, + "type": "document", + "entry": [ + { + "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", + "resource": { + "resourceType": "Composition", + "id": "5bd33290-b92e-4aa5-becf-535578207946", + "status": "final", + "type": { + "coding": [ + { + "system": "http://loinc.org", + "code": "18842-5", + "display": "Discharge summary" + } + ], + "text": "Discharge summary" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "date": "2022-09-06", + "author": [ + { + "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "type": "Practitioner", + "display": "Unknown" + } + ], + "title": "Discharge summary", + "section": [ + { + "title": "General", + "code": { + "coding": [ + { + "system": "", + "display": "Unrecognized Section" + } + ], + "text": "General" + }, + "text": { + "status": "additional", + "div": "
      \r\n\t\t\t\t\t\t\t

      General

      \r\n\t\t\t\t\t\t\t

      Prescribed 100mg ibuprofen, taken twice daily.

      \r\n\t\t\t\t\t
      " + }, + "entry": [ + { + "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "type": "List", + "display": "General" + } + ] + } + ] + } + }, + { + "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "resource": { + "resourceType": "Practitioner", + "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", + "name": [ + { + "text": "Unknown", + "family": "Unknown" + } + ] + } + }, + { + "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "resource": { + "resourceType": "Patient", + "id": "efcccdf7-87f0-4061-b553-09fc11734594", + "gender": "unknown" + } + }, + { + "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "resource": { + "resourceType": "Encounter", + "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" + ] + }, + "status": "finished", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "display": "unknown" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "period": { + "start": "2022-09-06", + "end": "2022-09-06" + } + } + }, + { + "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "resource": { + "resourceType": "MedicationStatement", + "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "extension": [ + { + "extension": [ + { + "url": "offset", + "valueInteger": 17 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "status": "active", + "medicationCodeableConcept": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0020740", + "display": "ibuprofen" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000019879" + }, + { + "system": "http://www.whocc.no/atc", + "code": "M01AE01" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0046165" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006519" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2270-2077" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB01050" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "1611" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh97005926" + }, + { + "system": "http://loinc.org", + "code": "LP16165-0" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "40458" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00015" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007052" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "WK2XYI10QM" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", + "code": "00803" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0256857" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "WK2XYI10QM" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000613511" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "002377" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040475" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "x02MO" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "5640" + }, + { + "system": "http://snomed.info/sct", + "code": "E-7772" + }, + { + "system": "http://snomed.info/sct", + "code": "C-603C0" + }, + { + "system": "http://snomed.info/sct", + "code": "387207008" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m39860" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000060" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4017840" + } + ], + "text": "ibuprofen" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "context": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "dosage": [ + { + "text": "100mg", + "timing": { + "repeat": { + "frequency": 2, + "period": 1, + "periodUnit": "d" + }, + "code": { + "text": "twice daily" + } + }, + "doseAndRate": [ + { + "doseQuantity": { + "value": 100 + } + } + ] + } + ] + } + }, + { + "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "resource": { + "resourceType": "List", + "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "status": "current", + "mode": "snapshot", + "title": "General", + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "entry": [ + { + "item": { + "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "type": "MedicationStatement", + "display": "ibuprofen" + } + } + ] + } + } + ] + } + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcarePostRequest.json new file mode 100644 index 000000000000..30793bfedaf2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcarePostRequest.json @@ -0,0 +1,36 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcarePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareTaskStatusRequest.json new file mode 100644 index 000000000000..c6c7999f9355 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulHealthcareTaskStatusRequest.json @@ -0,0 +1,222 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-07-20T18:43:35Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2022-07-21T18:43:35Z", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", + "lastUpdatedDateTime": "2022-07-20T18:43:36Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1 + } + ], + "relations": [ + { + "confidenceScore": 1, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulKeyPhraseExtractionRequest.json new file mode 100644 index 000000000000..1ce055cfabbf --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulKeyPhraseExtractionRequest.json @@ -0,0 +1,73 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulKeyPhraseExtractionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "KeyPhraseExtraction", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "KeyPhraseExtractionResults", + "results": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulLanguageDetectionRequest.json new file mode 100644 index 000000000000..c1de4b0e4cec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulLanguageDetectionRequest.json @@ -0,0 +1,93 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulLanguageDetectionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "LanguageDetection", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + }, + { + "id": "4", + "text": "Tumhara naam kya hai?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "LanguageDetectionResults", + "results": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "3", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "hi", + "name": "Hindi", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-12-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..0aee08e7cbe8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionExclusionRequest.json @@ -0,0 +1,101 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "USSocialSecurityNumber" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionMaskedEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionMaskedEntities.json new file mode 100644 index 000000000000..e4ef9df573d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionMaskedEntities.json @@ -0,0 +1,82 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionMaskedEntitiesRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "entityMask" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My name is John Doe My phone number is 424 878 9192" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My name is [PERSON_1] My phone number is [PHONENUMBER_1]", + "entities": [ + { + "category": "Person", + "type": "Person", + "tags": [ + { + "name": "Person", + "confidenceScore": 0.65 + } + ], + "length": 8, + "offset": 11, + "mask": "[Person_1]", + "maskOffset": 11, + "maskLength": 9, + "text": "John Doe", + "confidenceScore": 0.65 + }, + { + "category": "PhoneNumber", + "type": "PhoneNumber", + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ], + "length": 12, + "offset": 36, + "mask": "[PHONENUMBER_1]", + "maskOffset": 41, + "maskLength": 13, + "text": "424 878 9192", + "confidenceScore": 0.8 + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json new file mode 100644 index 000000000000..a9e6150507c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json @@ -0,0 +1,127 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRedactionPolicyRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "characterMask", + "redactionCharacter": "-" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is -----------", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is -------------- your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRequest.json new file mode 100644 index 000000000000..a293143bcfaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulPiiEntityRecognitionRequest.json @@ -0,0 +1,123 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulSentimentAnalysisRequest.json new file mode 100644 index 000000000000..e64a31f70ffd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/examples/2025-05-15-preview/SuccessfulSentimentAnalysisRequest.json @@ -0,0 +1,150 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulSentimentAnalysisRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "SentimentAnalysis", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "SentimentAnalysisResults", + "results": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp index 387b01ea9105..55401fade381 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/main.tsp @@ -55,6 +55,9 @@ enum Versions { /** Version 2025-11-01 */ v2025_11_01: "2025-11-01", + /** Version 2025-05-15-preview */ + v2025_05_15_preview: "2025-05-15-preview", + /** Version 2025-11-15-preview */ v2025_11_15_preview: "2025-11-15-preview", } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp index 508f95c09b18..74a8d2e3434e 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/common.models.tsp @@ -188,11 +188,11 @@ model AnalyzeTextJobsInput { tasks: AnalyzeTextLROTask[]; /** Default language to use for records requesting automatic language detection. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) defaultLanguage?: string; /** Optional duration in seconds after which the job will be canceled if not completed. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) cancelAfter?: float32; } @@ -358,7 +358,7 @@ model MultiLanguageInput { } /** Defines the detected language for the document. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model DocumentDetectedLanguage { /** If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document. */ detectedLanguage?: DetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp index 0a25676220a4..8273033d9d31 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/custom.text.tsp @@ -29,12 +29,12 @@ model CustomEntitiesLROTask extends AnalyzeTextLROTask { /** Contains the list of detected custom entities result for the documents. */ model CustomEntitiesResult is CustomResult { /** Enumeration of the document results. */ - @typeChangedFrom(Versions.v2025_11_15_preview, EntitiesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, EntitiesDocumentResult[]) documents: EntitiesDocumentResultWithDetectedLanguage[]; } /** Contains the entity recognition task result for the document with detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitiesDocumentResultWithDetectedLanguage { ...EntitiesDocumentResult; ...DocumentDetectedLanguage; @@ -56,7 +56,7 @@ model CustomSingleLabelClassificationLROTask extends AnalyzeTextLROTask { /** Contains the custom label classification results. */ model CustomLabelClassificationResult is CustomResult { /** Response by document */ - @typeChangedFrom(Versions.v2025_11_15_preview, ClassificationDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, ClassificationDocumentResult[]) documents: ClassificationDocumentResultWithDetectedLanguage[]; } @@ -125,7 +125,7 @@ model CustomMultiLabelClassificationLROResult extends AnalyzeTextLROResult { } /** This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @discriminator("entityComponentKind") model EntityComponentInformation { /** Kind of entity component. */ @@ -133,7 +133,7 @@ model EntityComponentInformation { } /** Kind of entity components supported. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union entityComponentKind { string, @@ -148,7 +148,7 @@ union entityComponentKind { } /** This object contains information of the prebuilt component of the detected entity. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model PrebuiltComponent extends EntityComponentInformation { /** Kind of entity component. */ entityComponentKind: entityComponentKind.PrebuiltComponent; @@ -158,7 +158,7 @@ model PrebuiltComponent extends EntityComponentInformation { } /** This object contains information of the learned component of the detected entity. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model LearnedComponent extends EntityComponentInformation { /** Kind of entity component. */ entityComponentKind: entityComponentKind.LearnedComponent; @@ -168,7 +168,7 @@ model LearnedComponent extends EntityComponentInformation { } /** This object contains information of the list component of the detected entity. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ListComponent extends EntityComponentInformation { /** Kind of entity component. */ entityComponentKind: entityComponentKind.ListComponent; @@ -178,7 +178,7 @@ model ListComponent extends EntityComponentInformation { } /** Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union ClassificationType { string, diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp index 3eb1b50e24c6..51e5118ecc36 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.linking.tsp @@ -46,7 +46,7 @@ model EntityLinkingTaskResult extends AnalyzeTextTaskResult { /** Entity linking result. */ model EntityLinkingResult is PreBuiltResult { /** Response by document */ - @typeChangedFrom(Versions.v2025_11_15_preview, LinkedEntitiesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, LinkedEntitiesDocumentResult[]) documents: EntityLinkingResultWithDetectedLanguage[]; } @@ -57,7 +57,7 @@ model LinkedEntitiesDocumentResult is DocumentResult { } /** Entity linking document result with auto language detection. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityLinkingResultWithDetectedLanguage { ...LinkedEntitiesDocumentResult; ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp index ea2adafe59e6..86b9069d7c9d 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/entity.recognition.tsp @@ -56,7 +56,7 @@ model EntitiesTaskResult extends AnalyzeTextTaskResult { kind: AnalyzeTextTaskResultsKind.EntityRecognitionResults; /** Results for entity recognition. */ - @typeChangedFrom(Versions.v2025_11_15_preview, EntitiesResult) + @typeChangedFrom(Versions.v2025_05_15_preview, EntitiesResult) results: EntitiesWithMetadataAutoResult; } @@ -68,7 +68,7 @@ model EntitiesResult is PreBuiltResult { } /** Contains the entity recognition task result. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitiesWithMetadataAutoResult is PreBuiltResult { /** Response by document */ documents: EntitiesDocumentResultWithMetadataDetectedLanguage[]; @@ -81,7 +81,7 @@ model EntitiesDocumentResult is DocumentResult { } /** Contains the entity recognition task result for the document with metadata and detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitiesDocumentResultWithMetadataDetectedLanguage is EntitiesDocumentResultWithMetadata { ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp index 5aebfcd088e2..02b2d239d792 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/healthcare.tsp @@ -76,7 +76,7 @@ model HealthcareLROTask extends AnalyzeTextLROTask { model HealthcareResult is PreBuiltResult { /** List of result objects for the processed Healthcare documents. */ @typeChangedFrom( - Versions.v2025_11_15_preview, + Versions.v2025_05_15_preview, HealthcareEntitiesDocumentResult[] ) documents: HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage[]; @@ -488,7 +488,7 @@ model HealthcareLROResult extends AnalyzeTextLROResult { } /** Result object for the processed Healthcare document with detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage is HealthcareEntitiesDocumentResult { ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp index 6d947d6fafee..7ac1bf0ac4e6 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/key.phrase.extraction.tsp @@ -43,7 +43,7 @@ model KeyPhraseTaskResult extends AnalyzeTextTaskResult { @doc("Contains the KeyPhraseResult.") model KeyPhraseResult is PreBuiltResult { @doc("Response by document") - @typeChangedFrom(Versions.v2025_11_15_preview, KeyPhrasesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, KeyPhrasesDocumentResult[]) documents: KeyPhrasesDocumentResultWithDetectedLanguage[]; } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp index fcc647d9b5d2..6dfd509622cf 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/pii.entity.recognition.tsp @@ -32,15 +32,20 @@ model PiiTaskParameters is PreBuiltTaskParametersLoggingOptOut { stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; /** Enumeration of PII categories to be excluded in the response. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) excludePiiCategories?: PiiCategoriesExclude[]; + /** RedactionPolicy to be used on the input. */ + @added(Versions.v2025_05_15_preview) + @removed(Versions.v2025_11_15_preview) + redactionPolicy?: BaseRedactionPolicy; + /** Policy for specific words and terms that should be excluded from detection by the PII detection service */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) valueExclusionPolicy?: ValueExclusionPolicy; /** (Optional) request parameter that allows the user to provide synonyms for context words that to enhance pii entity detection. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) entitySynonyms?: EntitySynonyms[]; /** List of RedactionPolicies to be used on the input. */ @@ -57,7 +62,7 @@ model PiiTaskParameters is PreBuiltTaskParametersLoggingOptOut { } /** Object that allows the user to provide synonyms for context words that to enhance pii entity detection. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitySynonyms { /** The entity name */ entityType: EntityCategory; @@ -90,7 +95,7 @@ model ConfidenceScoreThresholdOverride { } /** The entity synonyms used to enhance pii entity detection */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntitySynonym { /** The synonym to be used for context */ synonym: string; @@ -100,7 +105,7 @@ model EntitySynonym { } /** Policy for specific words and terms that should be excluded from detection by the PII detection service */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ValueExclusionPolicy { /** Option to make the values excluded values case sensitive */ caseSensitive: boolean = false; @@ -110,7 +115,7 @@ model ValueExclusionPolicy { } /** The abstract base class for RedactionPolicy. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) @discriminator("policyKind") model BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ @@ -130,7 +135,7 @@ model BaseRedactionPolicy { } /** Represents the policy of redacting with a redaction character */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model CharacterMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.characterMask; @@ -158,21 +163,21 @@ model SyntheticReplacementPolicyType extends BaseRedactionPolicy { } /** Represents the policy of not redacting found PII. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model NoMaskPolicyType extends BaseRedactionPolicy { /** The entity RedactionPolicy object kind. */ policyKind: RedactionPolicyKind.noMask; } /** Represents the policy of redacting PII with the entity type. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model EntityMaskPolicyType extends BaseRedactionPolicy { /** The entity OverlapPolicy object kind. */ policyKind: RedactionPolicyKind.entityMask; } /** Kinds of redaction policies supported. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) union RedactionPolicyKind { string, @@ -214,7 +219,7 @@ model PiiTaskResult extends AnalyzeTextTaskResult { #suppress "@azure-tools/typespec-azure-core/casing-style" model PiiResult is PreBuiltResult { /** Response by document */ - @typeChangedFrom(Versions.v2025_11_15_preview, PiiEntitiesDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, PiiEntitiesDocumentResult[]) documents: PiiResultWithDetectedLanguage[]; } @@ -239,15 +244,15 @@ model PiiEntityWithTags is Entity { tags?: EntityTag[]; /** Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) mask?: string; /** Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskOffset?: int32; /** The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) maskLength?: int32; } @@ -258,7 +263,7 @@ model PiiEntitiesDocumentResult is DocumentResult { redactedText: string; /** Recognized entities in the document. */ - @typeChangedFrom(Versions.v2025_11_15_preview, Entity[]) + @typeChangedFrom(Versions.v2025_05_15_preview, Entity[]) entities: PiiEntityWithTags[]; } @@ -825,7 +830,7 @@ union PiiCategoriesExclude { DriversLicenseNumber: "DriversLicenseNumber", /** Neighborhood */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) Neighborhood: "Neighborhood", /** Sort Code. 6-digit number used in the UK to identify a specific bank and branch where a bank account is held */ @@ -833,19 +838,21 @@ union PiiCategoriesExclude { SortCode: "SortCode", /** PIN */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) PIN: "PIN", /** VIN */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) VIN: "VIN", /** VIN */ @added(Versions.v2025_11_01) + @removed(Versions.v2025_05_15_preview) + @added(Versions.v2025_11_15_preview) VehicleIdentificationNumber: "VehicleIdentificationNumber", /** License Plate */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) LicensePlate: "LicensePlate", /** KR Passport Number */ diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp index 20a894fbd0ea..61cb593eb7e8 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/sentiment.analysis.tsp @@ -77,7 +77,7 @@ union TokenSentimentValue { /** Sentiment analysis results for the input documents. */ model SentimentResponse is PreBuiltResult { /** The sentiment analysis results for each document in the input. */ - @typeChangedFrom(Versions.v2025_11_15_preview, SentimentDocumentResult[]) + @typeChangedFrom(Versions.v2025_05_15_preview, SentimentDocumentResult[]) documents: SentimentDocumentResultWithDetectedLanguage[]; } diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp index 3f52b2512cb8..ffd7382096bc 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/models/summarization.tsp @@ -19,7 +19,7 @@ model ExtractiveSummarizationTaskParameters is PreBuiltTaskParameters { stringIndexType?: StringIndexType = StringIndexType.TextElements_v8; /** (Optional) If provided, the query will be used to extract most relevant sentences from the document. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) query?: string; } @@ -40,7 +40,7 @@ model ExtractiveSummarizationResult is PreBuiltResult { /** Response by document */ @added(Versions.v2023_04_01) @typeChangedFrom( - Versions.v2025_11_15_preview, + Versions.v2025_05_15_preview, ExtractedSummaryDocumentResult[] ) documents: ExtractedSummaryDocumentResultWithDetectedLanguage[]; @@ -66,7 +66,7 @@ model ExtractedSummaryDocumentResult is DocumentResult { } /** A ranked list of sentences representing the extracted summary. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model ExtractedSummaryDocumentResultWithDetectedLanguage is ExtractedSummaryDocumentResult { ...DocumentDetectedLanguage; @@ -116,7 +116,7 @@ model AbstractiveSummarizationTaskParameters is PreBuiltTaskParameters { ...AbstractiveSummarizationTaskParametersBase; /** (Optional) If provided, the query will be used to generate the summary. */ - @added(Versions.v2025_11_15_preview) + @added(Versions.v2025_05_15_preview) instruction?: string; } @@ -137,7 +137,7 @@ model AbstractiveSummarizationResultBase { /** Response by document */ @added(Versions.v2023_04_01) @typeChangedFrom( - Versions.v2025_11_15_preview, + Versions.v2025_05_15_preview, AbstractiveSummaryDocumentResult[] ) documents: AbstractiveSummaryDocumentResultWithDetectedLanguage[]; @@ -157,7 +157,7 @@ model AbstractiveSummaryDocumentResult is DocumentResult { } /** An object representing the Abstractive Summarization result of a single document with detected language. */ -@added(Versions.v2025_11_15_preview) +@added(Versions.v2025_05_15_preview) model AbstractiveSummaryDocumentResultWithDetectedLanguage is AbstractiveSummaryDocumentResult { ...DocumentDetectedLanguage; diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/analyzetext.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/analyzetext.json new file mode 100644 index 000000000000..960a3761b802 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/analyzetext.json @@ -0,0 +1,9866 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Text Analysis", + "version": "2025-05-15-preview", + "description": "The language service API is a suite of natural language processing (NLP) skills 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, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/azure/cognitive-services/language-service/overview.0", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], + "paths": { + "/:analyze-text": { + "post": { + "operationId": "AnalyzeText", + "description": "Request text analysis over a collection of documents.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" + }, + { + "name": "body", + "in": "body", + "description": "The input documents to analyze.", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeTextTask" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulEntityLinkingRequest": { + "$ref": "./examples/SuccessfulEntityLinkingRequest.json" + }, + "SuccessfulEntityRecognitionExclusionRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionExclusionRequest.json" + }, + "SuccessfulEntityRecognitionInclusionRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionInclusionRequest.json" + }, + "SuccessfulEntityRecognitionInferenceOptionsRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json" + }, + "SuccessfulEntityRecognitionOverlapPolicy": { + "$ref": "./examples/SuccessfulEntityRecognitionOverlapPolicy.json" + }, + "SuccessfulEntityRecognitionRequest": { + "$ref": "./examples/SuccessfulEntityRecognitionRequest.json" + }, + "SuccessfulKeyPhraseExtractionRequest": { + "$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json" + }, + "SuccessfulLanguageDetectionRequest": { + "$ref": "./examples/SuccessfulLanguageDetectionRequest.json" + }, + "SuccessfulPiiEntityRecognitionExclusionRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionExclusionRequest.json" + }, + "SuccessfulPiiEntityRecognitionMaskedEntitiesRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionMaskedEntities.json" + }, + "SuccessfulPiiEntityRecognitionRedactionPolicyRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json" + }, + "SuccessfulPiiEntityRecognitionRequest": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json" + }, + "SuccessfulSentimentAnalysisRequest": { + "$ref": "./examples/SuccessfulSentimentAnalysisRequest.json" + } + } + } + }, + "/analyze-text/jobs": { + "post": { + "operationId": "AnalyzeTextSubmitJob", + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeTextJobsInput" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json" + }, + "SuccessfulAbstractiveSummarizationTaskSubmit": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationTaskSubmit.json" + }, + "SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" + }, + "SuccessfulHealthcareDocumentTypePostRequest": { + "$ref": "./examples/SuccessfulHealthcareDocumentTypePostRequest.json" + }, + "SuccessfulHealthcarePostRequest": { + "$ref": "./examples/SuccessfulHealthcarePostRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-text/jobs/{jobId}": { + "get": { + "operationId": "AnalyzeTextJobStatus", + "summary": "Get analysis status and results", + "description": "Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "job ID", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "required": false, + "type": "boolean" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeTextJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json" + }, + "SuccessfulAbstractiveSummarizationTaskResult": { + "$ref": "./examples/SuccessfulAbstractiveSummarizationTaskResult.json" + }, + "SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" + }, + "SuccessfulHealthcareDocumentTypeTaskStatusRequest": { + "$ref": "./examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json" + }, + "SuccessfulHealthcareTaskStatusRequest": { + "$ref": "./examples/SuccessfulHealthcareTaskStatusRequest.json" + } + } + } + }, + "/analyze-text/jobs/{jobId}:cancel": { + "post": { + "operationId": "AnalyzeTextCancelJob", + "summary": "Cancel a long-running Text Analysis job.", + "description": "Cancel a long-running Text Analysis job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID to cancel.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "SuccessfulAnalyzeTextJobsCancelRequest": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AbstractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Abstractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/AbstractiveSummarizationResult", + "description": "Results of the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarizationLROResults" + }, + "AbstractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Abstractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/AbstractiveSummarizationTaskParameters", + "description": "Parameters for the Abstractive Summarization task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarization" + }, + "AbstractiveSummarizationResult": { + "type": "object", + "description": "An object representing the pre-built Abstractive Summarization results of each document.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/AbstractiveSummaryDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "AbstractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for the pre-built Abstractive Summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "Controls the approximate number of sentences in the output summaries." + }, + "stringIndexType": { + "type": "string", + "description": "String index type", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "summaryLength": { + "$ref": "#/definitions/SummaryLengthBucket", + "description": "(NOTE: Recommended to use summaryLength over sentenceCount) Controls the approximate length of the output summaries." + }, + "instruction": { + "type": "string", + "description": "(Optional) If provided, the query will be used to generate the summary." + } + } + }, + "AbstractiveSummary": { + "type": "object", + "description": "An object representing a single summary with context for given document.", + "properties": { + "text": { + "type": "string", + "description": "The text of the summary." + }, + "contexts": { + "type": "array", + "description": "The context list of the summary.", + "items": { + "$ref": "#/definitions/SummaryContext" + } + } + }, + "required": [ + "text" + ] + }, + "AbstractiveSummaryDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "An object representing the Abstractive Summarization result of a single document with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "summaries": { + "type": "array", + "description": "A list of abstractive summaries.", + "items": { + "$ref": "#/definitions/AbstractiveSummary" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "summaries" + ] + }, + "AgeMetadata": { + "type": "object", + "description": "Represents the Age entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AgeUnit", + "description": "Unit of measure for age." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "AgeMetadata" + }, + "AgeUnit": { + "type": "string", + "description": "The Age Unit of measurement", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified time period" + }, + { + "name": "Year", + "value": "Year", + "description": "Time period of a year" + }, + { + "name": "Month", + "value": "Month", + "description": "Time period of a month" + }, + { + "name": "Week", + "value": "Week", + "description": "Time period of a week" + }, + { + "name": "Day", + "value": "Day", + "description": "Time period of a day" + } + ] + } + }, + "AllowOverlapEntityPolicyType": { + "type": "object", + "description": "Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection", + "allOf": [ + { + "$ref": "#/definitions/BaseEntityOverlapPolicy" + } + ], + "x-ms-discriminator-value": "allowOverlap" + }, + "AnalyzeTextEntityLinkingInput": { + "type": "object", + "description": "Contains the analyze text Entity linking input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the analysis input to be handled by the service." + }, + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "AnalyzeTextEntityRecognitionInput": { + "type": "object", + "description": "The entity recognition analyze text input task request.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "The input to be analyzed." + }, + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "AnalyzeTextJobState": { + "type": "object", + "description": "The object containing the analyze job LRO job state.", + "properties": { + "displayName": { + "type": "string", + "description": "display name" + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job created" + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "Date and time job expires" + }, + "jobId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "job ID", + "readOnly": true + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "last updated date and time" + }, + "status": { + "$ref": "#/definitions/State", + "description": "status" + }, + "errors": { + "type": "array", + "description": "errors", + "items": { + "$ref": "#/definitions/Error" + } + }, + "nextLink": { + "type": "string", + "description": "next link" + }, + "tasks": { + "$ref": "#/definitions/Tasks", + "description": "List of tasks." + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + } + }, + "required": [ + "createdDateTime", + "jobId", + "lastUpdatedDateTime", + "status", + "tasks" + ] + }, + "AnalyzeTextJobsInput": { + "type": "object", + "description": "The input object for the analyze text LRO.", + "properties": { + "displayName": { + "type": "string", + "description": "Name for the task." + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input to be analyzed." + }, + "tasks": { + "type": "array", + "description": "List of tasks to be performed as part of the LRO.", + "items": { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + }, + "defaultLanguage": { + "type": "string", + "description": "Default language to use for records requesting automatic language detection." + }, + "cancelAfter": { + "type": "number", + "format": "float", + "description": "Optional duration in seconds after which the job will be canceled if not completed." + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "AnalyzeTextKeyPhraseExtractionInput": { + "type": "object", + "description": "Contains the analyze text KeyPhraseExtraction task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input documents." + }, + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters", + "description": "Key phrase extraction task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "AnalyzeTextLROResult": { + "type": "object", + "description": "Contains the AnalyzeText long running operation result object.", + "properties": { + "lastUpdateDateTime": { + "type": "string", + "format": "date-time", + "description": "The last updated time in UTC for the task." + }, + "status": { + "$ref": "#/definitions/State", + "description": "The status of the task at the mentioned last update time." + }, + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeTextLROResultsKind", + "description": "Kind of the task." + } + }, + "discriminator": "kind", + "required": [ + "lastUpdateDateTime", + "status", + "kind" + ] + }, + "AnalyzeTextLROResultsKind": { + "type": "string", + "description": "The kind of the response object returned by the analyze-text long running task.", + "enum": [ + "SentimentAnalysisLROResults", + "EntityRecognitionLROResults", + "PiiEntityRecognitionLROResults", + "KeyPhraseExtractionLROResults", + "EntityLinkingLROResults", + "HealthcareLROResults", + "CustomEntityRecognitionLROResults", + "CustomSingleLabelClassificationLROResults", + "CustomMultiLabelClassificationLROResults", + "ExtractiveSummarizationLROResults", + "AbstractiveSummarizationLROResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROResultsKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysisLROResults", + "value": "SentimentAnalysisLROResults", + "description": "Sentiment analysis LRO results" + }, + { + "name": "EntityRecognitionLROResults", + "value": "EntityRecognitionLROResults", + "description": "Entity recognition LRO results" + }, + { + "name": "PiiEntityRecognitionLROResults", + "value": "PiiEntityRecognitionLROResults", + "description": "PII entity recognition LRO results" + }, + { + "name": "KeyPhraseExtractionLROResults", + "value": "KeyPhraseExtractionLROResults", + "description": "Key phrase extraction LRO results" + }, + { + "name": "EntityLinkingLROResults", + "value": "EntityLinkingLROResults", + "description": "Entity linking LRO results" + }, + { + "name": "HealthcareLROResults", + "value": "HealthcareLROResults", + "description": "Healthcare LRO results" + }, + { + "name": "CustomEntityRecognitionLROResults", + "value": "CustomEntityRecognitionLROResults", + "description": "Custom entity recognition LRO results" + }, + { + "name": "CustomSingleLabelClassificationLROResults", + "value": "CustomSingleLabelClassificationLROResults", + "description": "Custom single label classification LRO results" + }, + { + "name": "CustomMultiLabelClassificationLROResults", + "value": "CustomMultiLabelClassificationLROResults", + "description": "Custom multi label classification LRO results" + }, + { + "name": "ExtractiveSummarizationLROResults", + "value": "ExtractiveSummarizationLROResults", + "description": "Extractive summarization LRO results" + }, + { + "name": "AbstractiveSummarizationLROResults", + "value": "AbstractiveSummarizationLROResults", + "description": "Abstractive summarization LRO results" + } + ] + } + }, + "AnalyzeTextLROTask": { + "type": "object", + "description": "The long running task to be performed by the service on the input documents.", + "properties": { + "taskName": { + "type": "string", + "description": "task name" + }, + "kind": { + "$ref": "#/definitions/AnalyzeTextLROTaskKind", + "description": "The kind of task to perform." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeTextLROTaskKind": { + "type": "string", + "description": "The kind of the long running analyze text tasks supported.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "EntityLinking", + "Healthcare", + "CustomEntityRecognition", + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "ExtractiveSummarization", + "AbstractiveSummarization" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROTaskKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysis", + "value": "SentimentAnalysis", + "description": "Sentiment analysis task" + }, + { + "name": "EntityRecognition", + "value": "EntityRecognition", + "description": "Entity recognition task" + }, + { + "name": "PiiEntityRecognition", + "value": "PiiEntityRecognition", + "description": "PII entity recognition task" + }, + { + "name": "KeyPhraseExtraction", + "value": "KeyPhraseExtraction", + "description": "Key phrase extraction task" + }, + { + "name": "EntityLinking", + "value": "EntityLinking", + "description": "Entity linking task" + }, + { + "name": "Healthcare", + "value": "Healthcare", + "description": "Healthcare task" + }, + { + "name": "CustomEntityRecognition", + "value": "CustomEntityRecognition", + "description": "Custom entity recognition task" + }, + { + "name": "CustomSingleLabelClassification", + "value": "CustomSingleLabelClassification", + "description": "Custom single label classification task" + }, + { + "name": "CustomMultiLabelClassification", + "value": "CustomMultiLabelClassification", + "description": "Custom multi label classification task" + }, + { + "name": "ExtractiveSummarization", + "value": "ExtractiveSummarization", + "description": "Extractive summarization task" + }, + { + "name": "AbstractiveSummarization", + "value": "AbstractiveSummarization", + "description": "Abstractive summarization task" + } + ] + } + }, + "AnalyzeTextLanguageDetectionInput": { + "type": "object", + "description": "Contains the language detection document analysis task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/LanguageDetectionAnalysisInput", + "description": "Documents to be analyzed." + }, + "parameters": { + "$ref": "#/definitions/LanguageDetectionTaskParameters", + "description": "task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "LanguageDetection" + }, + "AnalyzeTextPiiEntitiesRecognitionInput": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input documents." + }, + "parameters": { + "$ref": "#/definitions/PiiTaskParameters", + "description": "Pii task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "AnalyzeTextSentimentAnalysisInput": { + "type": "object", + "description": "Contains the analyze text SentimentAnalysis task input.", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput", + "description": "Contains the input documents." + }, + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters", + "description": "Sentiment Analysis task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "AnalyzeTextTask": { + "type": "object", + "description": "Collection of documents to analyze and a single task to execute.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskKind", + "description": "The kind of task to perform." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeTextTaskKind": { + "type": "string", + "description": "The kind of the analyze-text tasks supported.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "LanguageDetection", + "EntityLinking" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysis", + "value": "SentimentAnalysis", + "description": "Sentiment analysis task" + }, + { + "name": "EntityRecognition", + "value": "EntityRecognition", + "description": "Entity recognition task" + }, + { + "name": "PiiEntityRecognition", + "value": "PiiEntityRecognition", + "description": "PII entity recognition task" + }, + { + "name": "KeyPhraseExtraction", + "value": "KeyPhraseExtraction", + "description": "Key phrase extraction task" + }, + { + "name": "LanguageDetection", + "value": "LanguageDetection", + "description": "Language detection task" + }, + { + "name": "EntityLinking", + "value": "EntityLinking", + "description": "Entity linking task" + } + ] + } + }, + "AnalyzeTextTaskResult": { + "type": "object", + "description": "The result object for the analyze task.", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskResultsKind", + "description": "The kind of task result." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AnalyzeTextTaskResultsKind": { + "type": "string", + "description": "The kind of the response object returned by the analyze-text task.", + "enum": [ + "SentimentAnalysisResults", + "EntityRecognitionResults", + "PiiEntityRecognitionResults", + "KeyPhraseExtractionResults", + "LanguageDetectionResults", + "EntityLinkingResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskResultsKind", + "modelAsString": true, + "values": [ + { + "name": "SentimentAnalysisResults", + "value": "SentimentAnalysisResults", + "description": "Sentiment analysis results" + }, + { + "name": "EntityRecognitionResults", + "value": "EntityRecognitionResults", + "description": "Entity recognition results" + }, + { + "name": "PiiEntityRecognitionResults", + "value": "PiiEntityRecognitionResults", + "description": "PII entity recognition results" + }, + { + "name": "KeyPhraseExtractionResults", + "value": "KeyPhraseExtractionResults", + "description": "Key phrase extraction results" + }, + { + "name": "LanguageDetectionResults", + "value": "LanguageDetectionResults", + "description": "Language detection results" + }, + { + "name": "EntityLinkingResults", + "value": "EntityLinkingResults", + "description": "Entity linking results" + } + ] + } + }, + "AreaMetadata": { + "type": "object", + "description": "Represents the Area entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/AreaUnit", + "description": "Unit of measure for area." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "AreaMetadata" + }, + "AreaUnit": { + "type": "string", + "description": "The area unit of measurement.", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified area unit" + }, + { + "name": "SquareKilometer", + "value": "SquareKilometer", + "description": "Area unit in square kilometers" + }, + { + "name": "SquareHectometer", + "value": "SquareHectometer", + "description": "Area unit in square hectometers" + }, + { + "name": "SquareDecameter", + "value": "SquareDecameter", + "description": "Area unit in square decameters" + }, + { + "name": "SquareDecimeter", + "value": "SquareDecimeter", + "description": "Area unit in square decimeters" + }, + { + "name": "SquareMeter", + "value": "SquareMeter", + "description": "Area unit in square meters" + }, + { + "name": "SquareCentimeter", + "value": "SquareCentimeter", + "description": "Area unit in square centimeters" + }, + { + "name": "SquareMillimeter", + "value": "SquareMillimeter", + "description": "Area unit in square millimeters" + }, + { + "name": "SquareInch", + "value": "SquareInch", + "description": "Area unit in square inches" + }, + { + "name": "SquareFoot", + "value": "SquareFoot", + "description": "Area unit in square feet" + }, + { + "name": "SquareMile", + "value": "SquareMile", + "description": "Area unit in square miles" + }, + { + "name": "SquareYard", + "value": "SquareYard", + "description": "Area unit in square yards" + }, + { + "name": "Acre", + "value": "Acre", + "description": "Area unit in acres" + } + ] + } + }, + "Association": { + "type": "string", + "description": "Describes if the entity is the subject of the text or if it describes someone else.", + "enum": [ + "subject", + "other" + ], + "x-ms-enum": { + "name": "Association", + "modelAsString": false, + "values": [ + { + "name": "subject", + "value": "subject", + "description": "Subject association" + }, + { + "name": "other", + "value": "other", + "description": "Other association" + } + ] + } + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "BaseEntityOverlapPolicy": { + "type": "object", + "description": "The abstract base class for entity OverlapPolicy.", + "properties": { + "policyKind": { + "type": "string", + "description": "The entity OverlapPolicy object kind.", + "default": "matchLongest", + "enum": [ + "matchLongest", + "allowOverlap" + ], + "x-ms-enum": { + "name": "policyKind", + "modelAsString": true, + "values": [ + { + "name": "matchLongest", + "value": "matchLongest", + "description": "Represents MatchLongestEntityPolicyType" + }, + { + "name": "allowOverlap", + "value": "allowOverlap", + "description": "Represents AllowOverlapEntityPolicyType" + } + ] + } + } + }, + "discriminator": "policyKind", + "required": [ + "policyKind" + ] + }, + "BaseMetadata": { + "type": "object", + "description": "The abstract base class for entity Metadata.", + "properties": { + "metadataKind": { + "$ref": "#/definitions/MetadataKind", + "description": "The entity Metadata object kind." + } + }, + "discriminator": "metadataKind", + "required": [ + "metadataKind" + ] + }, + "BaseRedactionPolicy": { + "type": "object", + "description": "The abstract base class for RedactionPolicy.", + "properties": { + "policyKind": { + "type": "string", + "description": "The entity RedactionPolicy object kind.", + "default": "characterMask", + "enum": [ + "noMask", + "characterMask", + "entityMask" + ], + "x-ms-enum": { + "name": "RedactionPolicyKind", + "modelAsString": true, + "values": [ + { + "name": "noMask", + "value": "noMask", + "description": "Do not redact detected entities." + }, + { + "name": "characterMask", + "value": "characterMask", + "description": "React detected entities with redaction character." + }, + { + "name": "entityMask", + "value": "entityMask", + "description": "Redact detected entities with entity type." + } + ] + } + } + }, + "discriminator": "policyKind", + "required": [ + "policyKind" + ] + }, + "Certainty": { + "type": "string", + "description": "Describes the entities certainty and polarity.", + "enum": [ + "positive", + "positivePossible", + "neutralPossible", + "negativePossible", + "negative" + ], + "x-ms-enum": { + "name": "Certainty", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive certainty" + }, + { + "name": "positivePossible", + "value": "positivePossible", + "description": "Possibly positive certainty" + }, + { + "name": "neutralPossible", + "value": "neutralPossible", + "description": "Possibly neutral certainty" + }, + { + "name": "negativePossible", + "value": "negativePossible", + "description": "Possibly negative certainty" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative certainty" + } + ] + } + }, + "CharacterMaskPolicyType": { + "type": "object", + "description": "Represents the policy of redacting with a redaction character", + "properties": { + "redactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will bce * as before. We allow specific ascii characters for redaction.", + "default": "*", + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ], + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true, + "values": [ + { + "name": "exclamationPoint", + "value": "!", + "description": "Exclamation point character" + }, + { + "name": "numberSign", + "value": "#", + "description": "Number sign character" + }, + { + "name": "dollar", + "value": "$", + "description": "Dollar sign character" + }, + { + "name": "perCent", + "value": "%", + "description": "Percent sign character" + }, + { + "name": "ampersand", + "value": "&", + "description": "Ampersand character" + }, + { + "name": "asterisk", + "value": "*", + "description": "Asterisk character" + }, + { + "name": "plus", + "value": "+", + "description": "Plus sign character" + }, + { + "name": "minus", + "value": "-", + "description": "Minus sign character" + }, + { + "name": "equals", + "value": "=", + "description": "Equals sign character" + }, + { + "name": "questionMark", + "value": "?", + "description": "Question mark character" + }, + { + "name": "atSign", + "value": "@", + "description": "At sign character" + }, + { + "name": "caret", + "value": "^", + "description": "Caret character" + }, + { + "name": "underscore", + "value": "_", + "description": "Underscore character" + }, + { + "name": "tilde", + "value": "~", + "description": "Tilde character" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "characterMask" + }, + "ClassificationDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Contains the classification doc result for the task with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "class": { + "type": "array", + "description": "Contains the classification doc results for all docs.", + "items": { + "$ref": "#/definitions/ClassificationResult" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "class" + ] + }, + "ClassificationResult": { + "type": "object", + "description": "Contains the classification result.", + "properties": { + "category": { + "type": "string", + "description": "Classification type." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the recognized class." + } + }, + "required": [ + "category", + "confidenceScore" + ] + }, + "Conditionality": { + "type": "string", + "description": "Describes any conditionality on the entity.", + "enum": [ + "hypothetical", + "conditional" + ], + "x-ms-enum": { + "name": "Conditionality", + "modelAsString": false, + "values": [ + { + "name": "hypothetical", + "value": "hypothetical", + "description": "Hypothetical conditionality" + }, + { + "name": "conditional", + "value": "conditional", + "description": "Conditional conditionality" + } + ] + } + }, + "CurrencyMetadata": { + "type": "object", + "description": "Represents the Currency ) entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "type": "string", + "description": "Currency unit." + }, + "iso4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "CurrencyMetadata" + }, + "CustomEntitiesLROTask": { + "type": "object", + "description": "Contains the custom text LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomEntitiesTaskParameters", + "description": "task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomEntityRecognition" + }, + "CustomEntitiesResult": { + "type": "object", + "description": "Contains the list of detected custom entities result for the documents.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "documents": { + "type": "array", + "description": "Enumeration of the document results.", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "projectName", + "deploymentName", + "documents" + ] + }, + "CustomEntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Entities task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "stringIndexType": { + "type": "string", + "description": "Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "CustomEntityRecognitionLROResult": { + "type": "object", + "description": "Contains the custom entity recognition job result.", + "properties": { + "results": { + "$ref": "#/definitions/CustomEntitiesResult", + "description": "List of results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" + }, + "CustomLabelClassificationResult": { + "type": "object", + "description": "Contains the custom label classification results.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ClassificationDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "projectName", + "deploymentName", + "documents" + ] + }, + "CustomMultiLabelClassificationLROResult": { + "type": "object", + "description": "Contains the custom multi label classification job result.", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult", + "description": "List of results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" + }, + "CustomMultiLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into multi label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomMultiLabelClassification" + }, + "CustomMultiLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Multi Classification task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "CustomSingleLabelClassificationLROResult": { + "type": "object", + "description": "Contains the custom single label classification job result.", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult", + "description": "List of results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" + }, + "CustomSingleLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into single label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters", + "description": "Task parameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomSingleLabelClassification" + }, + "CustomSingleLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Single Classification task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "DateMetadata": { + "type": "object", + "description": "A Metadata for date entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "DateMetadata" + }, + "DateTimeMetadata": { + "type": "object", + "description": "A Metadata for datetime entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "DateTimeMetadata" + }, + "DateValue": { + "type": "object", + "description": "Represents the date value.", + "properties": { + "timex": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "Modifier for datetime to indicate point of reference like before, after etc." + } + }, + "required": [ + "timex", + "value" + ] + }, + "DetectedLanguage": { + "type": "object", + "description": "Contains the details of the detected language for the text.", + "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)." + }, + "confidenceScore": { + "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." + }, + "scriptName": { + "$ref": "#/definitions/ScriptKind", + "description": "Identifies the script name of the input document according to the ISO 15924 standard." + }, + "scriptIso15924Code": { + "$ref": "#/definitions/ScriptCode", + "description": "Identifies the script code of the input document according to the ISO 15924 standard." + } + }, + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ] + }, + "DocumentError": { + "type": "object", + "description": "Contains details of errors encountered during a job execution.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the input document." + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Error encountered." + } + }, + "required": [ + "id", + "error" + ] + }, + "DocumentSentimentValue": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive statement" + }, + { + "name": "neutral", + "value": "neutral", + "description": "Neutral statement" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative statement" + }, + { + "name": "mixed", + "value": "mixed", + "description": "Mixed statement" + } + ] + } + }, + "DocumentStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "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." + } + }, + "required": [ + "charactersCount", + "transactionsCount" + ] + }, + "DocumentWarning": { + "type": "object", + "description": "Contains the warnings object with warnings encountered for the processed document.", + "properties": { + "code": { + "$ref": "#/definitions/WarningCodeValue", + "description": "Warning code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + }, + "required": [ + "code", + "message" + ] + }, + "EntitiesDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Contains the entity recognition task result for the document with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntitiesDocumentResultWithMetadata": { + "type": "object", + "description": "Entity documents result with metadata.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/EntityWithMetadata" + } + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntitiesDocumentResultWithMetadataDetectedLanguage": { + "type": "object", + "description": "Contains the entity recognition task result for the document with metadata and detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/EntityWithMetadata" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntitiesLROTask": { + "type": "object", + "description": "An object representing the task definition for an Entities Recognition task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "EntitiesResult": { + "type": "object", + "description": "Contains the entity recognition task result.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithMetadata" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "EntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Recognition task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "stringIndexType": { + "type": "string", + "description": "(Optional) parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "inclusionList": { + "type": "array", + "description": "(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList", + "items": { + "$ref": "#/definitions/EntityCategory" + } + }, + "exclusionList": { + "type": "array", + "description": "(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList", + "items": { + "$ref": "#/definitions/EntityCategory" + } + }, + "overlapPolicy": { + "$ref": "#/definitions/BaseEntityOverlapPolicy", + "description": "(Optional) describes the type of overlap policy to apply to the ner output." + }, + "inferenceOptions": { + "$ref": "#/definitions/EntityInferenceOptions", + "description": "(Optional) request parameter that allows the user to provide settings for running the inference." + } + } + }, + "EntitiesTaskResult": { + "type": "object", + "description": "Contains the entity task", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesWithMetadataAutoResult", + "description": "Results for entity recognition." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "EntityRecognitionResults" + }, + "EntitiesWithMetadataAutoResult": { + "type": "object", + "description": "Contains the entity recognition task result.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithMetadataDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "Entity": { + "type": "object", + "description": "Defines the detected entity object containing the entity category and entity text detected, etc.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "EntityCategory": { + "type": "string", + "description": "Contains all the entity categories detected by entity recognition.", + "enum": [ + "Address", + "Numeric", + "Age", + "Currency", + "Number", + "NumberRange", + "Percentage", + "Ordinal", + "Temperature", + "Dimension", + "Length", + "Weight", + "Height", + "Speed", + "Area", + "Volume", + "Information", + "Temporal", + "Date", + "Time", + "DateTime", + "DateRange", + "TimeRange", + "DateTimeRange", + "Duration", + "SetTemporal", + "Event", + "SportsEvent", + "CulturalEvent", + "NaturalEvent", + "Location", + "GPE", + "City", + "State", + "CountryRegion", + "Continent", + "Structural", + "Airport", + "Geological", + "Organization", + "OrganizationMedical", + "OrganizationStockExchange", + "OrganizationSports", + "Person", + "PersonType", + "Email", + "URL", + "IP", + "PhoneNumber", + "Product", + "ComputingProduct", + "Skill" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "name": "Address", + "value": "Address", + "description": "Specific street-level mentions of locations: house/building numbers, streets, avenues, highways, intersections referenced by name." + }, + { + "name": "Numeric", + "value": "Numeric", + "description": "Numeric values, including digits and number words." + }, + { + "name": "Age", + "value": "Age", + "description": "Age-related values." + }, + { + "name": "Currency", + "value": "Currency", + "description": "Currency-related values." + }, + { + "name": "Number", + "value": "Number", + "description": "Numbers without a unit" + }, + { + "name": "NumberRange", + "value": "NumberRange", + "description": "Range of Numbers" + }, + { + "name": "Percentage", + "value": "Percentage", + "description": "Percentage-related values." + }, + { + "name": "Ordinal", + "value": "Ordinal", + "description": "Ordinal numbers." + }, + { + "name": "Temperature", + "value": "Temperature", + "description": "Temperature-related values." + }, + { + "name": "Dimension", + "value": "Dimension", + "description": "Dimension of measurements" + }, + { + "name": "Length", + "value": "Length", + "description": "Length of an object." + }, + { + "name": "Weight", + "value": "Weight", + "description": "Weight of an object." + }, + { + "name": "Height", + "value": "Height", + "description": "Height of an object." + }, + { + "name": "Speed", + "value": "Speed", + "description": "Speed of an object." + }, + { + "name": "Area", + "value": "Area", + "description": "Area of an object." + }, + { + "name": "Volume", + "value": "Volume", + "description": "Volume of an object." + }, + { + "name": "Information", + "value": "Information", + "description": "Unit of measure for digital information." + }, + { + "name": "Temporal", + "value": "Temporal", + "description": "Items relating to time." + }, + { + "name": "Date", + "value": "Date", + "description": "Calendar dates." + }, + { + "name": "Time", + "value": "Time", + "description": "Times of day." + }, + { + "name": "DateTime", + "value": "DateTime", + "description": "Calendar dates with time." + }, + { + "name": "DateRange", + "value": "DateRange", + "description": "Range of dates." + }, + { + "name": "TimeRange", + "value": "TimeRange", + "description": "Range of times." + }, + { + "name": "DateTimeRange", + "value": "DateTimeRange", + "description": "Range of date and time." + }, + { + "name": "Duration", + "value": "Duration", + "description": "Duration of time." + }, + { + "name": "SetTemporal", + "value": "SetTemporal", + "description": "Set of time-related values." + }, + { + "name": "Event", + "value": "Event", + "description": "Social, sports, business, political, educational, natural, historical, criminal, violent, legal, military events with a timed period." + }, + { + "name": "SportsEvent", + "value": "SportsEvent", + "description": "Sports event-related values." + }, + { + "name": "CulturalEvent", + "value": "CulturalEvent", + "description": "Cultural event-related values." + }, + { + "name": "NaturalEvent", + "value": "NaturalEvent", + "description": "Natural event-related values." + }, + { + "name": "Location", + "value": "Location", + "description": "Particular point or place in physical space." + }, + { + "name": "GPE", + "value": "GPE", + "description": "Cities, countries/regions, states." + }, + { + "name": "City", + "value": "City", + "description": "City-related values." + }, + { + "name": "State", + "value": "State", + "description": "State-related values." + }, + { + "name": "CountryRegion", + "value": "CountryRegion", + "description": "Country or region-related values." + }, + { + "name": "Continent", + "value": "Continent", + "description": "Continent-related values." + }, + { + "name": "Structural", + "value": "Structural", + "description": "Manmade structures." + }, + { + "name": "Airport", + "value": "Airport", + "description": "Airports." + }, + { + "name": "Geological", + "value": "Geological", + "description": "Geographic and natural features such as rivers, oceans, and deserts." + }, + { + "name": "Organization", + "value": "Organization", + "description": "Corporations, agencies, and other groups of people defined by some established organizational structure. These labels can include companies, political parties/movements, musical bands, sport clubs, government bodies, and public organizations. Nationalities or religions are not ORGANIZATION." + }, + { + "name": "OrganizationMedical", + "value": "OrganizationMedical", + "description": "Medical companies and groups." + }, + { + "name": "OrganizationStockExchange", + "value": "OrganizationStockExchange", + "description": "Stock exchange groups." + }, + { + "name": "OrganizationSports", + "value": "OrganizationSports", + "description": "Sports-related organizations." + }, + { + "name": "Person", + "value": "Person", + "description": "First, last, and middle names, names of fictional characters, and aliases. Titles, such as 'Mr.' or 'President', are not considered part of the named entity." + }, + { + "name": "PersonType", + "value": "PersonType", + "description": "Human roles classified by a group membership." + }, + { + "name": "Email", + "value": "Email", + "description": "Email addresses." + }, + { + "name": "URL", + "value": "URL", + "description": "URLs to websites." + }, + { + "name": "IP", + "value": "IP", + "description": "network IP addresses." + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone numbers (US and EU phone numbers only)." + }, + { + "name": "Product", + "value": "Product", + "description": "Single or group of commercial, consumable objects, electronics, vehicles, food groups." + }, + { + "name": "ComputingProduct", + "value": "ComputingProduct", + "description": "Computing products." + }, + { + "name": "Skill", + "value": "Skill", + "description": "A capability, skill, or expertise." + } + ] + } + }, + "EntityInferenceOptions": { + "type": "object", + "description": "The class that houses the inference options allowed for named entity recognition.", + "properties": { + "excludeNormalizedValues": { + "type": "boolean", + "description": "Option to include/exclude the detected entity values to be normalized and included in the metadata. The numeric and temporal entity types support value normalization.", + "default": false + } + } + }, + "EntityLinkingLROResult": { + "type": "object", + "description": "Contains the analyze text Entity linking task LRO result.", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult", + "description": "Entity linking result." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "EntityLinkingLROResults" + }, + "EntityLinkingLROTask": { + "type": "object", + "description": "Contains the analyze text Entity linking LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters", + "description": "Task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "EntityLinkingResult": { + "type": "object", + "description": "Entity linking result.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "EntityLinkingResultWithDetectedLanguage": { + "type": "object", + "description": "Entity linking document result with auto language detection.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Recognized well known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities" + ] + }, + "EntityLinkingTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Linking task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "stringIndexType": { + "type": "string", + "description": "Optional parameter to provide the string index type used to interpret string offsets. Defaults to TextElements (Graphemes).", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + } + }, + "EntityLinkingTaskResult": { + "type": "object", + "description": "Contains the analyze text Entity linking task result.", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult", + "description": "Entity linking result." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "EntityLinkingResults" + }, + "EntityMaskPolicyType": { + "type": "object", + "description": "Represents the policy of redacting PII with the entity type.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "entityMask" + }, + "EntityRecognitionLROResult": { + "type": "object", + "description": "Contains the entity recognition job task result.", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult", + "description": "Results for the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "EntityRecognitionLROResults" + }, + "EntitySynonym": { + "type": "object", + "description": "The entity synonyms used to enhance pii entity detection", + "properties": { + "synonym": { + "type": "string", + "description": "The synonym to be used for context" + }, + "language": { + "type": "string", + "description": "The 2 letter ISO 639-1 language the synonym" + } + }, + "required": [ + "synonym" + ] + }, + "EntitySynonyms": { + "type": "object", + "description": "Object that allows the user to provide synonyms for context words that to enhance pii entity detection.", + "properties": { + "entityType": { + "$ref": "#/definitions/EntityCategory", + "description": "The entity name" + }, + "synonyms": { + "type": "array", + "description": "The entity synonyms", + "items": { + "$ref": "#/definitions/EntitySynonym" + } + } + }, + "required": [ + "entityType", + "synonyms" + ] + }, + "EntityTag": { + "type": "object", + "description": "Entity tag object which contains the name of the tags abd any associated confidence score. Entity Tags are used to express some similarities/affinity between entities.", + "properties": { + "name": { + "type": "string", + "description": "Name of the tag. Entity Tag names will be unique globally." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Detection score between 0 and 1 of the extracted entity." + } + }, + "required": [ + "name" + ] + }, + "EntityWithMetadata": { + "type": "object", + "description": "Entity object with tags and metadata.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "type": { + "type": "string", + "description": "An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags are to express some similarities/affinity between entities.", + "items": { + "$ref": "#/definitions/EntityTag" + } + }, + "metadata": { + "$ref": "#/definitions/BaseMetadata", + "description": "The entity metadata object." + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "Error": { + "type": "object", + "description": "The error response object returned when the service encounters some errors during processing the request.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument", + "description": "Invalid argument error" + }, + { + "name": "Unauthorized", + "value": "Unauthorized", + "description": "Unauthorized access error" + }, + { + "name": "Forbidden", + "value": "Forbidden", + "description": "Forbidden access error" + }, + { + "name": "NotFound", + "value": "NotFound", + "description": "Not found error" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound", + "description": "Project not found error" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound", + "description": "Operation not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound", + "description": "Azure Cognitive Search index not found error" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests", + "description": "Too many requests error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached", + "description": "Azure Cognitive Search index limit reached error" + }, + { + "name": "InternalServerError", + "value": "InternalServerError", + "description": "Internal server error" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable", + "description": "Service unavailable error" + }, + { + "name": "Timeout", + "value": "Timeout", + "description": "Timeout error" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded", + "description": "Quota exceeded error" + }, + { + "name": "Conflict", + "value": "Conflict", + "description": "Conflict error" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning error" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ExtractedSummaryDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "A ranked list of sentences representing the extracted summary.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "sentences": { + "type": "array", + "description": "Specifies the the extracted sentences from the input document.", + "items": { + "$ref": "#/definitions/ExtractedSummarySentence" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "sentences" + ] + }, + "ExtractedSummarySentence": { + "type": "object", + "description": "Represents an extracted sentences from the input document.", + "properties": { + "text": { + "type": "string", + "description": "The extracted sentence text." + }, + "rankScore": { + "type": "number", + "format": "double", + "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + } + }, + "required": [ + "text", + "rankScore", + "offset", + "length" + ] + }, + "ExtractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Extractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/ExtractiveSummarizationResult", + "description": "Results of the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" + }, + "ExtractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Extractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/ExtractiveSummarizationTaskParameters", + "description": "Parameters for the Extractive Summarization task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarization" + }, + "ExtractiveSummarizationResult": { + "type": "object", + "description": "An object representing the pre-built Extractive Summarization results of each document.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "ExtractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for an Extractive Summarization task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "sentenceCount": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of sentences in the extracted summary.", + "default": 3 + }, + "sortBy": { + "type": "string", + "description": "Specifies how to sort the extracted summaries.", + "default": "Offset", + "enum": [ + "Offset", + "Rank" + ], + "x-ms-enum": { + "name": "ExtractiveSummarizationSortingCriteria", + "modelAsString": true, + "values": [ + { + "name": "Offset", + "value": "Offset", + "description": "Indicates that results should be sorted in order of appearance in the text." + }, + { + "name": "Rank", + "value": "Rank", + "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model." + } + ] + } + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "query": { + "type": "string", + "description": "(Optional) If provided, the query will be used to extract most relevant sentences from the document." + } + } + }, + "FhirBundle": { + "type": "object", + "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", + "additionalProperties": {} + }, + "HealthcareAssertion": { + "type": "object", + "description": "Assertion of the entity.", + "properties": { + "conditionality": { + "$ref": "#/definitions/Conditionality", + "description": "Describes any conditionality on the entity." + }, + "certainty": { + "$ref": "#/definitions/Certainty", + "description": "Describes the entities certainty and polarity." + }, + "association": { + "$ref": "#/definitions/Association", + "description": "Describes if the entity is the subject of the text or if it describes someone else." + }, + "temporality": { + "$ref": "#/definitions/Temporality", + "description": "Describes temporal information regarding the entity." + } + } + }, + "HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { + "type": "object", + "description": "Result object for the processed Healthcare document with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "entities": { + "type": "array", + "description": "Healthcare entities.", + "items": { + "$ref": "#/definitions/HealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + }, + "fhirBundle": { + "$ref": "#/definitions/FhirBundle", + "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html." + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "entities", + "relations" + ] + }, + "HealthcareEntity": { + "type": "object", + "description": "Healthcare entity extracted from the document", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "$ref": "#/definitions/healthcareEntityCategory", + "description": "Healthcare Entity Category." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "assertion": { + "$ref": "#/definitions/HealthcareAssertion", + "description": "Assertion of the entity." + }, + "name": { + "type": "string", + "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'." + }, + "links": { + "type": "array", + "description": "Entity references in known data sources.", + "items": { + "$ref": "#/definitions/HealthcareEntityLink" + } + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "HealthcareEntityLink": { + "type": "object", + "description": "Reference to an entity in known data sources.", + "properties": { + "dataSource": { + "type": "string", + "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc." + }, + "id": { + "type": "string", + "description": "Entity id in the given source catalog." + } + }, + "required": [ + "dataSource", + "id" + ] + }, + "HealthcareLROResult": { + "type": "object", + "description": "Healthcare Analyze Text long tunning operation result object.", + "properties": { + "results": { + "$ref": "#/definitions/HealthcareResult", + "description": "Results of the task." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "HealthcareLROResults" + }, + "HealthcareLROTask": { + "type": "object", + "description": "The long running task to be performed by the service on the Healthcare input documents.", + "properties": { + "parameters": { + "$ref": "#/definitions/HealthcareTaskParameters", + "description": "Parameters for the Healthcare task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "Healthcare" + }, + "HealthcareRelation": { + "type": "object", + "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", + "properties": { + "relationType": { + "$ref": "#/definitions/relationType", + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc." + }, + "entities": { + "type": "array", + "description": "The entities in the relation.", + "items": { + "$ref": "#/definitions/HealthcareRelationEntity" + } + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted relation." + } + }, + "required": [ + "relationType", + "entities" + ] + }, + "HealthcareRelationEntity": { + "type": "object", + "description": "Entity in the relation.", + "properties": { + "ref": { + "type": "string", + "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity ." + }, + "role": { + "type": "string", + "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis)." + } + }, + "required": [ + "ref", + "role" + ] + }, + "HealthcareResult": { + "type": "object", + "description": "Result object for the processed Healthcare task.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "List of result objects for the processed Healthcare documents.", + "items": { + "$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "HealthcareTaskParameters": { + "type": "object", + "description": "Supported parameters for a Healthcare task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "fhirVersion": { + "$ref": "#/definitions/fhirVersion", + "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html." + }, + "documentType": { + "$ref": "#/definitions/healthcareDocumentType", + "description": "Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter." + } + } + }, + "InformationMetadata": { + "type": "object", + "description": "Represents the Information (data) entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/InformationUnit", + "description": "Unit of measure for information." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "InformationMetadata" + }, + "InformationUnit": { + "type": "string", + "description": "The information (data) Unit of measurement.", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified data size unit" + }, + { + "name": "Bit", + "value": "Bit", + "description": "Data size unit in bits" + }, + { + "name": "Kilobit", + "value": "Kilobit", + "description": "Data size unit in kilobits" + }, + { + "name": "Megabit", + "value": "Megabit", + "description": "Data size unit in megabits" + }, + { + "name": "Gigabit", + "value": "Gigabit", + "description": "Data size unit in gigabits" + }, + { + "name": "Terabit", + "value": "Terabit", + "description": "Data size unit in terabits" + }, + { + "name": "Petabit", + "value": "Petabit", + "description": "Data size unit in petabits" + }, + { + "name": "Byte", + "value": "Byte", + "description": "Data size unit in bytes" + }, + { + "name": "Kilobyte", + "value": "Kilobyte", + "description": "Data size unit in kilobytes" + }, + { + "name": "Megabyte", + "value": "Megabyte", + "description": "Data size unit in megabytes" + }, + { + "name": "Gigabyte", + "value": "Gigabyte", + "description": "Data size unit in gigabytes" + }, + { + "name": "Terabyte", + "value": "Terabyte", + "description": "Data size unit in terabytes" + }, + { + "name": "Petabyte", + "value": "Petabyte", + "description": "Data size unit in petabytes" + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest", + "description": "Invalid request error" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue", + "description": "Invalid parameter value error" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound", + "description": "Knowledge base not found error" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound", + "description": "Azure Cognitive Search not found error" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling", + "description": "Azure Cognitive Search throttling error" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure", + "description": "Extraction failure error" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat", + "description": "Invalid request body format error" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest", + "description": "Empty request error" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments", + "description": "Missing input documents error" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument", + "description": "Invalid document error" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect", + "description": "Model version incorrect error" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch", + "description": "Invalid document batch error" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode", + "description": "Unsupported language code error" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint", + "description": "Invalid country hint error" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "KeyPhraseExtractionLROResult": { + "type": "object", + "description": "Contains the analyze text KeyPhraseExtraction LRO task.", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult", + "description": "The list of Key phrase extraction results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" + }, + "KeyPhraseLROTask": { + "type": "object", + "description": "An object representing the task definition for a Key Phrase Extraction task.", + "properties": { + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters", + "description": "Key phrase extraction task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "KeyPhraseResult": { + "type": "object", + "description": "Contains the KeyPhraseResult.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/KeyPhrasesDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "KeyPhraseTaskParameters": { + "type": "object", + "description": "Supported parameters for a Key Phrase Extraction task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + } + } + }, + "KeyPhraseTaskResult": { + "type": "object", + "description": "Contains the analyze text KeyPhraseExtraction task result.", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult", + "description": "The list of Key phrase extraction results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtractionResults" + }, + "KeyPhrasesDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "A ranked list of sentences representing the extracted summary.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "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" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "keyPhrases" + ] + }, + "LanguageDetectionAnalysisInput": { + "type": "object", + "description": "Contains the language detection document analysis input.", + "properties": { + "documents": { + "type": "array", + "description": "List of documents to be analyzed.", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "LanguageDetectionDocumentResult": { + "type": "object", + "description": "Contains the language detection for a document.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "Detected Language." + } + }, + "required": [ + "id", + "warnings", + "detectedLanguage" + ] + }, + "LanguageDetectionResult": { + "type": "object", + "description": "Contains the language detection result for the request.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Enumeration of language detection results for each input document.", + "items": { + "$ref": "#/definitions/LanguageDetectionDocumentResult" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "LanguageDetectionTaskParameters": { + "type": "object", + "description": "Supported parameters for a Language Detection task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + } + } + }, + "LanguageDetectionTaskResult": { + "type": "object", + "description": "Contains the language detection task result for the request.", + "properties": { + "results": { + "$ref": "#/definitions/LanguageDetectionResult", + "description": "Contains the language detection results." + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "LanguageDetectionResults" + }, + "LanguageInput": { + "type": "object", + "description": "Contains the language detection input.", + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "countryHint": { + "type": "string", + "description": "The country hint to help with language detection of the text." + } + }, + "required": [ + "id", + "text" + ] + }, + "LengthMetadata": { + "type": "object", + "description": "Represents the Length entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/LengthUnit", + "description": "Unit of measure for length." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "LengthMetadata" + }, + "LengthUnit": { + "type": "string", + "description": "The length unit of measurement.", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Point" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified length unit." + }, + { + "name": "Kilometer", + "value": "Kilometer", + "description": "Length unit in kilometers." + }, + { + "name": "Hectometer", + "value": "Hectometer", + "description": "Length unit in hectometers." + }, + { + "name": "Decameter", + "value": "Decameter", + "description": "Length unit in decameters." + }, + { + "name": "Meter", + "value": "Meter", + "description": "Length unit in meters." + }, + { + "name": "Decimeter", + "value": "Decimeter", + "description": "Length unit in decimeters." + }, + { + "name": "Centimeter", + "value": "Centimeter", + "description": "Length unit in centimeters." + }, + { + "name": "Millimeter", + "value": "Millimeter", + "description": "Length unit in millimeters." + }, + { + "name": "Micrometer", + "value": "Micrometer", + "description": "Length unit in micrometers." + }, + { + "name": "Nanometer", + "value": "Nanometer", + "description": "Length unit in nanometers." + }, + { + "name": "Picometer", + "value": "Picometer", + "description": "Length unit in picometers." + }, + { + "name": "Mile", + "value": "Mile", + "description": "Length unit in miles." + }, + { + "name": "Yard", + "value": "Yard", + "description": "Length unit in yards." + }, + { + "name": "Inch", + "value": "Inch", + "description": "Length unit in inches." + }, + { + "name": "Foot", + "value": "Foot", + "description": "Length unit in feet." + }, + { + "name": "LightYear", + "value": "LightYear", + "description": "Length unit in light years." + }, + { + "name": "Point", + "value": "Point", + "description": "Length unit in points." + } + ] + } + }, + "LinkedEntity": { + "type": "object", + "description": "The LinkedEntity object containing the detected entity with the associated sources/links.", + "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." + }, + "bingId": { + "type": "string", + "description": "Bing Entity Search API unique identifier of the recognized entity." + } + }, + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ] + }, + "Match": { + "type": "object", + "description": "The Match object containing the detected entity text with the offset and the length.", + "properties": { + "confidenceScore": { + "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 for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity match text." + } + }, + "required": [ + "confidenceScore", + "text", + "offset", + "length" + ] + }, + "MatchLongestEntityPolicyType": { + "type": "object", + "description": "Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1.", + "allOf": [ + { + "$ref": "#/definitions/BaseEntityOverlapPolicy" + } + ], + "x-ms-discriminator-value": "matchLongest" + }, + "MetadataKind": { + "type": "string", + "description": "The entity Metadata object kind.", + "enum": [ + "DateMetadata", + "DateTimeMetadata", + "TimeMetadata", + "TemporalSetMetadata", + "NumberMetadata", + "OrdinalMetadata", + "SpeedMetadata", + "WeightMetadata", + "LengthMetadata", + "VolumeMetadata", + "AreaMetadata", + "AgeMetadata", + "InformationMetadata", + "TemperatureMetadata", + "CurrencyMetadata", + "NumericRangeMetadata", + "TemporalSpanMetadata" + ], + "x-ms-enum": { + "name": "MetadataKind", + "modelAsString": true, + "values": [ + { + "name": "DateMetadata", + "value": "DateMetadata", + "description": "Metadata for date-related values." + }, + { + "name": "DateTimeMetadata", + "value": "DateTimeMetadata", + "description": "Metadata for date and time-related values." + }, + { + "name": "TimeMetadata", + "value": "TimeMetadata", + "description": "Metadata for time-related values." + }, + { + "name": "TemporalSetMetadata", + "value": "TemporalSetMetadata", + "description": "Metadata for set of time-related values." + }, + { + "name": "NumberMetadata", + "value": "NumberMetadata", + "description": "Metadata for numeric values." + }, + { + "name": "OrdinalMetadata", + "value": "OrdinalMetadata", + "description": "Metadata for ordinal numbers." + }, + { + "name": "SpeedMetadata", + "value": "SpeedMetadata", + "description": "Metadata for speed-related values." + }, + { + "name": "WeightMetadata", + "value": "WeightMetadata", + "description": "Metadata for weight-related values." + }, + { + "name": "LengthMetadata", + "value": "LengthMetadata", + "description": "Metadata for length-related values." + }, + { + "name": "VolumeMetadata", + "value": "VolumeMetadata", + "description": "Metadata for volume-related values." + }, + { + "name": "AreaMetadata", + "value": "AreaMetadata", + "description": "Metadata for area-related values." + }, + { + "name": "AgeMetadata", + "value": "AgeMetadata", + "description": "Metadata for age-related values." + }, + { + "name": "InformationMetadata", + "value": "InformationMetadata", + "description": "Metadata for information-related values." + }, + { + "name": "TemperatureMetadata", + "value": "TemperatureMetadata", + "description": "Metadata for temperature-related values." + }, + { + "name": "CurrencyMetadata", + "value": "CurrencyMetadata", + "description": "Metadata for currency-related values." + }, + { + "name": "NumericRangeMetadata", + "value": "NumericRangeMetadata", + "description": "Metadata for numeric range values." + }, + { + "name": "TemporalSpanMetadata", + "value": "TemporalSpanMetadata", + "description": "Metadata for temporal span values." + } + ] + } + }, + "MultiLanguageAnalysisInput": { + "type": "object", + "description": "Collection of input documents to be analyzed by the service.", + "properties": { + "documents": { + "type": "array", + "description": "The input documents to be analyzed.", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + } + }, + "MultiLanguageInput": { + "type": "object", + "description": "Contains an input document to be analyzed by the service.", + "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. (Following only applies to 2023-04-15-preview and above) For Auto Language Detection, use \\\"auto\\\". If not set, use \\\"en\\\" for English as default." + } + }, + "required": [ + "id", + "text" + ] + }, + "NoMaskPolicyType": { + "type": "object", + "description": "Represents the policy of not redacting found PII.", + "allOf": [ + { + "$ref": "#/definitions/BaseRedactionPolicy" + } + ], + "x-ms-discriminator-value": "noMask" + }, + "NumberKind": { + "type": "string", + "description": "The type of the extracted number entity.", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true, + "values": [ + { + "name": "Integer", + "value": "Integer", + "description": "Integer number" + }, + { + "name": "Decimal", + "value": "Decimal", + "description": "Decimal number" + }, + { + "name": "Power", + "value": "Power", + "description": "Power number" + }, + { + "name": "Fraction", + "value": "Fraction", + "description": "Fraction number" + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percent number" + }, + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified number kind" + } + ] + } + }, + "NumberMetadata": { + "type": "object", + "description": "A metadata for numeric entity instances.", + "properties": { + "numberKind": { + "$ref": "#/definitions/NumberKind", + "description": "Kind of the number type." + }, + "value": { + "type": "number", + "format": "double", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "NumberMetadata" + }, + "NumericRangeMetadata": { + "type": "object", + "description": "represents the Metadata of numeric intervals.", + "properties": { + "rangeKind": { + "$ref": "#/definitions/RangeKind", + "description": "Kind of numeric ranges supported - like Number, Speed, etc." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + }, + "rangeInclusivity": { + "$ref": "#/definitions/RangeInclusivity", + "description": "The inclusiveness of this range." + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "NumericRangeMetadata" + }, + "OrdinalMetadata": { + "type": "object", + "description": "A metadata for numeric entity instances.", + "properties": { + "offset": { + "type": "string", + "description": "The offset with respect to the reference (e.g., offset = -1 indicates the second to last)" + }, + "relativeTo": { + "$ref": "#/definitions/RelativeTo", + "description": "The reference point that the ordinal number denotes." + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "OrdinalMetadata" + }, + "PiiCategoriesExclude": { + "type": "string", + "description": "(Optional) describes the PII categories to return", + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "DateOfBirth", + "BankAccountNumber", + "PassportNumber", + "DriversLicenseNumber", + "Neighborhood", + "SortCode", + "PIN", + "VIN", + "LicensePlate" + ], + "x-ms-enum": { + "name": "PiiCategoriesExclude", + "modelAsString": true, + "values": [ + { + "name": "ABARoutingNumber", + "value": "ABARoutingNumber", + "description": "ABA Routing number" + }, + { + "name": "ARNationalIdentityNumber", + "value": "ARNationalIdentityNumber", + "description": "AR National Identity Number" + }, + { + "name": "AUBankAccountNumber", + "value": "AUBankAccountNumber", + "description": "AT Bank Account Number" + }, + { + "name": "AUDriversLicenseNumber", + "value": "AUDriversLicenseNumber", + "description": "AU Driver's License Number" + }, + { + "name": "AUMedicalAccountNumber", + "value": "AUMedicalAccountNumber", + "description": "AU Medical Account Number" + }, + { + "name": "AUPassportNumber", + "value": "AUPassportNumber", + "description": "AU Passport Number" + }, + { + "name": "AUTaxFileNumber", + "value": "AUTaxFileNumber", + "description": "AU Tax File Number" + }, + { + "name": "AUBusinessNumber", + "value": "AUBusinessNumber", + "description": "AU Business Number" + }, + { + "name": "AUCompanyNumber", + "value": "AUCompanyNumber", + "description": "AU Company Number" + }, + { + "name": "ATIdentityCard", + "value": "ATIdentityCard", + "description": "AT Identity Card" + }, + { + "name": "ATTaxIdentificationNumber", + "value": "ATTaxIdentificationNumber", + "description": "AT Tax Identification Number" + }, + { + "name": "ATValueAddedTaxNumber", + "value": "ATValueAddedTaxNumber", + "description": "AT Value Added Tax Number" + }, + { + "name": "AzureDocumentDBAuthKey", + "value": "AzureDocumentDBAuthKey", + "description": "Azure Document DB Auth Key" + }, + { + "name": "AzureIAASDatabaseConnectionAndSQLString", + "value": "AzureIAASDatabaseConnectionAndSQLString", + "description": "Azure IAAS Database Connection And SQL String" + }, + { + "name": "AzureIoTConnectionString", + "value": "AzureIoTConnectionString", + "description": "Azure IoT Connection String" + }, + { + "name": "AzurePublishSettingPassword", + "value": "AzurePublishSettingPassword", + "description": "Azure Publish Setting Password" + }, + { + "name": "AzureRedisCacheString", + "value": "AzureRedisCacheString", + "description": "Azure Redis Cache String" + }, + { + "name": "AzureSAS", + "value": "AzureSAS", + "description": "Azure SAS" + }, + { + "name": "AzureServiceBusString", + "value": "AzureServiceBusString", + "description": "Azure Service Bus String" + }, + { + "name": "AzureStorageAccountKey", + "value": "AzureStorageAccountKey", + "description": "Azure Storage Account Key" + }, + { + "name": "AzureStorageAccountGeneric", + "value": "AzureStorageAccountGeneric", + "description": "Azure Storage Account Generic" + }, + { + "name": "BENationalNumber", + "value": "BENationalNumber", + "description": "BE National Number" + }, + { + "name": "BENationalNumberV2", + "value": "BENationalNumberV2", + "description": "BE National Number V2" + }, + { + "name": "BEValueAddedTaxNumber", + "value": "BEValueAddedTaxNumber", + "description": "BE Value Added Tax Number" + }, + { + "name": "BRCPFNumber", + "value": "BRCPFNumber", + "description": "BR CPF Number" + }, + { + "name": "BRLegalEntityNumber", + "value": "BRLegalEntityNumber", + "description": "BR Legal Entity Number" + }, + { + "name": "BRNationalIDRG", + "value": "BRNationalIDRG", + "description": "BR National ID RG" + }, + { + "name": "BGUniformCivilNumber", + "value": "BGUniformCivilNumber", + "description": "BG Uniform Civil Number" + }, + { + "name": "CABankAccountNumber", + "value": "CABankAccountNumber", + "description": "CA Bank Account Number" + }, + { + "name": "CADriversLicenseNumber", + "value": "CADriversLicenseNumber", + "description": "CA Driver's License Number" + }, + { + "name": "CAHealthServiceNumber", + "value": "CAHealthServiceNumber", + "description": "CA Health Service Number" + }, + { + "name": "CAPassportNumber", + "value": "CAPassportNumber", + "description": "CA Passport Number" + }, + { + "name": "CAPersonalHealthIdentification", + "value": "CAPersonalHealthIdentification", + "description": "CA Personal Health Identification" + }, + { + "name": "CASocialInsuranceNumber", + "value": "CASocialInsuranceNumber", + "description": "CA Social Insurance Number" + }, + { + "name": "CLIdentityCardNumber", + "value": "CLIdentityCardNumber", + "description": "CL Identity Card Number" + }, + { + "name": "CNResidentIdentityCardNumber", + "value": "CNResidentIdentityCardNumber", + "description": "CN Resident Identity Card Number" + }, + { + "name": "CreditCardNumber", + "value": "CreditCardNumber", + "description": "Credit Card Number" + }, + { + "name": "HRIdentityCardNumber", + "value": "HRIdentityCardNumber", + "description": "HR Identity Card Number" + }, + { + "name": "HRNationalIDNumber", + "value": "HRNationalIDNumber", + "description": "HR National ID Number" + }, + { + "name": "HRPersonalIdentificationNumber", + "value": "HRPersonalIdentificationNumber", + "description": "HR Personal Identification Number" + }, + { + "name": "HRPersonalIdentificationOIBNumberV2", + "value": "HRPersonalIdentificationOIBNumberV2", + "description": "HR Personal Identification OIB Number V2" + }, + { + "name": "CYIdentityCard", + "value": "CYIdentityCard", + "description": "CY Identity Card" + }, + { + "name": "CYTaxIdentificationNumber", + "value": "CYTaxIdentificationNumber", + "description": "CY Tax Identification Number" + }, + { + "name": "CZPersonalIdentityNumber", + "value": "CZPersonalIdentityNumber", + "description": "CZ Personal Identity Number" + }, + { + "name": "CZPersonalIdentityV2", + "value": "CZPersonalIdentityV2", + "description": "CZ Personal Identity V2" + }, + { + "name": "DKPersonalIdentificationNumber", + "value": "DKPersonalIdentificationNumber", + "description": "DK Personal Identification Number" + }, + { + "name": "DKPersonalIdentificationV2", + "value": "DKPersonalIdentificationV2", + "description": "DK Personal Identification V2" + }, + { + "name": "DrugEnforcementAgencyNumber", + "value": "DrugEnforcementAgencyNumber", + "description": "Drug Enforcement Agency Number" + }, + { + "name": "EEPersonalIdentificationCode", + "value": "EEPersonalIdentificationCode", + "description": "EE Personal Identification Code" + }, + { + "name": "EUDebitCardNumber", + "value": "EUDebitCardNumber", + "description": "EU Debit Card Number" + }, + { + "name": "EUDriversLicenseNumber", + "value": "EUDriversLicenseNumber", + "description": "EU Driver's License Number" + }, + { + "name": "EUGPSCoordinates", + "value": "EUGPSCoordinates", + "description": "EU GPS Coordinates" + }, + { + "name": "EUNationalIdentificationNumber", + "value": "EUNationalIdentificationNumber", + "description": "EU National Identification Number" + }, + { + "name": "EUPassportNumber", + "value": "EUPassportNumber", + "description": "EU Passport Number" + }, + { + "name": "EUSocialSecurityNumber", + "value": "EUSocialSecurityNumber", + "description": "EU Social Security Number" + }, + { + "name": "EUTaxIdentificationNumber", + "value": "EUTaxIdentificationNumber", + "description": "EU Tax Identification Number" + }, + { + "name": "FIEuropeanHealthNumber", + "value": "FIEuropeanHealthNumber", + "description": "FI European Health Number" + }, + { + "name": "FINationalID", + "value": "FINationalID", + "description": "FI National ID" + }, + { + "name": "FINationalIDV2", + "value": "FINationalIDV2", + "description": "FI National ID V2" + }, + { + "name": "FIPassportNumber", + "value": "FIPassportNumber", + "description": "FI Passport Number" + }, + { + "name": "FRDriversLicenseNumber", + "value": "FRDriversLicenseNumber", + "description": "FR Driver's License Number" + }, + { + "name": "FRHealthInsuranceNumber", + "value": "FRHealthInsuranceNumber", + "description": "FR Health Insurance Number" + }, + { + "name": "FRNationalID", + "value": "FRNationalID", + "description": "FR National ID" + }, + { + "name": "FRPassportNumber", + "value": "FRPassportNumber", + "description": "FR Passport Number" + }, + { + "name": "FRSocialSecurityNumber", + "value": "FRSocialSecurityNumber", + "description": "FR Social Security Number" + }, + { + "name": "FRTaxIdentificationNumber", + "value": "FRTaxIdentificationNumber", + "description": "FR Tax Identification Number" + }, + { + "name": "FRValueAddedTaxNumber", + "value": "FRValueAddedTaxNumber", + "description": "FR Value Added Tax Number" + }, + { + "name": "DEDriversLicenseNumber", + "value": "DEDriversLicenseNumber", + "description": "DE Driver's License Number" + }, + { + "name": "DEPassportNumber", + "value": "DEPassportNumber", + "description": "DE Passport Number" + }, + { + "name": "DEIdentityCardNumber", + "value": "DEIdentityCardNumber", + "description": "DE Identity Card Number" + }, + { + "name": "DETaxIdentificationNumber", + "value": "DETaxIdentificationNumber", + "description": "DE Tax Identification Number" + }, + { + "name": "DEValueAddedNumber", + "value": "DEValueAddedNumber", + "description": "DE Value Added Number" + }, + { + "name": "GRNationalIDCard", + "value": "GRNationalIDCard", + "description": "GR National ID Card" + }, + { + "name": "GRNationalIDV2", + "value": "GRNationalIDV2", + "description": "GR National ID V2" + }, + { + "name": "GRTaxIdentificationNumber", + "value": "GRTaxIdentificationNumber", + "description": "GR Tax Identification Number" + }, + { + "name": "HKIdentityCardNumber", + "value": "HKIdentityCardNumber", + "description": "HK Identity Card Number" + }, + { + "name": "HUValueAddedNumber", + "value": "HUValueAddedNumber", + "description": "HU Value Added Number" + }, + { + "name": "HUPersonalIdentificationNumber", + "value": "HUPersonalIdentificationNumber", + "description": "HU Personal Identification Number" + }, + { + "name": "HUTaxIdentificationNumber", + "value": "HUTaxIdentificationNumber", + "description": "HU Tax Identification Number" + }, + { + "name": "INPermanentAccount", + "value": "INPermanentAccount", + "description": "IN Permanent Account" + }, + { + "name": "INUniqueIdentificationNumber", + "value": "INUniqueIdentificationNumber", + "description": "IN Unique Identification Number" + }, + { + "name": "IDIdentityCardNumber", + "value": "IDIdentityCardNumber", + "description": "ID Identity Card Number" + }, + { + "name": "InternationalBankingAccountNumber", + "value": "InternationalBankingAccountNumber", + "description": "International Banking Account Number" + }, + { + "name": "IEPersonalPublicServiceNumber", + "value": "IEPersonalPublicServiceNumber", + "description": "IE Personal Public Service Number" + }, + { + "name": "IEPersonalPublicServiceNumberV2", + "value": "IEPersonalPublicServiceNumberV2", + "description": "IE Personal Public Service Number V2" + }, + { + "name": "ILBankAccountNumber", + "value": "ILBankAccountNumber", + "description": "IL Bank Account Number" + }, + { + "name": "ILNationalID", + "value": "ILNationalID", + "description": "IL National ID" + }, + { + "name": "ITDriversLicenseNumber", + "value": "ITDriversLicenseNumber", + "description": "IT Driver's License Number" + }, + { + "name": "ITFiscalCode", + "value": "ITFiscalCode", + "description": "IT Fiscal Code" + }, + { + "name": "ITValueAddedTaxNumber", + "value": "ITValueAddedTaxNumber", + "description": "IT Value Added Tax Number" + }, + { + "name": "JPBankAccountNumber", + "value": "JPBankAccountNumber", + "description": "JP Bank Account Number" + }, + { + "name": "JPDriversLicenseNumber", + "value": "JPDriversLicenseNumber", + "description": "JP Driver's License Number" + }, + { + "name": "JPPassportNumber", + "value": "JPPassportNumber", + "description": "JP Passport Number" + }, + { + "name": "JPResidentRegistrationNumber", + "value": "JPResidentRegistrationNumber", + "description": "JP Resident Registration Number" + }, + { + "name": "JPSocialInsuranceNumber", + "value": "JPSocialInsuranceNumber", + "description": "JP Social Insurance Number" + }, + { + "name": "JPMyNumberCorporate", + "value": "JPMyNumberCorporate", + "description": "JP My Number Corporate" + }, + { + "name": "JPMyNumberPersonal", + "value": "JPMyNumberPersonal", + "description": "JP My Number Personal" + }, + { + "name": "JPResidenceCardNumber", + "value": "JPResidenceCardNumber", + "description": "JP Residence Card Number" + }, + { + "name": "LVPersonalCode", + "value": "LVPersonalCode", + "description": "LV Personal Code" + }, + { + "name": "LTPersonalCode", + "value": "LTPersonalCode", + "description": "LT Personal Code" + }, + { + "name": "LUNationalIdentificationNumberNatural", + "value": "LUNationalIdentificationNumberNatural", + "description": "LU National Identification Number Natural" + }, + { + "name": "LUNationalIdentificationNumberNonNatural", + "value": "LUNationalIdentificationNumberNonNatural", + "description": "LU National Identification Number Non Natural" + }, + { + "name": "MYIdentityCardNumber", + "value": "MYIdentityCardNumber", + "description": "MY Identity Card Number" + }, + { + "name": "MTIdentityCardNumber", + "value": "MTIdentityCardNumber", + "description": "MT Identity Card Number" + }, + { + "name": "MTTaxIDNumber", + "value": "MTTaxIDNumber", + "description": "MT Tax ID Number" + }, + { + "name": "NLCitizensServiceNumber", + "value": "NLCitizensServiceNumber", + "description": "NL Citizens Service Number" + }, + { + "name": "NLCitizensServiceNumberV2", + "value": "NLCitizensServiceNumberV2", + "description": "NL Citizens Service Number V2" + }, + { + "name": "NLTaxIdentificationNumber", + "value": "NLTaxIdentificationNumber", + "description": "NL Tax Identification Number" + }, + { + "name": "NLValueAddedTaxNumber", + "value": "NLValueAddedTaxNumber", + "description": "NL Value Added Tax Number" + }, + { + "name": "NZBankAccountNumber", + "value": "NZBankAccountNumber", + "description": "NZ Bank Account Number" + }, + { + "name": "NZDriversLicenseNumber", + "value": "NZDriversLicenseNumber", + "description": "NZ Driver's License Number" + }, + { + "name": "NZInlandRevenueNumber", + "value": "NZInlandRevenueNumber", + "description": "NZ Inland Revenue Number" + }, + { + "name": "NZMinistryOfHealthNumber", + "value": "NZMinistryOfHealthNumber", + "description": "NZ Ministry Of Health Number" + }, + { + "name": "NZSocialWelfareNumber", + "value": "NZSocialWelfareNumber", + "description": "NZ Social Welfare Number" + }, + { + "name": "NOIdentityNumber", + "value": "NOIdentityNumber", + "description": "NO Identity Number" + }, + { + "name": "PHUnifiedMultiPurposeIDNumber", + "value": "PHUnifiedMultiPurposeIDNumber", + "description": "PH Unified Multi Purpose ID Number" + }, + { + "name": "PLIdentityCard", + "value": "PLIdentityCard", + "description": "PL Identity Card" + }, + { + "name": "PLNationalID", + "value": "PLNationalID", + "description": "PL National ID" + }, + { + "name": "PLNationalIDV2", + "value": "PLNationalIDV2", + "description": "PL National ID V2" + }, + { + "name": "PLPassportNumber", + "value": "PLPassportNumber", + "description": "PL Passport Number" + }, + { + "name": "PLTaxIdentificationNumber", + "value": "PLTaxIdentificationNumber", + "description": "PL Tax Identification Number" + }, + { + "name": "PLREGONNumber", + "value": "PLREGONNumber", + "description": "PL REGON Number" + }, + { + "name": "PTCitizenCardNumber", + "value": "PTCitizenCardNumber", + "description": "PT Citizen Card Number" + }, + { + "name": "PTCitizenCardNumberV2", + "value": "PTCitizenCardNumberV2", + "description": "PT Citizen Card Number V2" + }, + { + "name": "PTTaxIdentificationNumber", + "value": "PTTaxIdentificationNumber", + "description": "PT Tax Identification Number" + }, + { + "name": "ROPersonalNumericalCode", + "value": "ROPersonalNumericalCode", + "description": "RO Personal Numerical Code" + }, + { + "name": "RUPassportNumberDomestic", + "value": "RUPassportNumberDomestic", + "description": "RU Passport Number Domestic" + }, + { + "name": "RUPassportNumberInternational", + "value": "RUPassportNumberInternational", + "description": "RU Passport Number International" + }, + { + "name": "SANationalID", + "value": "SANationalID", + "description": "SA National ID" + }, + { + "name": "SGNationalRegistrationIdentityCardNumber", + "value": "SGNationalRegistrationIdentityCardNumber", + "description": "SG National Registration Identity Card Number" + }, + { + "name": "SKPersonalNumber", + "value": "SKPersonalNumber", + "description": "SK Personal Number" + }, + { + "name": "SITaxIdentificationNumber", + "value": "SITaxIdentificationNumber", + "description": "SI Tax Identification Number" + }, + { + "name": "SIUniqueMasterCitizenNumber", + "value": "SIUniqueMasterCitizenNumber", + "description": "SI Unique Master Citizen Number" + }, + { + "name": "ZAIdentificationNumber", + "value": "ZAIdentificationNumber", + "description": "ZA Identification Number" + }, + { + "name": "KRResidentRegistrationNumber", + "value": "KRResidentRegistrationNumber", + "description": "KR Resident Registration Number" + }, + { + "name": "ESDNI", + "value": "ESDNI", + "description": "ES DNI" + }, + { + "name": "ESSocialSecurityNumber", + "value": "ESSocialSecurityNumber", + "description": "ES Social Security Number" + }, + { + "name": "ESTaxIdentificationNumber", + "value": "ESTaxIdentificationNumber", + "description": "ES Tax Identification Number" + }, + { + "name": "SQLServerConnectionString", + "value": "SQLServerConnectionString", + "description": "SQL Server Connection String" + }, + { + "name": "SENationalID", + "value": "SENationalID", + "description": "SE National ID" + }, + { + "name": "SENationalIDV2", + "value": "SENationalIDV2", + "description": "SE National ID V2" + }, + { + "name": "SEPassportNumber", + "value": "SEPassportNumber", + "description": "SE Passport Number" + }, + { + "name": "SETaxIdentificationNumber", + "value": "SETaxIdentificationNumber", + "description": "SE Tax Identification Number" + }, + { + "name": "SWIFTCode", + "value": "SWIFTCode", + "description": "SWIFT Code" + }, + { + "name": "CHSocialSecurityNumber", + "value": "CHSocialSecurityNumber", + "description": "CH Social Security Number" + }, + { + "name": "TWNationalID", + "value": "TWNationalID", + "description": "TW National ID" + }, + { + "name": "TWPassportNumber", + "value": "TWPassportNumber", + "description": "TW Passport Number" + }, + { + "name": "TWResidentCertificate", + "value": "TWResidentCertificate", + "description": "TW Resident Certificate" + }, + { + "name": "THPopulationIdentificationCode", + "value": "THPopulationIdentificationCode", + "description": "TH Population Identification Code" + }, + { + "name": "TRNationalIdentificationNumber", + "value": "TRNationalIdentificationNumber", + "description": "TR National Identification Number" + }, + { + "name": "UKDriversLicenseNumber", + "value": "UKDriversLicenseNumber", + "description": "UK Driver's License Number" + }, + { + "name": "UKElectoralRollNumber", + "value": "UKElectoralRollNumber", + "description": "UK Electoral Roll Number" + }, + { + "name": "UKNationalHealthNumber", + "value": "UKNationalHealthNumber", + "description": "UK National Health Number" + }, + { + "name": "UKNationalInsuranceNumber", + "value": "UKNationalInsuranceNumber", + "description": "UK National Insurance Number" + }, + { + "name": "UKUniqueTaxpayerNumber", + "value": "UKUniqueTaxpayerNumber", + "description": "UK Unique Taxpayer Number" + }, + { + "name": "USUKPassportNumber", + "value": "USUKPassportNumber", + "description": "US UK Passport Number" + }, + { + "name": "USBankAccountNumber", + "value": "USBankAccountNumber", + "description": "US Bank Account Number" + }, + { + "name": "USDriversLicenseNumber", + "value": "USDriversLicenseNumber", + "description": "US Driver's License Number" + }, + { + "name": "USIndividualTaxpayerIdentification", + "value": "USIndividualTaxpayerIdentification", + "description": "US Individual Taxpayer Identification" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US Social Security Number" + }, + { + "name": "UAPassportNumberDomestic", + "value": "UAPassportNumberDomestic", + "description": "UA Passport Number Domestic" + }, + { + "name": "UAPassportNumberInternational", + "value": "UAPassportNumberInternational", + "description": "UA Passport Number International" + }, + { + "name": "Organization", + "value": "Organization", + "description": "Organization" + }, + { + "name": "Email", + "value": "Email", + "description": "Email" + }, + { + "name": "URL", + "value": "URL", + "description": "URL" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone Number" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "IP Address" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Person", + "value": "Person", + "description": "Person" + }, + { + "name": "Address", + "value": "Address", + "description": "Address" + }, + { + "name": "DateOfBirth", + "value": "DateOfBirth", + "description": "Date Of Birth" + }, + { + "name": "BankAccountNumber", + "value": "BankAccountNumber", + "description": "Bank Account Number" + }, + { + "name": "PassportNumber", + "value": "PassportNumber", + "description": "Passport Number" + }, + { + "name": "DriversLicenseNumber", + "value": "DriversLicenseNumber", + "description": "Drivers License Number" + }, + { + "name": "Neighborhood", + "value": "Neighborhood", + "description": "Neighborhood" + }, + { + "name": "SortCode", + "value": "SortCode", + "description": "Sort Code. 6-digit number used in the UK to identify a specific bank and branch where a bank account is held" + }, + { + "name": "PIN", + "value": "PIN", + "description": "PIN" + }, + { + "name": "VIN", + "value": "VIN", + "description": "VIN" + }, + { + "name": "LicensePlate", + "value": "LicensePlate", + "description": "License Plate" + } + ] + } + }, + "PiiCategory": { + "type": "string", + "description": "(Optional) describes the PII categories to return", + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "DateOfBirth", + "BankAccountNumber", + "PassportNumber", + "DriversLicenseNumber", + "Neighborhood", + "SortCode", + "PIN", + "VIN", + "LicensePlate", + "All", + "Default" + ], + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true, + "values": [ + { + "name": "ABARoutingNumber", + "value": "ABARoutingNumber", + "description": "ABA Routing number" + }, + { + "name": "ARNationalIdentityNumber", + "value": "ARNationalIdentityNumber", + "description": "AR National Identity Number" + }, + { + "name": "AUBankAccountNumber", + "value": "AUBankAccountNumber", + "description": "AT Bank Account Number" + }, + { + "name": "AUDriversLicenseNumber", + "value": "AUDriversLicenseNumber", + "description": "AU Driver's License Number" + }, + { + "name": "AUMedicalAccountNumber", + "value": "AUMedicalAccountNumber", + "description": "AU Medical Account Number" + }, + { + "name": "AUPassportNumber", + "value": "AUPassportNumber", + "description": "AU Passport Number" + }, + { + "name": "AUTaxFileNumber", + "value": "AUTaxFileNumber", + "description": "AU Tax File Number" + }, + { + "name": "AUBusinessNumber", + "value": "AUBusinessNumber", + "description": "AU Business Number" + }, + { + "name": "AUCompanyNumber", + "value": "AUCompanyNumber", + "description": "AU Company Number" + }, + { + "name": "ATIdentityCard", + "value": "ATIdentityCard", + "description": "AT Identity Card" + }, + { + "name": "ATTaxIdentificationNumber", + "value": "ATTaxIdentificationNumber", + "description": "AT Tax Identification Number" + }, + { + "name": "ATValueAddedTaxNumber", + "value": "ATValueAddedTaxNumber", + "description": "AT Value Added Tax Number" + }, + { + "name": "AzureDocumentDBAuthKey", + "value": "AzureDocumentDBAuthKey", + "description": "Azure Document DB Auth Key" + }, + { + "name": "AzureIAASDatabaseConnectionAndSQLString", + "value": "AzureIAASDatabaseConnectionAndSQLString", + "description": "Azure IAAS Database Connection And SQL String" + }, + { + "name": "AzureIoTConnectionString", + "value": "AzureIoTConnectionString", + "description": "Azure IoT Connection String" + }, + { + "name": "AzurePublishSettingPassword", + "value": "AzurePublishSettingPassword", + "description": "Azure Publish Setting Password" + }, + { + "name": "AzureRedisCacheString", + "value": "AzureRedisCacheString", + "description": "Azure Redis Cache String" + }, + { + "name": "AzureSAS", + "value": "AzureSAS", + "description": "Azure SAS" + }, + { + "name": "AzureServiceBusString", + "value": "AzureServiceBusString", + "description": "Azure Service Bus String" + }, + { + "name": "AzureStorageAccountKey", + "value": "AzureStorageAccountKey", + "description": "Azure Storage Account Key" + }, + { + "name": "AzureStorageAccountGeneric", + "value": "AzureStorageAccountGeneric", + "description": "Azure Storage Account Generic" + }, + { + "name": "BENationalNumber", + "value": "BENationalNumber", + "description": "BE National Number" + }, + { + "name": "BENationalNumberV2", + "value": "BENationalNumberV2", + "description": "BE National Number V2" + }, + { + "name": "BEValueAddedTaxNumber", + "value": "BEValueAddedTaxNumber", + "description": "BE Value Added Tax Number" + }, + { + "name": "BRCPFNumber", + "value": "BRCPFNumber", + "description": "BR CPF Number" + }, + { + "name": "BRLegalEntityNumber", + "value": "BRLegalEntityNumber", + "description": "BR Legal Entity Number" + }, + { + "name": "BRNationalIDRG", + "value": "BRNationalIDRG", + "description": "BR National ID RG" + }, + { + "name": "BGUniformCivilNumber", + "value": "BGUniformCivilNumber", + "description": "BG Uniform Civil Number" + }, + { + "name": "CABankAccountNumber", + "value": "CABankAccountNumber", + "description": "CA Bank Account Number" + }, + { + "name": "CADriversLicenseNumber", + "value": "CADriversLicenseNumber", + "description": "CA Driver's License Number" + }, + { + "name": "CAHealthServiceNumber", + "value": "CAHealthServiceNumber", + "description": "CA Health Service Number" + }, + { + "name": "CAPassportNumber", + "value": "CAPassportNumber", + "description": "CA Passport Number" + }, + { + "name": "CAPersonalHealthIdentification", + "value": "CAPersonalHealthIdentification", + "description": "CA Personal Health Identification" + }, + { + "name": "CASocialInsuranceNumber", + "value": "CASocialInsuranceNumber", + "description": "CA Social Insurance Number" + }, + { + "name": "CLIdentityCardNumber", + "value": "CLIdentityCardNumber", + "description": "CL Identity Card Number" + }, + { + "name": "CNResidentIdentityCardNumber", + "value": "CNResidentIdentityCardNumber", + "description": "CN Resident Identity Card Number" + }, + { + "name": "CreditCardNumber", + "value": "CreditCardNumber", + "description": "Credit Card Number" + }, + { + "name": "HRIdentityCardNumber", + "value": "HRIdentityCardNumber", + "description": "HR Identity Card Number" + }, + { + "name": "HRNationalIDNumber", + "value": "HRNationalIDNumber", + "description": "HR National ID Number" + }, + { + "name": "HRPersonalIdentificationNumber", + "value": "HRPersonalIdentificationNumber", + "description": "HR Personal Identification Number" + }, + { + "name": "HRPersonalIdentificationOIBNumberV2", + "value": "HRPersonalIdentificationOIBNumberV2", + "description": "HR Personal Identification OIB Number V2" + }, + { + "name": "CYIdentityCard", + "value": "CYIdentityCard", + "description": "CY Identity Card" + }, + { + "name": "CYTaxIdentificationNumber", + "value": "CYTaxIdentificationNumber", + "description": "CY Tax Identification Number" + }, + { + "name": "CZPersonalIdentityNumber", + "value": "CZPersonalIdentityNumber", + "description": "CZ Personal Identity Number" + }, + { + "name": "CZPersonalIdentityV2", + "value": "CZPersonalIdentityV2", + "description": "CZ Personal Identity V2" + }, + { + "name": "DKPersonalIdentificationNumber", + "value": "DKPersonalIdentificationNumber", + "description": "DK Personal Identification Number" + }, + { + "name": "DKPersonalIdentificationV2", + "value": "DKPersonalIdentificationV2", + "description": "DK Personal Identification V2" + }, + { + "name": "DrugEnforcementAgencyNumber", + "value": "DrugEnforcementAgencyNumber", + "description": "Drug Enforcement Agency Number" + }, + { + "name": "EEPersonalIdentificationCode", + "value": "EEPersonalIdentificationCode", + "description": "EE Personal Identification Code" + }, + { + "name": "EUDebitCardNumber", + "value": "EUDebitCardNumber", + "description": "EU Debit Card Number" + }, + { + "name": "EUDriversLicenseNumber", + "value": "EUDriversLicenseNumber", + "description": "EU Driver's License Number" + }, + { + "name": "EUGPSCoordinates", + "value": "EUGPSCoordinates", + "description": "EU GPS Coordinates" + }, + { + "name": "EUNationalIdentificationNumber", + "value": "EUNationalIdentificationNumber", + "description": "EU National Identification Number" + }, + { + "name": "EUPassportNumber", + "value": "EUPassportNumber", + "description": "EU Passport Number" + }, + { + "name": "EUSocialSecurityNumber", + "value": "EUSocialSecurityNumber", + "description": "EU Social Security Number" + }, + { + "name": "EUTaxIdentificationNumber", + "value": "EUTaxIdentificationNumber", + "description": "EU Tax Identification Number" + }, + { + "name": "FIEuropeanHealthNumber", + "value": "FIEuropeanHealthNumber", + "description": "FI European Health Number" + }, + { + "name": "FINationalID", + "value": "FINationalID", + "description": "FI National ID" + }, + { + "name": "FINationalIDV2", + "value": "FINationalIDV2", + "description": "FI National ID V2" + }, + { + "name": "FIPassportNumber", + "value": "FIPassportNumber", + "description": "FI Passport Number" + }, + { + "name": "FRDriversLicenseNumber", + "value": "FRDriversLicenseNumber", + "description": "FR Driver's License Number" + }, + { + "name": "FRHealthInsuranceNumber", + "value": "FRHealthInsuranceNumber", + "description": "FR Health Insurance Number" + }, + { + "name": "FRNationalID", + "value": "FRNationalID", + "description": "FR National ID" + }, + { + "name": "FRPassportNumber", + "value": "FRPassportNumber", + "description": "FR Passport Number" + }, + { + "name": "FRSocialSecurityNumber", + "value": "FRSocialSecurityNumber", + "description": "FR Social Security Number" + }, + { + "name": "FRTaxIdentificationNumber", + "value": "FRTaxIdentificationNumber", + "description": "FR Tax Identification Number" + }, + { + "name": "FRValueAddedTaxNumber", + "value": "FRValueAddedTaxNumber", + "description": "FR Value Added Tax Number" + }, + { + "name": "DEDriversLicenseNumber", + "value": "DEDriversLicenseNumber", + "description": "DE Driver's License Number" + }, + { + "name": "DEPassportNumber", + "value": "DEPassportNumber", + "description": "DE Passport Number" + }, + { + "name": "DEIdentityCardNumber", + "value": "DEIdentityCardNumber", + "description": "DE Identity Card Number" + }, + { + "name": "DETaxIdentificationNumber", + "value": "DETaxIdentificationNumber", + "description": "DE Tax Identification Number" + }, + { + "name": "DEValueAddedNumber", + "value": "DEValueAddedNumber", + "description": "DE Value Added Number" + }, + { + "name": "GRNationalIDCard", + "value": "GRNationalIDCard", + "description": "GR National ID Card" + }, + { + "name": "GRNationalIDV2", + "value": "GRNationalIDV2", + "description": "GR National ID V2" + }, + { + "name": "GRTaxIdentificationNumber", + "value": "GRTaxIdentificationNumber", + "description": "GR Tax Identification Number" + }, + { + "name": "HKIdentityCardNumber", + "value": "HKIdentityCardNumber", + "description": "HK Identity Card Number" + }, + { + "name": "HUValueAddedNumber", + "value": "HUValueAddedNumber", + "description": "HU Value Added Number" + }, + { + "name": "HUPersonalIdentificationNumber", + "value": "HUPersonalIdentificationNumber", + "description": "HU Personal Identification Number" + }, + { + "name": "HUTaxIdentificationNumber", + "value": "HUTaxIdentificationNumber", + "description": "HU Tax Identification Number" + }, + { + "name": "INPermanentAccount", + "value": "INPermanentAccount", + "description": "IN Permanent Account" + }, + { + "name": "INUniqueIdentificationNumber", + "value": "INUniqueIdentificationNumber", + "description": "IN Unique Identification Number" + }, + { + "name": "IDIdentityCardNumber", + "value": "IDIdentityCardNumber", + "description": "ID Identity Card Number" + }, + { + "name": "InternationalBankingAccountNumber", + "value": "InternationalBankingAccountNumber", + "description": "International Banking Account Number" + }, + { + "name": "IEPersonalPublicServiceNumber", + "value": "IEPersonalPublicServiceNumber", + "description": "IE Personal Public Service Number" + }, + { + "name": "IEPersonalPublicServiceNumberV2", + "value": "IEPersonalPublicServiceNumberV2", + "description": "IE Personal Public Service Number V2" + }, + { + "name": "ILBankAccountNumber", + "value": "ILBankAccountNumber", + "description": "IL Bank Account Number" + }, + { + "name": "ILNationalID", + "value": "ILNationalID", + "description": "IL National ID" + }, + { + "name": "ITDriversLicenseNumber", + "value": "ITDriversLicenseNumber", + "description": "IT Driver's License Number" + }, + { + "name": "ITFiscalCode", + "value": "ITFiscalCode", + "description": "IT Fiscal Code" + }, + { + "name": "ITValueAddedTaxNumber", + "value": "ITValueAddedTaxNumber", + "description": "IT Value Added Tax Number" + }, + { + "name": "JPBankAccountNumber", + "value": "JPBankAccountNumber", + "description": "JP Bank Account Number" + }, + { + "name": "JPDriversLicenseNumber", + "value": "JPDriversLicenseNumber", + "description": "JP Driver's License Number" + }, + { + "name": "JPPassportNumber", + "value": "JPPassportNumber", + "description": "JP Passport Number" + }, + { + "name": "JPResidentRegistrationNumber", + "value": "JPResidentRegistrationNumber", + "description": "JP Resident Registration Number" + }, + { + "name": "JPSocialInsuranceNumber", + "value": "JPSocialInsuranceNumber", + "description": "JP Social Insurance Number" + }, + { + "name": "JPMyNumberCorporate", + "value": "JPMyNumberCorporate", + "description": "JP My Number Corporate" + }, + { + "name": "JPMyNumberPersonal", + "value": "JPMyNumberPersonal", + "description": "JP My Number Personal" + }, + { + "name": "JPResidenceCardNumber", + "value": "JPResidenceCardNumber", + "description": "JP Residence Card Number" + }, + { + "name": "LVPersonalCode", + "value": "LVPersonalCode", + "description": "LV Personal Code" + }, + { + "name": "LTPersonalCode", + "value": "LTPersonalCode", + "description": "LT Personal Code" + }, + { + "name": "LUNationalIdentificationNumberNatural", + "value": "LUNationalIdentificationNumberNatural", + "description": "LU National Identification Number Natural" + }, + { + "name": "LUNationalIdentificationNumberNonNatural", + "value": "LUNationalIdentificationNumberNonNatural", + "description": "LU National Identification Number Non Natural" + }, + { + "name": "MYIdentityCardNumber", + "value": "MYIdentityCardNumber", + "description": "MY Identity Card Number" + }, + { + "name": "MTIdentityCardNumber", + "value": "MTIdentityCardNumber", + "description": "MT Identity Card Number" + }, + { + "name": "MTTaxIDNumber", + "value": "MTTaxIDNumber", + "description": "MT Tax ID Number" + }, + { + "name": "NLCitizensServiceNumber", + "value": "NLCitizensServiceNumber", + "description": "NL Citizens Service Number" + }, + { + "name": "NLCitizensServiceNumberV2", + "value": "NLCitizensServiceNumberV2", + "description": "NL Citizens Service Number V2" + }, + { + "name": "NLTaxIdentificationNumber", + "value": "NLTaxIdentificationNumber", + "description": "NL Tax Identification Number" + }, + { + "name": "NLValueAddedTaxNumber", + "value": "NLValueAddedTaxNumber", + "description": "NL Value Added Tax Number" + }, + { + "name": "NZBankAccountNumber", + "value": "NZBankAccountNumber", + "description": "NZ Bank Account Number" + }, + { + "name": "NZDriversLicenseNumber", + "value": "NZDriversLicenseNumber", + "description": "NZ Driver's License Number" + }, + { + "name": "NZInlandRevenueNumber", + "value": "NZInlandRevenueNumber", + "description": "NZ Inland Revenue Number" + }, + { + "name": "NZMinistryOfHealthNumber", + "value": "NZMinistryOfHealthNumber", + "description": "NZ Ministry Of Health Number" + }, + { + "name": "NZSocialWelfareNumber", + "value": "NZSocialWelfareNumber", + "description": "NZ Social Welfare Number" + }, + { + "name": "NOIdentityNumber", + "value": "NOIdentityNumber", + "description": "NO Identity Number" + }, + { + "name": "PHUnifiedMultiPurposeIDNumber", + "value": "PHUnifiedMultiPurposeIDNumber", + "description": "PH Unified Multi Purpose ID Number" + }, + { + "name": "PLIdentityCard", + "value": "PLIdentityCard", + "description": "PL Identity Card" + }, + { + "name": "PLNationalID", + "value": "PLNationalID", + "description": "PL National ID" + }, + { + "name": "PLNationalIDV2", + "value": "PLNationalIDV2", + "description": "PL National ID V2" + }, + { + "name": "PLPassportNumber", + "value": "PLPassportNumber", + "description": "PL Passport Number" + }, + { + "name": "PLTaxIdentificationNumber", + "value": "PLTaxIdentificationNumber", + "description": "PL Tax Identification Number" + }, + { + "name": "PLREGONNumber", + "value": "PLREGONNumber", + "description": "PL REGON Number" + }, + { + "name": "PTCitizenCardNumber", + "value": "PTCitizenCardNumber", + "description": "PT Citizen Card Number" + }, + { + "name": "PTCitizenCardNumberV2", + "value": "PTCitizenCardNumberV2", + "description": "PT Citizen Card Number V2" + }, + { + "name": "PTTaxIdentificationNumber", + "value": "PTTaxIdentificationNumber", + "description": "PT Tax Identification Number" + }, + { + "name": "ROPersonalNumericalCode", + "value": "ROPersonalNumericalCode", + "description": "RO Personal Numerical Code" + }, + { + "name": "RUPassportNumberDomestic", + "value": "RUPassportNumberDomestic", + "description": "RU Passport Number Domestic" + }, + { + "name": "RUPassportNumberInternational", + "value": "RUPassportNumberInternational", + "description": "RU Passport Number International" + }, + { + "name": "SANationalID", + "value": "SANationalID", + "description": "SA National ID" + }, + { + "name": "SGNationalRegistrationIdentityCardNumber", + "value": "SGNationalRegistrationIdentityCardNumber", + "description": "SG National Registration Identity Card Number" + }, + { + "name": "SKPersonalNumber", + "value": "SKPersonalNumber", + "description": "SK Personal Number" + }, + { + "name": "SITaxIdentificationNumber", + "value": "SITaxIdentificationNumber", + "description": "SI Tax Identification Number" + }, + { + "name": "SIUniqueMasterCitizenNumber", + "value": "SIUniqueMasterCitizenNumber", + "description": "SI Unique Master Citizen Number" + }, + { + "name": "ZAIdentificationNumber", + "value": "ZAIdentificationNumber", + "description": "ZA Identification Number" + }, + { + "name": "KRResidentRegistrationNumber", + "value": "KRResidentRegistrationNumber", + "description": "KR Resident Registration Number" + }, + { + "name": "ESDNI", + "value": "ESDNI", + "description": "ES DNI" + }, + { + "name": "ESSocialSecurityNumber", + "value": "ESSocialSecurityNumber", + "description": "ES Social Security Number" + }, + { + "name": "ESTaxIdentificationNumber", + "value": "ESTaxIdentificationNumber", + "description": "ES Tax Identification Number" + }, + { + "name": "SQLServerConnectionString", + "value": "SQLServerConnectionString", + "description": "SQL Server Connection String" + }, + { + "name": "SENationalID", + "value": "SENationalID", + "description": "SE National ID" + }, + { + "name": "SENationalIDV2", + "value": "SENationalIDV2", + "description": "SE National ID V2" + }, + { + "name": "SEPassportNumber", + "value": "SEPassportNumber", + "description": "SE Passport Number" + }, + { + "name": "SETaxIdentificationNumber", + "value": "SETaxIdentificationNumber", + "description": "SE Tax Identification Number" + }, + { + "name": "SWIFTCode", + "value": "SWIFTCode", + "description": "SWIFT Code" + }, + { + "name": "CHSocialSecurityNumber", + "value": "CHSocialSecurityNumber", + "description": "CH Social Security Number" + }, + { + "name": "TWNationalID", + "value": "TWNationalID", + "description": "TW National ID" + }, + { + "name": "TWPassportNumber", + "value": "TWPassportNumber", + "description": "TW Passport Number" + }, + { + "name": "TWResidentCertificate", + "value": "TWResidentCertificate", + "description": "TW Resident Certificate" + }, + { + "name": "THPopulationIdentificationCode", + "value": "THPopulationIdentificationCode", + "description": "TH Population Identification Code" + }, + { + "name": "TRNationalIdentificationNumber", + "value": "TRNationalIdentificationNumber", + "description": "TR National Identification Number" + }, + { + "name": "UKDriversLicenseNumber", + "value": "UKDriversLicenseNumber", + "description": "UK Driver's License Number" + }, + { + "name": "UKElectoralRollNumber", + "value": "UKElectoralRollNumber", + "description": "UK Electoral Roll Number" + }, + { + "name": "UKNationalHealthNumber", + "value": "UKNationalHealthNumber", + "description": "UK National Health Number" + }, + { + "name": "UKNationalInsuranceNumber", + "value": "UKNationalInsuranceNumber", + "description": "UK National Insurance Number" + }, + { + "name": "UKUniqueTaxpayerNumber", + "value": "UKUniqueTaxpayerNumber", + "description": "UK Unique Taxpayer Number" + }, + { + "name": "USUKPassportNumber", + "value": "USUKPassportNumber", + "description": "US UK Passport Number" + }, + { + "name": "USBankAccountNumber", + "value": "USBankAccountNumber", + "description": "US Bank Account Number" + }, + { + "name": "USDriversLicenseNumber", + "value": "USDriversLicenseNumber", + "description": "US Driver's License Number" + }, + { + "name": "USIndividualTaxpayerIdentification", + "value": "USIndividualTaxpayerIdentification", + "description": "US Individual Taxpayer Identification" + }, + { + "name": "USSocialSecurityNumber", + "value": "USSocialSecurityNumber", + "description": "US Social Security Number" + }, + { + "name": "UAPassportNumberDomestic", + "value": "UAPassportNumberDomestic", + "description": "UA Passport Number Domestic" + }, + { + "name": "UAPassportNumberInternational", + "value": "UAPassportNumberInternational", + "description": "UA Passport Number International" + }, + { + "name": "Organization", + "value": "Organization", + "description": "Organization" + }, + { + "name": "Email", + "value": "Email", + "description": "Email" + }, + { + "name": "URL", + "value": "URL", + "description": "URL" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "PhoneNumber", + "value": "PhoneNumber", + "description": "Phone Number" + }, + { + "name": "IPAddress", + "value": "IPAddress", + "description": "IP Address" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Person", + "value": "Person", + "description": "Person" + }, + { + "name": "Address", + "value": "Address", + "description": "Address" + }, + { + "name": "DateOfBirth", + "value": "DateOfBirth", + "description": "Date Of Birth" + }, + { + "name": "BankAccountNumber", + "value": "BankAccountNumber", + "description": "Bank Account Number" + }, + { + "name": "PassportNumber", + "value": "PassportNumber", + "description": "Passport Number" + }, + { + "name": "DriversLicenseNumber", + "value": "DriversLicenseNumber", + "description": "Drivers License Number" + }, + { + "name": "Neighborhood", + "value": "Neighborhood", + "description": "Neighborhood" + }, + { + "name": "SortCode", + "value": "SortCode", + "description": "Sort Code. 6-digit number used in the UK to identify a specific bank and branch where a bank account is held" + }, + { + "name": "PIN", + "value": "PIN", + "description": "PIN" + }, + { + "name": "VIN", + "value": "VIN", + "description": "VIN" + }, + { + "name": "LicensePlate", + "value": "LicensePlate", + "description": "License Plate" + }, + { + "name": "All", + "value": "All", + "description": "All PII categories." + }, + { + "name": "Default", + "value": "Default", + "description": "Default PII categories for the language." + } + ] + } + }, + "PiiEntityRecognitionLROResult": { + "type": "object", + "description": "Contains the PII LRO results.", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult", + "description": "The list of pii results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" + }, + "PiiEntityWithTags": { + "type": "object", + "description": "Entity object with tags.", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "type": { + "type": "string", + "description": "An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags are to express some similarities/affinity between entities.", + "items": { + "$ref": "#/definitions/EntityTag" + } + }, + "mask": { + "type": "string", + "description": "Optional field which will be returned only when using the redaction policy kind “MaskWithEntityType”. This field will contain the exact mask text used to mask the PII entity in the original text" + }, + "maskOffset": { + "type": "integer", + "format": "int32", + "description": "Start position of masked text in the redacted text when using the redaction policy kind “MaskWithEntityType”." + }, + "maskLength": { + "type": "integer", + "format": "int32", + "description": "The length of the masked text. Will be present when using the redaction policy kind “MaskWithEntityType”." + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "PiiLROTask": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition LRO task.", + "properties": { + "parameters": { + "$ref": "#/definitions/PiiTaskParameters", + "description": "Pii task parameters." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "PiiResult": { + "type": "object", + "description": "Contains the PiiResult.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/PiiResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "PiiResultWithDetectedLanguage": { + "type": "object", + "description": "Contains the PII results with detected language.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "redactedText": { + "type": "string", + "description": "Returns redacted text." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/PiiEntityWithTags" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "redactedText", + "entities" + ] + }, + "PiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a PII Entities Recognition task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": true + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "domain": { + "type": "string", + "description": "Domain for PII task", + "default": "none", + "enum": [ + "phi", + "none" + ], + "x-ms-enum": { + "name": "PiiDomain", + "modelAsString": true, + "values": [ + { + "name": "phi", + "value": "phi", + "description": "Indicates that entities in the Personal Health Information domain should be redacted." + }, + { + "name": "none", + "value": "none", + "description": "Indicates that no domain is specified." + } + ] + } + }, + "piiCategories": { + "type": "array", + "description": "Enumeration of PII categories to be returned in the response.", + "items": { + "$ref": "#/definitions/PiiCategory" + } + }, + "stringIndexType": { + "type": "string", + "description": "StringIndexType to be used for analysis.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "excludePiiCategories": { + "type": "array", + "description": "Enumeration of PII categories to be excluded in the response.", + "items": { + "$ref": "#/definitions/PiiCategoriesExclude" + } + }, + "redactionPolicy": { + "$ref": "#/definitions/BaseRedactionPolicy", + "description": "RedactionPolicy to be used on the input." + }, + "valueExclusionPolicy": { + "$ref": "#/definitions/ValueExclusionPolicy", + "description": "Policy for specific words and terms that should be excluded from detection by the PII detection service" + }, + "entitySynonyms": { + "type": "array", + "description": "(Optional) request parameter that allows the user to provide synonyms for context words that to enhance pii entity detection.", + "items": { + "$ref": "#/definitions/EntitySynonyms" + } + } + } + }, + "PiiTaskResult": { + "type": "object", + "description": "Contains the analyze text PIIEntityRecognition LRO task.", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult", + "description": "The list of pii results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognitionResults" + }, + "RangeInclusivity": { + "type": "string", + "description": "The range inclusiveness of this property property.", + "enum": [ + "NoneInclusive", + "LeftInclusive", + "RightInclusive", + "LeftRightInclusive" + ], + "x-ms-enum": { + "name": "RangeInclusivity", + "modelAsString": true, + "values": [ + { + "name": "NoneInclusive", + "value": "NoneInclusive", + "description": "No inclusivity" + }, + { + "name": "LeftInclusive", + "value": "LeftInclusive", + "description": "Left side inclusive" + }, + { + "name": "RightInclusive", + "value": "RightInclusive", + "description": "Right side inclusive" + }, + { + "name": "LeftRightInclusive", + "value": "LeftRightInclusive", + "description": "Both sides inclusive" + } + ] + } + }, + "RangeKind": { + "type": "string", + "description": "The kind of the number range entity.", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true, + "values": [ + { + "name": "Number", + "value": "Number", + "description": "Number range" + }, + { + "name": "Speed", + "value": "Speed", + "description": "Speed range" + }, + { + "name": "Weight", + "value": "Weight", + "description": "Weight range" + }, + { + "name": "Length", + "value": "Length", + "description": "Length range" + }, + { + "name": "Volume", + "value": "Volume", + "description": "Volume range" + }, + { + "name": "Area", + "value": "Area", + "description": "Area range" + }, + { + "name": "Age", + "value": "Age", + "description": "Age range" + }, + { + "name": "Information", + "value": "Information", + "description": "Information range" + }, + { + "name": "Temperature", + "value": "Temperature", + "description": "Temperature range" + }, + { + "name": "Currency", + "value": "Currency", + "description": "Currency range" + } + ] + } + }, + "RelativeTo": { + "type": "string", + "description": "The reference point that the ordinal number denotes.", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true, + "values": [ + { + "name": "Current", + "value": "Current", + "description": "Current state or position" + }, + { + "name": "End", + "value": "End", + "description": "End state or position" + }, + { + "name": "Start", + "value": "Start", + "description": "Start state or position" + } + ] + } + }, + "RequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the request payload.", + "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." + } + }, + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ] + }, + "ScriptCode": { + "type": "string", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard script code.", + "enum": [ + "Arab", + "Armn", + "Beng", + "Cans", + "Cyrl", + "Deva", + "Ethi", + "Geor", + "Grek", + "Gujr", + "Guru", + "Hang", + "Hani", + "Hans", + "Hant", + "Hebr", + "Jpan", + "Khmr", + "Knda", + "Laoo", + "Latn", + "Mlym", + "Mong", + "Mtei", + "Mymr", + "Olck", + "Orya", + "Sinh", + "Shrd", + "Taml", + "Telu", + "Thaa", + "Thai", + "Tibt" + ], + "x-ms-enum": { + "name": "ScriptCode", + "modelAsString": true, + "values": [ + { + "name": "Arab", + "value": "Arab", + "description": "Script code for the Arabic script." + }, + { + "name": "Armn", + "value": "Armn", + "description": "Script code for the Armenian script." + }, + { + "name": "Beng", + "value": "Beng", + "description": "Script code for the Bangla script." + }, + { + "name": "Cans", + "value": "Cans", + "description": "Script code for the UnifiedCanadianAboriginalSyllabics script." + }, + { + "name": "Cyrl", + "value": "Cyrl", + "description": "Script code for the Cyrillic script." + }, + { + "name": "Deva", + "value": "Deva", + "description": "Script code for the Devanagari script." + }, + { + "name": "Ethi", + "value": "Ethi", + "description": "Script code for the Ethiopic script." + }, + { + "name": "Geor", + "value": "Geor", + "description": "Script code for the Georgian script." + }, + { + "name": "Grek", + "value": "Grek", + "description": "Script code for the Greek script." + }, + { + "name": "Gujr", + "value": "Gujr", + "description": "Script code for the Gujarati script." + }, + { + "name": "Guru", + "value": "Guru", + "description": "Script code for the Gurmukhi script." + }, + { + "name": "Hang", + "value": "Hang", + "description": "Script code for the Hangul script." + }, + { + "name": "Hani", + "value": "Hani", + "description": "Script code for the HanLiteral script." + }, + { + "name": "Hans", + "value": "Hans", + "description": "Script code for the HanSimplified script." + }, + { + "name": "Hant", + "value": "Hant", + "description": "Script code for the HanTraditional script." + }, + { + "name": "Hebr", + "value": "Hebr", + "description": "Script code for the Hebrew script." + }, + { + "name": "Jpan", + "value": "Jpan", + "description": "Script code for the Japanese script." + }, + { + "name": "Khmr", + "value": "Khmr", + "description": "Script code for the Khmer script." + }, + { + "name": "Knda", + "value": "Knda", + "description": "Script code for the Kannada script." + }, + { + "name": "Laoo", + "value": "Laoo", + "description": "Script code for the Lao script." + }, + { + "name": "Latn", + "value": "Latn", + "description": "Script code for the Latin script." + }, + { + "name": "Mlym", + "value": "Mlym", + "description": "Script code for the Malayalam script." + }, + { + "name": "Mong", + "value": "Mong", + "description": "Script code for the Mongolian script." + }, + { + "name": "Mtei", + "value": "Mtei", + "description": "Script code for the Meitei script." + }, + { + "name": "Mymr", + "value": "Mymr", + "description": "Script code for the Myanmar script." + }, + { + "name": "Olck", + "value": "Olck", + "description": "Script code for the Santali script." + }, + { + "name": "Orya", + "value": "Orya", + "description": "Script code for the Odia script." + }, + { + "name": "Sinh", + "value": "Sinh", + "description": "Script code for the Sinhala script." + }, + { + "name": "Shrd", + "value": "Shrd", + "description": "Script code for the Sharada script." + }, + { + "name": "Taml", + "value": "Taml", + "description": "Script code for the Tamil script." + }, + { + "name": "Telu", + "value": "Telu", + "description": "Script code for the Telugu script." + }, + { + "name": "Thaa", + "value": "Thaa", + "description": "Script code for the Thaana script." + }, + { + "name": "Thai", + "value": "Thai", + "description": "Script code for the Thai script." + }, + { + "name": "Tibt", + "value": "Tibt", + "description": "Script code for the Tibetan script." + } + ] + } + }, + "ScriptKind": { + "type": "string", + "description": "Identifies the script of the input document. Maps to the ISO 15924 standard formal name.", + "enum": [ + "Arabic", + "Armenian", + "Bangla", + "UnifiedCanadianAboriginalSyllabics", + "Cyrillic", + "Devanagari", + "Ethiopic", + "Georgian", + "Greek", + "Gujarati", + "Gurmukhi", + "Hangul", + "HanLiteral", + "HanSimplified", + "HanTraditional", + "Hebrew", + "Japanese", + "Khmer", + "Kannada", + "Lao", + "Latin", + "Malayalam", + "Meitei", + "Mongolian", + "Myanmar", + "Odia", + "Santali", + "Sharada", + "Sinhala", + "Tamil", + "Telugu", + "Thaana", + "Thai", + "Tibetan" + ], + "x-ms-enum": { + "name": "ScriptKind", + "modelAsString": true, + "values": [ + { + "name": "Arabic", + "value": "Arabic", + "description": "Script name for the Arabic script." + }, + { + "name": "Armenian", + "value": "Armenian", + "description": "Script name for the Armenian script." + }, + { + "name": "Bangla", + "value": "Bangla", + "description": "Script name for the Bangla script." + }, + { + "name": "UnifiedCanadianAboriginalSyllabics", + "value": "UnifiedCanadianAboriginalSyllabics", + "description": "Script name for the UnifiedCanadianAboriginalSyllabics script." + }, + { + "name": "Cyrillic", + "value": "Cyrillic", + "description": "Script name for the Cyrillic script." + }, + { + "name": "Devanagari", + "value": "Devanagari", + "description": "Script name for the Devanagari script." + }, + { + "name": "Ethiopic", + "value": "Ethiopic", + "description": "Script name for the Ethiopic script." + }, + { + "name": "Georgian", + "value": "Georgian", + "description": "Script name for the Georgian script." + }, + { + "name": "Greek", + "value": "Greek", + "description": "Script name for the Greek script." + }, + { + "name": "Gujarati", + "value": "Gujarati", + "description": "Script name for the Gujarati script." + }, + { + "name": "Gurmukhi", + "value": "Gurmukhi", + "description": "Script name for the Gurmukhi script." + }, + { + "name": "Hangul", + "value": "Hangul", + "description": "Script name for the Hangul script." + }, + { + "name": "HanLiteral", + "value": "HanLiteral", + "description": "Script name for the HanLiteral script." + }, + { + "name": "HanSimplified", + "value": "HanSimplified", + "description": "Script name for the HanSimplified script." + }, + { + "name": "HanTraditional", + "value": "HanTraditional", + "description": "Script name for the HanTraditional script." + }, + { + "name": "Hebrew", + "value": "Hebrew", + "description": "Script name for the Hebrew script." + }, + { + "name": "Japanese", + "value": "Japanese", + "description": "Script name for the Japanese script." + }, + { + "name": "Khmer", + "value": "Khmer", + "description": "Script name for the Khmer script." + }, + { + "name": "Kannada", + "value": "Kannada", + "description": "Script name for the Kannada script." + }, + { + "name": "Lao", + "value": "Lao", + "description": "Script name for the Lao script." + }, + { + "name": "Latin", + "value": "Latin", + "description": "Script name for the Latin script." + }, + { + "name": "Malayalam", + "value": "Malayalam", + "description": "Script name for the Malayalam script." + }, + { + "name": "Meitei", + "value": "Meitei", + "description": "Script name for the Meitei script." + }, + { + "name": "Mongolian", + "value": "Mongolian", + "description": "Script name for the Mongolian script." + }, + { + "name": "Myanmar", + "value": "Myanmar", + "description": "Script name for the Myanmar script." + }, + { + "name": "Odia", + "value": "Odia", + "description": "Script name for the Odia script." + }, + { + "name": "Santali", + "value": "Santali", + "description": "Script name for the Santali script." + }, + { + "name": "Sharada", + "value": "Sharada", + "description": "Script name for the Sharada script." + }, + { + "name": "Sinhala", + "value": "Sinhala", + "description": "Script name for the Sinhala script." + }, + { + "name": "Tamil", + "value": "Tamil", + "description": "Script name for the Tamil script." + }, + { + "name": "Telugu", + "value": "Telugu", + "description": "Script name for the Telugu script." + }, + { + "name": "Thaana", + "value": "Thaana", + "description": "Script name for the Thaana script." + }, + { + "name": "Thai", + "value": "Thai", + "description": "Script name for the Thai script." + }, + { + "name": "Tibetan", + "value": "Tibetan", + "description": "Script name for the Tibetan script." + } + ] + } + }, + "SentenceAssessment": { + "type": "object", + "description": "Represents a sentence assessment and the assessments or target objects related to it.", + "properties": { + "sentiment": { + "$ref": "#/definitions/TokenSentimentValue", + "description": "The sentiment of the sentence." + }, + "confidenceScores": { + "$ref": "#/definitions/TargetConfidenceScoreLabel", + "description": "Represents the confidence scores across all sentiment classes: positive and negative." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "isNegated": { + "type": "boolean", + "description": "The indicator representing if the assessment is negated." + } + }, + "required": [ + "sentiment", + "confidenceScores", + "offset", + "length", + "text", + "isNegated" + ] + }, + "SentenceSentiment": { + "type": "object", + "description": "A document's sentence sentiment.", + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "$ref": "#/definitions/SentenceSentimentValue", + "description": "The predicted Sentiment for the sentence." + }, + "confidenceScores": { + "$ref": "#/definitions/SentimentConfidenceScores", + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "targets": { + "type": "array", + "description": "The array of sentence targets for the sentence.", + "items": { + "$ref": "#/definitions/SentenceTarget" + } + }, + "assessments": { + "type": "array", + "description": "The array of assessments for the sentence.", + "items": { + "$ref": "#/definitions/SentenceAssessment" + } + } + }, + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ] + }, + "SentenceSentimentValue": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive sentiment" + }, + { + "name": "neutral", + "value": "neutral", + "description": "Neutral sentiment" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative sentiment" + } + ] + } + }, + "SentenceTarget": { + "type": "object", + "description": "Represents a sentence target and the assessments or target objects related to it.", + "properties": { + "sentiment": { + "$ref": "#/definitions/TokenSentimentValue", + "description": "The sentiment of the sentence." + }, + "confidenceScores": { + "$ref": "#/definitions/TargetConfidenceScoreLabel", + "description": "Represents the confidence scores across all sentiment classes: positive and negative." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "relations": { + "type": "array", + "description": "The array of either assessment or target objects which is related to the target.", + "items": { + "$ref": "#/definitions/TargetRelation" + } + } + }, + "required": [ + "sentiment", + "confidenceScores", + "offset", + "length", + "text", + "relations" + ] + }, + "SentimentAnalysisLROTask": { + "type": "object", + "description": "An object representing the task definition for a Sentiment Analysis task.", + "properties": { + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters", + "description": "Parameters for the Sentiment Analysis task." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "SentimentAnalysisTaskParameters": { + "type": "object", + "description": "Supported parameters for a Sentiment Analysis task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "description": "logging opt out", + "default": false + }, + "modelVersion": { + "type": "string", + "description": "model version", + "default": "latest" + }, + "opinionMining": { + "type": "boolean", + "description": "Whether to use opinion mining in the request or not.", + "default": false + }, + "stringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "TextElements_v8", + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "name": "UnicodeCodePoint", + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + } + } + }, + "SentimentConfidenceScores": { + "type": "object", + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.", + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "neutral": { + "type": "number", + "format": "double", + "description": "Confidence score for neutral sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "required": [ + "positive", + "neutral", + "negative" + ] + }, + "SentimentDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Sentiment analysis per document.", + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "$ref": "#/definitions/DocumentStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "sentiment": { + "$ref": "#/definitions/DocumentSentimentValue", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed)." + }, + "confidenceScores": { + "$ref": "#/definitions/SentimentConfidenceScores", + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes." + }, + "sentences": { + "type": "array", + "description": "The document's sentences sentiment.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + }, + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + }, + "required": [ + "id", + "warnings", + "sentiment", + "confidenceScores", + "sentences" + ] + }, + "SentimentLROResult": { + "type": "object", + "description": "Contains the Sentiment Analysis LRO results.", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse", + "description": "The sentiment analysis results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "x-ms-discriminator-value": "SentimentAnalysisLROResults" + }, + "SentimentResponse": { + "type": "object", + "description": "Sentiment analysis results for the input documents.", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics", + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + }, + "documents": { + "type": "array", + "description": "The sentiment analysis results for each document in the input.", + "items": { + "$ref": "#/definitions/SentimentDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "errors", + "modelVersion", + "documents" + ] + }, + "SentimentTaskResult": { + "type": "object", + "description": "Contains the analyze text SentimentAnalysis LRO task result.", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse", + "description": "The sentiment analysis results" + } + }, + "required": [ + "results" + ], + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "x-ms-discriminator-value": "SentimentAnalysisResults" + }, + "SpeedMetadata": { + "type": "object", + "description": "Represents the Speed entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/SpeedUnit", + "description": "Unit of measure for speed." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "SpeedMetadata" + }, + "SpeedUnit": { + "type": "string", + "description": "The speed Unit of measurement", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knots", + "FeetPerSecond", + "FeetPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified speed unit." + }, + { + "name": "MetersPerSecond", + "value": "MetersPerSecond", + "description": "Speed unit in meters per second." + }, + { + "name": "KilometersPerHour", + "value": "KilometersPerHour", + "description": "Speed unit in kilometers per hour." + }, + { + "name": "KilometersPerMinute", + "value": "KilometersPerMinute", + "description": "Speed unit in kilometers per minute." + }, + { + "name": "KilometersPerSecond", + "value": "KilometersPerSecond", + "description": "Speed unit in kilometers per second." + }, + { + "name": "MilesPerHour", + "value": "MilesPerHour", + "description": "Speed unit in miles per hour." + }, + { + "name": "Knots", + "value": "Knots", + "description": "Speed unit in knots." + }, + { + "name": "FeetPerSecond", + "value": "FeetPerSecond", + "description": "Speed unit in feet per second." + }, + { + "name": "FeetPerMinute", + "value": "FeetPerMinute", + "description": "Speed unit in feet per minute." + }, + { + "name": "YardsPerMinute", + "value": "YardsPerMinute", + "description": "Speed unit in yards per minute." + }, + { + "name": "YardsPerSecond", + "value": "YardsPerSecond", + "description": "Speed unit in yards per second." + }, + { + "name": "MetersPerMillisecond", + "value": "MetersPerMillisecond", + "description": "Speed unit in meters per millisecond." + }, + { + "name": "CentimetersPerMillisecond", + "value": "CentimetersPerMillisecond", + "description": "Speed unit in centimeters per millisecond." + }, + { + "name": "KilometersPerMillisecond", + "value": "KilometersPerMillisecond", + "description": "Speed unit in Kilometers per millisecond." + } + ] + } + }, + "State": { + "type": "string", + "description": "The status of the task at the mentioned last update time.", + "enum": [ + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted", + "description": "Not started status" + }, + { + "name": "running", + "value": "running", + "description": "Running status" + }, + { + "name": "succeeded", + "value": "succeeded", + "description": "Succeeded status" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted", + "description": "Partially completed status" + }, + { + "name": "failed", + "value": "failed", + "description": "Failed status" + }, + { + "name": "cancelled", + "value": "cancelled", + "description": "Cancelled status" + }, + { + "name": "cancelling", + "value": "cancelling", + "description": "Cancelling status" + } + ] + } + }, + "SummaryContext": { + "type": "object", + "description": "The context of the summary.", + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." + } + }, + "required": [ + "offset", + "length" + ] + }, + "SummaryLengthBucket": { + "type": "string", + "description": "Enum that defines the length of the output summaries.", + "enum": [ + "short", + "medium", + "long" + ], + "x-ms-enum": { + "name": "SummaryLengthBucket", + "modelAsString": true, + "values": [ + { + "name": "short", + "value": "short", + "description": "Instructs model to generate shorter length summaries." + }, + { + "name": "medium", + "value": "medium", + "description": "Instructs model to generate medium length summaries." + }, + { + "name": "long", + "value": "long", + "description": "Instructs model to generate longer length summaries." + } + ] + } + }, + "TargetConfidenceScoreLabel": { + "type": "object", + "description": "Represents the confidence scores across all sentiment classes: positive and negative.", + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "required": [ + "positive", + "negative" + ] + }, + "TargetRelation": { + "type": "object", + "description": "Represents the relation between assessments and/or targets.", + "properties": { + "ref": { + "type": "string", + "description": "The JSON pointer indicating the linked object." + }, + "relationType": { + "$ref": "#/definitions/TargetRelationType", + "description": "The type related to the target." + } + }, + "required": [ + "ref", + "relationType" + ] + }, + "TargetRelationType": { + "type": "string", + "description": "The type related to the target.", + "enum": [ + "assessment", + "target" + ], + "x-ms-enum": { + "name": "TargetRelationType", + "modelAsString": false, + "values": [ + { + "name": "assessment", + "value": "assessment", + "description": "Assessment relation." + }, + { + "name": "target", + "value": "target", + "description": "Target relation." + } + ] + } + }, + "Tasks": { + "type": "object", + "description": "Container for the tasks status for the LRO job.", + "properties": { + "completed": { + "type": "integer", + "format": "int32", + "description": "Count of completed tasks." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "Count of failed tasks." + }, + "inProgress": { + "type": "integer", + "format": "int32", + "description": "Count of inprogress tasks." + }, + "total": { + "type": "integer", + "format": "int32", + "description": "Count of total tasks." + }, + "items": { + "type": "array", + "description": "Enumerable of Analyze text job results.", + "items": { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + } + }, + "required": [ + "completed", + "failed", + "inProgress", + "total" + ] + }, + "TemperatureMetadata": { + "type": "object", + "description": "Represents the Information entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/TemperatureUnit", + "description": "Unit of measure for temperature." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TemperatureMetadata" + }, + "TemperatureUnit": { + "type": "string", + "description": "The temperature Unit of measurement.", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified temperature unit" + }, + { + "name": "Fahrenheit", + "value": "Fahrenheit", + "description": "Temperature unit in Fahrenheit" + }, + { + "name": "Kelvin", + "value": "Kelvin", + "description": "Temperature unit in Kelvin" + }, + { + "name": "Rankine", + "value": "Rankine", + "description": "Temperature unit in Rankine" + }, + { + "name": "Celsius", + "value": "Celsius", + "description": "Temperature unit in Celsius" + } + ] + } + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true, + "values": [ + { + "name": "AfterApprox", + "value": "AfterApprox", + "description": "After an approximate time" + }, + { + "name": "Before", + "value": "Before", + "description": "Before a specific time" + }, + { + "name": "BeforeStart", + "value": "BeforeStart", + "description": "Before the start of a time period" + }, + { + "name": "Approx", + "value": "Approx", + "description": "Approximately at a specific time" + }, + { + "name": "ReferenceUndefined", + "value": "ReferenceUndefined", + "description": "Reference to an undefined time" + }, + { + "name": "SinceEnd", + "value": "SinceEnd", + "description": "Since the end of a time period" + }, + { + "name": "AfterMid", + "value": "AfterMid", + "description": "After the middle of a time period" + }, + { + "name": "Start", + "value": "Start", + "description": "At the start of a time period" + }, + { + "name": "After", + "value": "After", + "description": "After a specific time" + }, + { + "name": "BeforeEnd", + "value": "BeforeEnd", + "description": "Before the end of a time period" + }, + { + "name": "Until", + "value": "Until", + "description": "Until a specific time" + }, + { + "name": "End", + "value": "End", + "description": "At the end of a time period" + }, + { + "name": "Less", + "value": "Less", + "description": "Less than a specific time" + }, + { + "name": "Since", + "value": "Since", + "description": "Since a specific time" + }, + { + "name": "AfterStart", + "value": "AfterStart", + "description": "After the start of a time period" + }, + { + "name": "BeforeApprox", + "value": "BeforeApprox", + "description": "Before an approximate time" + }, + { + "name": "Mid", + "value": "Mid", + "description": "In the middle of a time period" + }, + { + "name": "More", + "value": "More", + "description": "More than a specific time" + } + ] + } + }, + "TemporalSetMetadata": { + "type": "object", + "description": "A Metadata for temporal set entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TemporalSetMetadata" + }, + "TemporalSpanMetadata": { + "type": "object", + "description": "represents the Metadata of a date and/or time span.", + "properties": { + "spanValues": { + "type": "array", + "description": "List of temporal spans detected.", + "items": { + "$ref": "#/definitions/TemporalSpanValues" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TemporalSpanMetadata" + }, + "TemporalSpanValues": { + "type": "object", + "description": "Temporal span object.", + "properties": { + "begin": { + "type": "string", + "description": "Start value for the span." + }, + "end": { + "type": "string", + "description": "End value for the span." + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier", + "description": "Modifier for datetime to indicate point of reference like before, after etc." + }, + "timex": { + "type": "string", + "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." + } + } + }, + "Temporality": { + "type": "string", + "description": "Describes temporal information regarding the entity.", + "enum": [ + "current", + "past", + "future" + ], + "x-ms-enum": { + "name": "Temporality", + "modelAsString": false, + "values": [ + { + "name": "current", + "value": "current", + "description": "Current temporality" + }, + { + "name": "past", + "value": "past", + "description": "Past temporality" + }, + { + "name": "future", + "value": "future", + "description": "Future temporality" + } + ] + } + }, + "TimeMetadata": { + "type": "object", + "description": "A Metadata for time entity instances.", + "properties": { + "dateValues": { + "type": "array", + "description": "List of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "TimeMetadata" + }, + "TokenSentimentValue": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false, + "values": [ + { + "name": "positive", + "value": "positive", + "description": "Positive sentiment" + }, + { + "name": "mixed", + "value": "mixed", + "description": "Mixed sentiment" + }, + { + "name": "negative", + "value": "negative", + "description": "Negative sentiment" + } + ] + } + }, + "ValueExclusionPolicy": { + "type": "object", + "description": "Policy for specific words and terms that should be excluded from detection by the PII detection service", + "properties": { + "caseSensitive": { + "type": "boolean", + "description": "Option to make the values excluded values case sensitive", + "default": false + }, + "excludedValues": { + "type": "array", + "description": "List of words and terms that should be excluded from detection by the PII detection service", + "items": { + "type": "string" + } + } + }, + "required": [ + "caseSensitive", + "excludedValues" + ] + }, + "VolumeMetadata": { + "type": "object", + "description": "Represents the Volume entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/VolumeUnit", + "description": "Unit of measure for volume." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "VolumeMetadata" + }, + "VolumeUnit": { + "type": "string", + "description": "The Volume Unit of measurement", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified volume unit." + }, + { + "name": "CubicMeter", + "value": "CubicMeter", + "description": "Volume unit in cubic meters." + }, + { + "name": "CubicCentimeter", + "value": "CubicCentimeter", + "description": "Volume unit in cubic centimeters." + }, + { + "name": "CubicMillimeter", + "value": "CubicMillimeter", + "description": "Volume unit in cubic millimeters." + }, + { + "name": "Hectoliter", + "value": "Hectoliter", + "description": "Volume unit in hectoliters." + }, + { + "name": "Decaliter", + "value": "Decaliter", + "description": "Volume unit in decaliters." + }, + { + "name": "Liter", + "value": "Liter", + "description": "Volume unit in liters." + }, + { + "name": "Centiliter", + "value": "Centiliter", + "description": "Volume unit in centiliters." + }, + { + "name": "Milliliter", + "value": "Milliliter", + "description": "Volume unit in milliliters." + }, + { + "name": "CubicYard", + "value": "CubicYard", + "description": "Volume unit in cubic yards." + }, + { + "name": "CubicInch", + "value": "CubicInch", + "description": "Volume unit in cubic inches." + }, + { + "name": "CubicFoot", + "value": "CubicFoot", + "description": "Volume unit in cubic feet." + }, + { + "name": "CubicMile", + "value": "CubicMile", + "description": "Volume unit in cubic miles." + }, + { + "name": "FluidOunce", + "value": "FluidOunce", + "description": "Volume unit in fluid ounces." + }, + { + "name": "Teaspoon", + "value": "Teaspoon", + "description": "Volume unit in teaspoons." + }, + { + "name": "Tablespoon", + "value": "Tablespoon", + "description": "Volume unit in tablespoons." + }, + { + "name": "Pint", + "value": "Pint", + "description": "Volume unit in pints." + }, + { + "name": "Quart", + "value": "Quart", + "description": "Volume unit in quarts." + }, + { + "name": "Cup", + "value": "Cup", + "description": "Volume unit in cups." + }, + { + "name": "Gill", + "value": "Gill", + "description": "Volume unit in gills." + }, + { + "name": "Pinch", + "value": "Pinch", + "description": "Volume unit in pinches." + }, + { + "name": "FluidDram", + "value": "FluidDram", + "description": "Volume unit in fluid drams." + }, + { + "name": "Barrel", + "value": "Barrel", + "description": "Volume unit in barrels." + }, + { + "name": "Minim", + "value": "Minim", + "description": "Volume unit in minims." + }, + { + "name": "Cord", + "value": "Cord", + "description": "Volume unit in cords." + }, + { + "name": "Peck", + "value": "Peck", + "description": "Volume unit in pecks." + }, + { + "name": "Bushel", + "value": "Bushel", + "description": "Volume unit in bushels." + }, + { + "name": "Hogshead", + "value": "Hogshead", + "description": "Volume unit in hogsheads." + } + ] + } + }, + "WarningCodeValue": { + "type": "string", + "description": "Defines the list of the warning codes.", + "enum": [ + "LongWordsInDocument", + "DocumentTruncated" + ], + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true, + "values": [ + { + "name": "LongWordsInDocument", + "value": "LongWordsInDocument", + "description": "Long words in document warning" + }, + { + "name": "DocumentTruncated", + "value": "DocumentTruncated", + "description": "Document truncated warning" + } + ] + } + }, + "WeightMetadata": { + "type": "object", + "description": "Represents the Weight ) entity Metadata model.", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + }, + "unit": { + "$ref": "#/definitions/WeightUnit", + "description": "Unit of measure for weight." + } + }, + "required": [ + "value", + "unit" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "x-ms-discriminator-value": "WeightMetadata" + }, + "WeightUnit": { + "type": "string", + "description": "The weight Unit of measurement.", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true, + "values": [ + { + "name": "Unspecified", + "value": "Unspecified", + "description": "Unspecified weight unit" + }, + { + "name": "Kilogram", + "value": "Kilogram", + "description": "Weight unit in kilograms" + }, + { + "name": "Gram", + "value": "Gram", + "description": "Weight unit in grams" + }, + { + "name": "Milligram", + "value": "Milligram", + "description": "Weight unit in milligrams" + }, + { + "name": "Gallon", + "value": "Gallon", + "description": "Volume unit in gallons" + }, + { + "name": "MetricTon", + "value": "MetricTon", + "description": "Weight unit in metric tons" + }, + { + "name": "Ton", + "value": "Ton", + "description": "Weight unit in tons" + }, + { + "name": "Pound", + "value": "Pound", + "description": "Weight unit in pounds" + }, + { + "name": "Ounce", + "value": "Ounce", + "description": "Weight unit in ounces" + }, + { + "name": "Grain", + "value": "Grain", + "description": "Weight unit in grains" + }, + { + "name": "PennyWeight", + "value": "PennyWeight", + "description": "Weight unit in pennyweights" + }, + { + "name": "LongTonBritish", + "value": "LongTonBritish", + "description": "Weight unit in long tons (British)" + }, + { + "name": "ShortTonUS", + "value": "ShortTonUS", + "description": "Weight unit in short tons (US)" + }, + { + "name": "ShortHundredWeightUS", + "value": "ShortHundredWeightUS", + "description": "Weight unit in short hundredweights (US)" + }, + { + "name": "Stone", + "value": "Stone", + "description": "Weight unit in stones" + }, + { + "name": "Dram", + "value": "Dram", + "description": "Weight unit in drams" + } + ] + } + }, + "fhirVersion": { + "type": "string", + "description": "The FHIR Spec version.", + "enum": [ + "4.0.1" + ], + "x-ms-enum": { + "name": "fhirVersion", + "modelAsString": true, + "values": [ + { + "name": "4.0.1", + "value": "4.0.1", + "description": "Version 4.0.1" + } + ] + } + }, + "healthcareDocumentType": { + "type": "string", + "description": "Document type.", + "enum": [ + "None", + "ClinicalTrial", + "DischargeSummary", + "ProgressNote", + "HistoryAndPhysical", + "Consult", + "Imaging", + "Pathology", + "ProcedureNote" + ], + "x-ms-enum": { + "name": "healthcareDocumentType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None document type" + }, + { + "name": "ClinicalTrial", + "value": "ClinicalTrial", + "description": "Clinical trial document type" + }, + { + "name": "DischargeSummary", + "value": "DischargeSummary", + "description": "Discharge summary document type" + }, + { + "name": "ProgressNote", + "value": "ProgressNote", + "description": "Progress note document type" + }, + { + "name": "HistoryAndPhysical", + "value": "HistoryAndPhysical", + "description": "History and physical document type" + }, + { + "name": "Consult", + "value": "Consult", + "description": "Consult document type" + }, + { + "name": "Imaging", + "value": "Imaging", + "description": "Imaging document type" + }, + { + "name": "Pathology", + "value": "Pathology", + "description": "Pathology document type" + }, + { + "name": "ProcedureNote", + "value": "ProcedureNote", + "description": "Procedure note document type" + } + ] + } + }, + "healthcareEntityCategory": { + "type": "string", + "description": "Healthcare Entity Category.", + "enum": [ + "BodyStructure", + "Age", + "Gender", + "ExaminationName", + "Date", + "Direction", + "Frequency", + "MeasurementValue", + "MeasurementUnit", + "RelationalOperator", + "Time", + "GeneOrProtein", + "Variant", + "AdministrativeEvent", + "CareEnvironment", + "HealthcareProfession", + "Diagnosis", + "SymptomOrSign", + "ConditionQualifier", + "MedicationClass", + "MedicationName", + "Dosage", + "MedicationForm", + "MedicationRoute", + "FamilyRelation", + "TreatmentName", + "Ethnicity", + "Course", + "Expression", + "MutationType", + "ConditionScale", + "Allergen", + "Employment", + "LivingStatus", + "SubstanceUse", + "SubstanceUseAmount" + ], + "x-ms-enum": { + "name": "healthcareEntityCategory", + "modelAsString": true, + "values": [ + { + "name": "BodyStructure", + "value": "BodyStructure", + "description": "Body structure" + }, + { + "name": "Age", + "value": "Age", + "description": "Age" + }, + { + "name": "Gender", + "value": "Gender", + "description": "Gender" + }, + { + "name": "ExaminationName", + "value": "ExaminationName", + "description": "Examination name" + }, + { + "name": "Date", + "value": "Date", + "description": "Date" + }, + { + "name": "Direction", + "value": "Direction", + "description": "Direction" + }, + { + "name": "Frequency", + "value": "Frequency", + "description": "Frequency" + }, + { + "name": "MeasurementValue", + "value": "MeasurementValue", + "description": "Measurement value" + }, + { + "name": "MeasurementUnit", + "value": "MeasurementUnit", + "description": "Measurement unit" + }, + { + "name": "RelationalOperator", + "value": "RelationalOperator", + "description": "Relational operator" + }, + { + "name": "Time", + "value": "Time", + "description": "Time" + }, + { + "name": "GeneOrProtein", + "value": "GeneOrProtein", + "description": "Gene or protein" + }, + { + "name": "Variant", + "value": "Variant", + "description": "Variant" + }, + { + "name": "AdministrativeEvent", + "value": "AdministrativeEvent", + "description": "Administrative event" + }, + { + "name": "CareEnvironment", + "value": "CareEnvironment", + "description": "Care environment" + }, + { + "name": "HealthcareProfession", + "value": "HealthcareProfession", + "description": "Healthcare profession" + }, + { + "name": "Diagnosis", + "value": "Diagnosis", + "description": "Diagnosis" + }, + { + "name": "SymptomOrSign", + "value": "SymptomOrSign", + "description": "Symptom or sign" + }, + { + "name": "ConditionQualifier", + "value": "ConditionQualifier", + "description": "Condition qualifier" + }, + { + "name": "MedicationClass", + "value": "MedicationClass", + "description": "Medication class" + }, + { + "name": "MedicationName", + "value": "MedicationName", + "description": "Medication name" + }, + { + "name": "Dosage", + "value": "Dosage", + "description": "Dosage" + }, + { + "name": "MedicationForm", + "value": "MedicationForm", + "description": "Medication form" + }, + { + "name": "MedicationRoute", + "value": "MedicationRoute", + "description": "Medication route" + }, + { + "name": "FamilyRelation", + "value": "FamilyRelation", + "description": "Family relation" + }, + { + "name": "TreatmentName", + "value": "TreatmentName", + "description": "Treatment name" + }, + { + "name": "Ethnicity", + "value": "Ethnicity", + "description": "Ethnicity" + }, + { + "name": "Course", + "value": "Course", + "description": "Course" + }, + { + "name": "Expression", + "value": "Expression", + "description": "Expression" + }, + { + "name": "MutationType", + "value": "MutationType", + "description": "Mutation type" + }, + { + "name": "ConditionScale", + "value": "ConditionScale", + "description": "Condition scale" + }, + { + "name": "Allergen", + "value": "Allergen", + "description": "Allergen" + }, + { + "name": "Employment", + "value": "Employment", + "description": "Employment" + }, + { + "name": "LivingStatus", + "value": "LivingStatus", + "description": "Living status" + }, + { + "name": "SubstanceUse", + "value": "SubstanceUse", + "description": "Substance use" + }, + { + "name": "SubstanceUseAmount", + "value": "SubstanceUseAmount", + "description": "Substance use amount" + } + ] + } + }, + "relationType": { + "type": "string", + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", + "enum": [ + "Abbreviation", + "DirectionOfBodyStructure", + "DirectionOfCondition", + "DirectionOfExamination", + "DirectionOfTreatment", + "DosageOfMedication", + "FormOfMedication", + "FrequencyOfMedication", + "FrequencyOfTreatment", + "QualifierOfCondition", + "RelationOfExamination", + "RouteOfMedication", + "TimeOfCondition", + "TimeOfEvent", + "TimeOfExamination", + "TimeOfMedication", + "TimeOfTreatment", + "UnitOfCondition", + "UnitOfExamination", + "ValueOfCondition", + "ValueOfExamination", + "BodySiteOfCondition", + "BodySiteOfTreatment", + "CourseOfCondition", + "CourseOfExamination", + "CourseOfMedication", + "CourseOfTreatment", + "ExaminationFindsCondition", + "ExpressionOfGene", + "ExpressionOfVariant", + "FrequencyOfCondition", + "MutationTypeOfGene", + "MutationTypeOfVariant", + "ScaleOfCondition", + "VariantOfGene" + ], + "x-ms-enum": { + "name": "relationType", + "modelAsString": true, + "values": [ + { + "name": "Abbreviation", + "value": "Abbreviation", + "description": "Abbreviation" + }, + { + "name": "DirectionOfBodyStructure", + "value": "DirectionOfBodyStructure", + "description": "Direction of body structure" + }, + { + "name": "DirectionOfCondition", + "value": "DirectionOfCondition", + "description": "Direction of condition" + }, + { + "name": "DirectionOfExamination", + "value": "DirectionOfExamination", + "description": "Direction of examination" + }, + { + "name": "DirectionOfTreatment", + "value": "DirectionOfTreatment", + "description": "Direction of treatment" + }, + { + "name": "DosageOfMedication", + "value": "DosageOfMedication", + "description": "Dosage of medication" + }, + { + "name": "FormOfMedication", + "value": "FormOfMedication", + "description": "Form of medication" + }, + { + "name": "FrequencyOfMedication", + "value": "FrequencyOfMedication", + "description": "Frequency of medication" + }, + { + "name": "FrequencyOfTreatment", + "value": "FrequencyOfTreatment", + "description": "Frequency of treatment" + }, + { + "name": "QualifierOfCondition", + "value": "QualifierOfCondition", + "description": "Qualifier of condition" + }, + { + "name": "RelationOfExamination", + "value": "RelationOfExamination", + "description": "Relation of examination" + }, + { + "name": "RouteOfMedication", + "value": "RouteOfMedication", + "description": "Route of medication" + }, + { + "name": "TimeOfCondition", + "value": "TimeOfCondition", + "description": "Time of condition" + }, + { + "name": "TimeOfEvent", + "value": "TimeOfEvent", + "description": "Time of event" + }, + { + "name": "TimeOfExamination", + "value": "TimeOfExamination", + "description": "Time of examination" + }, + { + "name": "TimeOfMedication", + "value": "TimeOfMedication", + "description": "Time of medication" + }, + { + "name": "TimeOfTreatment", + "value": "TimeOfTreatment", + "description": "Time of treatment" + }, + { + "name": "UnitOfCondition", + "value": "UnitOfCondition", + "description": "Unit of condition" + }, + { + "name": "UnitOfExamination", + "value": "UnitOfExamination", + "description": "Unit of examination" + }, + { + "name": "ValueOfCondition", + "value": "ValueOfCondition", + "description": "Value of condition" + }, + { + "name": "ValueOfExamination", + "value": "ValueOfExamination", + "description": "Value of examination" + }, + { + "name": "BodySiteOfCondition", + "value": "BodySiteOfCondition", + "description": "Body site of condition" + }, + { + "name": "BodySiteOfTreatment", + "value": "BodySiteOfTreatment", + "description": "Body site of treatment" + }, + { + "name": "CourseOfCondition", + "value": "CourseOfCondition", + "description": "Course of condition" + }, + { + "name": "CourseOfExamination", + "value": "CourseOfExamination", + "description": "Course of examination" + }, + { + "name": "CourseOfMedication", + "value": "CourseOfMedication", + "description": "Course of medication" + }, + { + "name": "CourseOfTreatment", + "value": "CourseOfTreatment", + "description": "Course of treatment" + }, + { + "name": "ExaminationFindsCondition", + "value": "ExaminationFindsCondition", + "description": "Examination finds condition" + }, + { + "name": "ExpressionOfGene", + "value": "ExpressionOfGene", + "description": "Expression of gene" + }, + { + "name": "ExpressionOfVariant", + "value": "ExpressionOfVariant", + "description": "Expression of variant" + }, + { + "name": "FrequencyOfCondition", + "value": "FrequencyOfCondition", + "description": "Frequency of condition" + }, + { + "name": "MutationTypeOfGene", + "value": "MutationTypeOfGene", + "description": "Mutation type of gene" + }, + { + "name": "MutationTypeOfVariant", + "value": "MutationTypeOfVariant", + "description": "Mutation type of variant" + }, + { + "name": "ScaleOfCondition", + "value": "ScaleOfCondition", + "description": "Scale of condition" + }, + { + "name": "VariantOfGene", + "value": "VariantOfGene", + "description": "Variant of gene" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json new file mode 100644 index 000000000000..0aa480cacbde --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "XYZ-code is a joint representation of human cognition and language, which Microsoft aims to develop for cross-domain transfer learning. Learn how XYz-code can help Microsoft achieve cross-sensory and multilingual learning with human-centric approach.", + "contexts": [ + { + "offset": 0, + "length": 1619 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json new file mode 100644 index 000000000000..754dee836340 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit.json @@ -0,0 +1,39 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationSummaryLengthPromptTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "summaryLength": "medium", + "instruction": "XYZ-code" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskResult.json new file mode 100644 index 000000000000..41581ae7d7d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskResult.json @@ -0,0 +1,58 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAbstractiveSummarizationTaskResult", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", + "contexts": [ + { + "offset": 0, + "length": 1629 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskSubmit.json new file mode 100644 index 000000000000..74cf057dcbc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAbstractiveSummarizationTaskSubmit.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAbstractiveSummarizationTaskSubmit", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "sentenceCount": 1 + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json new file mode 100644 index 000000000000..13ad6a087245 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsCancelRequest.json @@ -0,0 +1,17 @@ +{ + "operationId": "AnalyzeTextCancelJob", + "title": "SuccessfulAnalyzeTextJobsCancelRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json new file mode 100644 index 000000000000..eec46a940eaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json @@ -0,0 +1,180 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "EntityRecognitionLROResults", + "taskName": "Recognize Entities", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "type": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip", + "tags": [ + { + "name": "Event", + "confidenceScore": 0.61 + } + ] + }, + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ], + "text": "Seattle" + }, + { + "category": "Temporal", + "type": "DateRange", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "text": "last week", + "tags": [ + { + "name": "DateRange", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "text": "NYC", + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ] + }, + { + "category": "Temporal", + "type": "Date", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "text": "tomorrow", + "tags": [ + { + "name": "Date", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + }, + { + "kind": "CustomEntityRecognitionLROResults", + "taskName": "Recognize US Regions", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.85, + "length": 17, + "offset": 45, + "text": "Pacific Northwest" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.88, + "length": 10, + "offset": 63, + "text": "East Coast" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json new file mode 100644 index 000000000000..8da4921853e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json @@ -0,0 +1,51 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": [ + { + "kind": "EntityRecognition", + "taskName": "Recognize Entities", + "parameters": { + "modelVersion": "latest" + } + }, + { + "kind": "CustomEntityRecognition", + "taskName": "Recognize US Regions", + "parameters": { + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..12939588e3d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,130 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityLinkingRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityLinking", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityLinkingResults", + "results": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..a0a0464c9ad4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionExclusionRequest.json @@ -0,0 +1,136 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "exclusionList": [ + "Numeric" + ], + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Airport", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInclusionRequest.json new file mode 100644 index 000000000000..d9ac4bd22910 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInclusionRequest.json @@ -0,0 +1,133 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inclusionList": [ + "Location" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json new file mode 100644 index 000000000000..03f9e9c7d832 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionInferenceOptionsRequest.json @@ -0,0 +1,83 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionInferenceOptionsRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inferenceOptions": { + "excludeNormalizedValues": true + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ] + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-09-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionOverlapPolicy.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionOverlapPolicy.json new file mode 100644 index 000000000000..a266f02e7e6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionOverlapPolicy.json @@ -0,0 +1,79 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionOverlapPolicy", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "matchLongest" + } + }, + "analysisInput": { + "documents": [ + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.59, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.59 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json new file mode 100644 index 000000000000..6b8d169d0594 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulEntityRecognitionRequest.json @@ -0,0 +1,339 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + }, + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + }, + { + "id": "5", + "language": "en", + "text": "My IP is 127.12.1.1 and my phone number is 5555555555" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "AgeMetadata", + "unit": "Year", + "value": 5.0 + } + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "CurrencyMetadata", + "unit": "Dollar", + "iso4217": "USD", + "value": 90.0 + } + } + ], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "10 meters per second", + "category": "Numeric", + "type": "Speed", + "offset": 55, + "length": 20, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Dimension", + "confidenceScore": 0.84 + }, + { + "name": "Numeric", + "confidenceScore": 0.84 + }, + { + "name": "Speed", + "confidenceScore": 0.8 + } + ], + "metadata": { + "metadataKind": "SpeedMetadata", + "unit": "MetersPerSecond", + "value": 10.0 + } + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + }, + { + "entities": [ + { + "text": "25th April", + "category": "Temporal", + "type": "Date", + "offset": 0, + "length": 10, + "confidenceScore": 0.58, + "tags": [ + { + "name": "Temporal", + "confidenceScore": 0.9 + }, + { + "name": "Date", + "confidenceScore": 0.58 + } + ], + "metadata": { + "metadataKind": "DateMetadata", + "dateValues": [ + { + "timex": "XXXX-04-25", + "value": "2022-04-25" + }, + { + "timex": "XXXX-04-25", + "value": "2023-04-25" + } + ] + } + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "CulturalEvent", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "CulturalEvent", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + }, + { + "entities": [ + { + "text": "127.12.1.1", + "category": "IP", + "type": "IP", + "offset": 9, + "length": 10, + "confidenceScore": 0.8, + "tags": [ + { + "name": "IP", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "5555555555", + "category": "PhoneNumber", + "type": "PhoneNumber", + "offset": 45, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "5", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypePostRequest.json new file mode 100644 index 000000000000..3c7aff2de00f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypePostRequest.json @@ -0,0 +1,38 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcareDocumentTypePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest", + "fhirVersion": "4.0.1", + "documentType": "DischargeSummary" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json new file mode 100644 index 000000000000..5121c8443744 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json @@ -0,0 +1,554 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareDocumentTypeTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-09-06T23:47:43Z", + "displayName": "Providing Document Type", + "expirationDateTime": "2022-09-07T23:47:43Z", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", + "lastUpdatedDateTime": "2022-09-06T23:48:10Z", + "status": "succeeded", + "errors": [], + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "a", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1.0, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1.0 + } + ], + "relations": [ + { + "confidenceScore": 1.0, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1.0, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [], + "fhirBundle": { + "resourceType": "Bundle", + "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", + "meta": { + "profile": [ + "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" + ] + }, + "identifier": { + "system": "urn:ietf:rfc:3986", + "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" + }, + "type": "document", + "entry": [ + { + "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", + "resource": { + "resourceType": "Composition", + "id": "5bd33290-b92e-4aa5-becf-535578207946", + "status": "final", + "type": { + "coding": [ + { + "system": "http://loinc.org", + "code": "18842-5", + "display": "Discharge summary" + } + ], + "text": "Discharge summary" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "date": "2022-09-06", + "author": [ + { + "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "type": "Practitioner", + "display": "Unknown" + } + ], + "title": "Discharge summary", + "section": [ + { + "title": "General", + "code": { + "coding": [ + { + "system": "", + "display": "Unrecognized Section" + } + ], + "text": "General" + }, + "text": { + "status": "additional", + "div": "
      \r\n\t\t\t\t\t\t\t

      General

      \r\n\t\t\t\t\t\t\t

      Prescribed 100mg ibuprofen, taken twice daily.

      \r\n\t\t\t\t\t
      " + }, + "entry": [ + { + "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "type": "List", + "display": "General" + } + ] + } + ] + } + }, + { + "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "resource": { + "resourceType": "Practitioner", + "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", + "name": [ + { + "text": "Unknown", + "family": "Unknown" + } + ] + } + }, + { + "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "resource": { + "resourceType": "Patient", + "id": "efcccdf7-87f0-4061-b553-09fc11734594", + "gender": "unknown" + } + }, + { + "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "resource": { + "resourceType": "Encounter", + "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" + ] + }, + "status": "finished", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "display": "unknown" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "period": { + "start": "2022-09-06", + "end": "2022-09-06" + } + } + }, + { + "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "resource": { + "resourceType": "MedicationStatement", + "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "extension": [ + { + "extension": [ + { + "url": "offset", + "valueInteger": 17 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "status": "active", + "medicationCodeableConcept": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0020740", + "display": "ibuprofen" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000019879" + }, + { + "system": "http://www.whocc.no/atc", + "code": "M01AE01" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0046165" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006519" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2270-2077" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB01050" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "1611" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh97005926" + }, + { + "system": "http://loinc.org", + "code": "LP16165-0" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "40458" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00015" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007052" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "WK2XYI10QM" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", + "code": "00803" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0256857" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "WK2XYI10QM" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000613511" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "002377" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040475" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "x02MO" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "5640" + }, + { + "system": "http://snomed.info/sct", + "code": "E-7772" + }, + { + "system": "http://snomed.info/sct", + "code": "C-603C0" + }, + { + "system": "http://snomed.info/sct", + "code": "387207008" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m39860" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000060" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4017840" + } + ], + "text": "ibuprofen" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "context": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "dosage": [ + { + "text": "100mg", + "timing": { + "repeat": { + "frequency": 2, + "period": 1, + "periodUnit": "d" + }, + "code": { + "text": "twice daily" + } + }, + "doseAndRate": [ + { + "doseQuantity": { + "value": 100 + } + } + ] + } + ] + } + }, + { + "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "resource": { + "resourceType": "List", + "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "status": "current", + "mode": "snapshot", + "title": "General", + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "entry": [ + { + "item": { + "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "type": "MedicationStatement", + "display": "ibuprofen" + } + } + ] + } + } + ] + } + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcarePostRequest.json new file mode 100644 index 000000000000..30793bfedaf2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcarePostRequest.json @@ -0,0 +1,36 @@ +{ + "operationId": "AnalyzeTextSubmitJob", + "title": "SuccessfulHealthcarePostRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2025-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareTaskStatusRequest.json new file mode 100644 index 000000000000..c6c7999f9355 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulHealthcareTaskStatusRequest.json @@ -0,0 +1,222 @@ +{ + "operationId": "AnalyzeTextJobStatus", + "title": "SuccessfulHealthcareTaskStatusRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-07-20T18:43:35Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2022-07-21T18:43:35Z", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", + "lastUpdatedDateTime": "2022-07-20T18:43:36Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1 + } + ], + "relations": [ + { + "confidenceScore": 1, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json new file mode 100644 index 000000000000..1ce055cfabbf --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulKeyPhraseExtractionRequest.json @@ -0,0 +1,73 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulKeyPhraseExtractionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "KeyPhraseExtraction", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "KeyPhraseExtractionResults", + "results": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json new file mode 100644 index 000000000000..c1de4b0e4cec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulLanguageDetectionRequest.json @@ -0,0 +1,93 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulLanguageDetectionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "LanguageDetection", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + }, + { + "id": "4", + "text": "Tumhara naam kya hai?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "LanguageDetectionResults", + "results": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "3", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "hi", + "name": "Hindi", + "scriptName": "Latin", + "scriptIso15924Code": "Latn" + }, + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-12-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..0aee08e7cbe8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionExclusionRequest.json @@ -0,0 +1,101 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionExclusionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "USSocialSecurityNumber" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionMaskedEntities.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionMaskedEntities.json new file mode 100644 index 000000000000..e4ef9df573d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionMaskedEntities.json @@ -0,0 +1,82 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionMaskedEntitiesRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "entityMask" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My name is John Doe My phone number is 424 878 9192" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My name is [PERSON_1] My phone number is [PHONENUMBER_1]", + "entities": [ + { + "category": "Person", + "type": "Person", + "tags": [ + { + "name": "Person", + "confidenceScore": 0.65 + } + ], + "length": 8, + "offset": 11, + "mask": "[Person_1]", + "maskOffset": 11, + "maskLength": 9, + "text": "John Doe", + "confidenceScore": 0.65 + }, + { + "category": "PhoneNumber", + "type": "PhoneNumber", + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ], + "length": 12, + "offset": 36, + "mask": "[PHONENUMBER_1]", + "maskOffset": 41, + "maskLength": 13, + "text": "424 878 9192", + "confidenceScore": 0.8 + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json new file mode 100644 index 000000000000..a9e6150507c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRedactionPolicyRequest.json @@ -0,0 +1,127 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRedactionPolicyRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionPolicy": { + "policyKind": "characterMask", + "redactionCharacter": "-" + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is -----------", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is -------------- your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json new file mode 100644 index 000000000000..a293143bcfaa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulPiiEntityRecognitionRequest.json @@ -0,0 +1,123 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulPiiEntityRecognitionRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "USSocialSecurityNumber", + "type": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "type": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "type": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68", + "tags": [ + { + "name": "Number", + "confidenceScore": 0.8 + }, + { + "name": "Numeric", + "confidenceScore": 0.8 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json new file mode 100644 index 000000000000..e64a31f70ffd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/preview/2025-05-15-preview/examples/SuccessfulSentimentAnalysisRequest.json @@ -0,0 +1,150 @@ +{ + "operationId": "AnalyzeText", + "title": "SuccessfulSentimentAnalysisRequest", + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2025-05-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "SentimentAnalysis", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "SentimentAnalysisResults", + "results": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md index 6686bbb96412..c8bb4f1a12fd 100644 --- a/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md +++ b/specification/cognitiveservices/data-plane/LanguageAnalyzeText/readme.md @@ -49,6 +49,19 @@ modelerfour: lenient-model-deduplication: true ``` +### Release 2025-05-15-preview + +These settings apply only when `--tag=release_2025_05_15_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2025-05-15-preview' +input-file: + - preview/2025-05-15-preview/analyzetext.json +title: + Microsoft Cognitive Language Service - Text +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2024-11-01 These settings apply only when `--tag=release_2024-11-01` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/LanguageQuestionAnsweringAuthoring/client.tsp b/specification/cognitiveservices/data-plane/LanguageQuestionAnsweringAuthoring/client.tsp index 1f33d4cbc0d3..7ade1e33341f 100644 --- a/specification/cognitiveservices/data-plane/LanguageQuestionAnsweringAuthoring/client.tsp +++ b/specification/cognitiveservices/data-plane/LanguageQuestionAnsweringAuthoring/client.tsp @@ -21,10 +21,12 @@ interface QuestionAnsweringAuthoringClientOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" deleteProject is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.deleteProject; + @access(Access.internal, "python") getDeleteStatus is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.getDeleteStatus; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" export is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.export; + @access(Access.internal, "python") getExportStatus is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.getExportStatus; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" @@ -35,10 +37,12 @@ interface QuestionAnsweringAuthoringClientOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" #suppress "@azure-tools/typespec-azure-core/byos" "specified in routes.tsp" importFromFiles is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.importFromFiles; + @access(Access.internal, "python") getImportStatus is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.getImportStatus; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" deployProject is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.deployProject; + @access(Access.internal, "python") getDeployStatus is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.getDeployStatus; listDeployments is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.listDeployments; @@ -59,6 +63,7 @@ interface QuestionAnsweringAuthoringClientOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" #suppress "@azure-tools/typespec-azure-core/byos" "specified in routes.tsp" updateSourcesFromFiles is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.updateSourcesFromFiles; + @access(Access.internal, "python") getUpdateSourcesStatus is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.getUpdateSourcesStatus; #suppress "@azure-tools/typespec-azure-core/use-standard-names" "specified in routes.tsp" @@ -67,6 +72,7 @@ interface QuestionAnsweringAuthoringClientOperations { #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" updateQnas is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.updateQnas; + @access(Access.internal, "python") getUpdateQnasStatus is Language.QuestionAnswering.Authoring.QuestionAnsweringProjects.getUpdateQnasStatus; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "specified in routes.tsp" @@ -76,3 +82,4 @@ interface QuestionAnsweringAuthoringClientOperations { @@clientName(QuestionAnsweringProjectMetadata, "QuestionAnsweringProject"); @@clientName(ExportQueryParameters.format, "fileFormat", "python"); @@clientName(ImportQueryParameters.format, "fileFormat", "python"); +@@clientName(AssestKind, "AssetKind"); diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json index f4713aa953a8..578dbd282f95 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/cognitiveservices.json @@ -7080,7 +7080,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments": { "get": { "tags": [ "AgentDeployment" @@ -7171,7 +7171,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments/{deploymentName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}": { "delete": { "tags": [ "AgentDeployment" @@ -7374,7 +7374,7 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments/{deploymentName}/start": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}/start": { "post": { "tags": [ "AgentDeployment" @@ -7425,7 +7425,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments/{deploymentName}/stop": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}/stop": { "post": { "tags": [ "AgentDeployment" @@ -11906,6 +11906,10 @@ "type": "string" }, "x-nullable": true + }, + "enablePublicHostingEnvironment": { + "type": "boolean", + "description": "Whether public hosting environment is enabled for the capability host" } }, "x-ms-client-name": "CapabilityHostProperties", @@ -13090,7 +13094,7 @@ "enum": [ "Default", "OrganizationScope", - "Microsoft365", + "Channels", "Custom" ], "x-ms-enum": { @@ -13106,8 +13110,8 @@ "description": "Claim-based, requires membership in the tenant" }, { - "value": "Microsoft365", - "description": "Microsoft365-specific (AzureBotService) authorization" + "value": "Channels", + "description": "Channels-specific (AzureBotService) authorization" }, { "value": "Custom", @@ -13153,15 +13157,15 @@ "x-ms-discriminator-value": "OrganizationScope", "additionalProperties": false }, - "M365BuiltInAuthorizationPolicy": { - "description": "Represents a built-in authorization policy specific to Azure Bot Service/M365 authentication.", + "ChannelsBuiltInAuthorizationPolicy": { + "description": "Represents a built-in authorization policy specific to Azure Bot Service/Channels authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/ApplicationAuthorizationPolicy" } ], - "x-ms-discriminator-value": "Microsoft365", + "x-ms-discriminator-value": "Channels", "additionalProperties": false }, "ApplicationTrafficRoutingPolicy": { diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json index 5883862d3f50..7724b3476aff 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/createOrUpdate.json @@ -7,7 +7,8 @@ "api-version": "2025-10-01-preview", "capabilityHost": { "properties": { - "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet", + "enablePublicHostingEnvironment": true } } }, @@ -24,7 +25,8 @@ "string": "string" }, "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "enablePublicHostingEnvironment": true } } }, @@ -42,7 +44,8 @@ "string": "string" }, "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "enablePublicHostingEnvironment": true } } } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json index a367cd7eb277..b27cc4ac4bf3 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AccountCapabilityHost/get.json @@ -19,7 +19,8 @@ "string": "string" }, "customerSubnet": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroups/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubne", - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "enablePublicHostingEnvironment": true } } } diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json index 50d460b88f67..cf09af095a36 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentApplication/listDeployments.json @@ -13,9 +13,9 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deploy-001", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deploy-001", "name": "deploy-001", - "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", "properties": { "displayName": "Production deployment for customer support agents", "deploymentId": "550e8400-e29b-41d4-a716-446655440001", @@ -46,9 +46,9 @@ } }, { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deploy-002", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deploy-002", "name": "deploy-002", - "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", "properties": { "displayName": "Staging deployment for testing new features", "deploymentId": "550e8400-e29b-41d4-a716-446655440002", diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/createOrUpdate.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/createOrUpdate.json index 0b712cd8c5da..fffc1b49210c 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/createOrUpdate.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/createOrUpdate.json @@ -32,9 +32,9 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deployment-1", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", "name": "deployment-1", - "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", "properties": { "displayName": "Production Deployment", "deploymentId": "550e8400-e29b-41d4-a716-446655440001", @@ -70,9 +70,9 @@ "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.CognitiveServices/locations/westus/operationresults/00000000-1111-2222-3333-444444444444?api-version=2025-10-01-preview" }, "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deployment-1", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", "name": "deployment-1", - "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", "properties": { "displayName": "Production Deployment", "deploymentId": "550e8400-e29b-41d4-a716-446655440001", diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/get.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/get.json index f2dd0fa74fed..76f644dc1210 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/get.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/get.json @@ -12,9 +12,9 @@ "200": { "headers": {}, "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deployment-1", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", "name": "deployment-1", - "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", "properties": { "displayName": "Production Deployment", "deploymentId": "550e8400-e29b-41d4-a716-446655440001", diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/list.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/list.json index a408dfcd4360..01190968c067 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/list.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2025-10-01-preview/examples/AgentDeployment/list.json @@ -13,9 +13,9 @@ "body": { "value": [ { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/deployments/deployment-1", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/my-cognitive-services-account/projects/my-project/applications/agent-app-1/agentDeployments/deployment-1", "name": "deployment-1", - "type": "Microsoft.CognitiveServices/accounts/projects/applications/deployments", + "type": "Microsoft.CognitiveServices/accounts/projects/applications/agentDeployments", "properties": { "displayName": "Production Deployment", "deploymentId": "550e8400-e29b-41d4-a716-446655440001", diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index d33d74abf222..99fc7de332d7 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -50,9 +50,9 @@ suppressions: - code: ProvisioningStateMustBeReadOnly reason: Schema ref is AgentDeploymentResource -> AgentDeployment. AgentDeployment has a readonly provisioning state. where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments/{deploymentName}"].get.responses.200.schema - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments/{deploymentName}"].put.responses.200.schema - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/deployments/{deploymentName}"].put.responses.201.schema + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}"].get.responses.200.schema + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}"].put.responses.200.schema + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{appName}/agentDeployments/{deploymentName}"].put.responses.201.schema - code: ArmResourcePropertiesBag reason: This API is copied from Machine Learning Services RP where this behavior is already established. where: diff --git a/specification/communitytraining/Community.Management/back-compatible.tsp b/specification/communitytraining/Community.Management/back-compatible.tsp new file mode 100644 index 000000000000..cd6079a788c6 --- /dev/null +++ b/specification/communitytraining/Community.Management/back-compatible.tsp @@ -0,0 +1,10 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using Microsoft.Community; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CommunityTraining.properties, + "autorest" +); +// For CommunityTrainingUpdate +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/communitytraining/Community.Management/main.tsp b/specification/communitytraining/Community.Management/main.tsp index 604d8d2593de..796b77a262a1 100644 --- a/specification/communitytraining/Community.Management/main.tsp +++ b/specification/communitytraining/Community.Management/main.tsp @@ -3,6 +3,9 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/communitytraining/Community.Management/tspconfig.yaml b/specification/communitytraining/Community.Management/tspconfig.yaml index c40e38aca037..f287fca1a0a7 100644 --- a/specification/communitytraining/Community.Management/tspconfig.yaml +++ b/specification/communitytraining/Community.Management/tspconfig.yaml @@ -5,8 +5,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/CommunityTrainings.json" linter: extends: diff --git a/specification/compute/Compute.Management/VirtualMachineScaleSet.tsp b/specification/compute/Compute.Management/VirtualMachineScaleSet.tsp index ac3fec265a19..ce6a119c9586 100644 --- a/specification/compute/Compute.Management/VirtualMachineScaleSet.tsp +++ b/specification/compute/Compute.Management/VirtualMachineScaleSet.tsp @@ -42,9 +42,9 @@ model VirtualMachineScaleSet extends Foundations.TrackedResource { plan?: Plan; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" - #suppress "@azure-tools/typespec-azure-core/no-private-usage" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" @doc("The resource-specific properties for this resource.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetProperties; /** diff --git a/specification/compute/Compute.Management/models.tsp b/specification/compute/Compute.Management/models.tsp index edeafb253dbd..23ed5a4db99e 100644 --- a/specification/compute/Compute.Management/models.tsp +++ b/specification/compute/Compute.Management/models.tsp @@ -2691,8 +2691,8 @@ model VirtualMachineScaleSetNetworkConfiguration { /** * Describes a virtual machine scale set network profile's IP configuration. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetNetworkConfigurationProperties; /** @@ -2786,8 +2786,8 @@ model VirtualMachineScaleSetIPConfiguration { /** * Describes a virtual machine scale set network profile's IP configuration properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetIPConfigurationProperties; } @@ -2848,8 +2848,8 @@ model VirtualMachineScaleSetPublicIPAddressConfiguration { /** * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetPublicIPAddressConfigurationProperties; /** @@ -3613,8 +3613,8 @@ model VirtualMachineScaleSetUpdate extends UpdateResource { /** * Describes the properties of a Virtual Machine Scale Set. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetUpdateProperties; /** @@ -3899,8 +3899,8 @@ model VirtualMachineScaleSetUpdateNetworkConfiguration { /** * Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetUpdateNetworkConfigurationProperties; /** @@ -3984,8 +3984,8 @@ model VirtualMachineScaleSetUpdateIPConfiguration { /** * Describes a virtual machine scale set network profile's IP configuration properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetUpdateIPConfigurationProperties; } @@ -4046,8 +4046,8 @@ model VirtualMachineScaleSetUpdatePublicIPAddressConfiguration { /** * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties; /** @@ -4177,8 +4177,8 @@ model VirtualMachineScaleSetExtensionUpdate extends SubResourceReadOnly { /** * Describes the properties of a Virtual Machine Scale Set Extension. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineScaleSetExtensionProperties; } @@ -5418,8 +5418,8 @@ model NetworkInterfaceReference extends SubResource { /** * Describes a network interface reference properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: NetworkInterfaceReferenceProperties; } @@ -5450,8 +5450,8 @@ model VirtualMachineNetworkInterfaceConfiguration { /** * Describes a virtual machine network profile's IP configuration. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineNetworkInterfaceConfigurationProperties; /** @@ -5548,8 +5548,8 @@ model VirtualMachineNetworkInterfaceIPConfiguration { /** * Describes a virtual machine network interface IP configuration properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineNetworkInterfaceIPConfigurationProperties; } @@ -5605,8 +5605,8 @@ model VirtualMachinePublicIPAddressConfiguration { /** * Describes a virtual machines IP Configuration's PublicIPAddress configuration */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachinePublicIPAddressConfigurationProperties; /** @@ -5854,8 +5854,8 @@ model VirtualMachineScaleSetVMExtensionUpdate extends SubResourceReadOnly { /** * Describes the properties of a Virtual Machine Extension. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineExtensionUpdateProperties; } @@ -6432,8 +6432,8 @@ model VirtualMachineUpdate extends UpdateResource { /** * Describes the properties of a Virtual Machine. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineProperties; /** @@ -6637,8 +6637,8 @@ model VirtualMachineExtensionUpdate extends UpdateResource { /** * Describes the properties of a Virtual Machine Extension. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineExtensionUpdateProperties; } @@ -6908,8 +6908,8 @@ model VirtualMachineImage extends VirtualMachineImageResource { /** * Describes the properties of a Virtual Machine Image. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineImageProperties; } @@ -7235,8 +7235,8 @@ model AvailabilitySetUpdate extends UpdateResource { /** * The instance view of a resource. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AvailabilitySetProperties; /** @@ -7455,8 +7455,8 @@ model DedicatedHostGroupUpdate extends UpdateResource { /** * Dedicated Host Group Properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DedicatedHostGroupProperties; /** @@ -7540,8 +7540,8 @@ model DedicatedHostUpdate extends UpdateResource { /** * Properties of the dedicated host. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DedicatedHostProperties; /** @@ -7596,8 +7596,8 @@ model SshPublicKeyUpdateResource extends UpdateResource { /** * Properties of the SSH public key. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: SshPublicKeyResourceProperties; } @@ -7764,8 +7764,8 @@ model ImageUpdate extends UpdateResource { /** * Describes the properties of an Image. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ImageProperties; } @@ -8155,8 +8155,8 @@ model RestorePointCollectionUpdate extends UpdateResource { /** * The restore point collection properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: RestorePointCollectionProperties; } @@ -8323,8 +8323,8 @@ model CapacityReservationGroupUpdate extends UpdateResource { /** * capacity reservation group Properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: CapacityReservationGroupProperties; } @@ -8402,8 +8402,8 @@ model CapacityReservationUpdate extends UpdateResource { /** * Properties of the Capacity reservation. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: CapacityReservationProperties; /** @@ -8792,8 +8792,8 @@ model VirtualMachineRunCommandUpdate extends UpdateResource { /** * Describes the properties of a Virtual Machine run command. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualMachineRunCommandProperties; } diff --git a/specification/compute/Compute.Management/tspconfig.yaml b/specification/compute/Compute.Management/tspconfig.yaml index 29132d66a0f1..5f3f461430ac 100644 --- a/specification/compute/Compute.Management/tspconfig.yaml +++ b/specification/compute/Compute.Management/tspconfig.yaml @@ -6,7 +6,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/ComputeRP/{version-status}/{version}/ComputeRP.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/compute/Disk.Management/models.tsp b/specification/compute/Disk.Management/models.tsp index 776ef1a1f4a8..417fc987ffaa 100644 --- a/specification/compute/Disk.Management/models.tsp +++ b/specification/compute/Disk.Management/models.tsp @@ -1025,8 +1025,8 @@ model DiskUpdate { /** * Disk resource update properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DiskUpdateProperties; /** @@ -1321,8 +1321,8 @@ model PrivateLinkResource { /** * Resource properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: PrivateLinkResourceProperties; /** @@ -1485,8 +1485,8 @@ model DiskEncryptionSetUpdate { /** * disk encryption set resource update properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DiskEncryptionSetUpdateProperties; /** @@ -1860,8 +1860,8 @@ model SnapshotUpdate { /** * Snapshot resource update properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: SnapshotUpdateProperties; /** diff --git a/specification/compute/Disk.Management/tspconfig.yaml b/specification/compute/Disk.Management/tspconfig.yaml index 989ecae23d56..3cc36470ac7b 100644 --- a/specification/compute/Disk.Management/tspconfig.yaml +++ b/specification/compute/Disk.Management/tspconfig.yaml @@ -7,7 +7,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/DiskRP/{version-status}/{version}/DiskRP.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/compute/Gallery.Management/models.tsp b/specification/compute/Gallery.Management/models.tsp index 4572b0985c7f..f5c90d3d5873 100644 --- a/specification/compute/Gallery.Management/models.tsp +++ b/specification/compute/Gallery.Management/models.tsp @@ -621,8 +621,8 @@ model GalleryUpdate extends UpdateResourceDefinition { /** * Describes the properties of a Shared Image Gallery. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GalleryProperties; /** @@ -856,8 +856,8 @@ model GalleryImageUpdate extends UpdateResourceDefinition { /** * Describes the properties of a gallery image definition. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GalleryImageProperties; } @@ -1460,8 +1460,8 @@ model GalleryImageVersionUpdate extends UpdateResourceDefinition { /** * Describes the properties of a gallery image version. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GalleryImageVersionProperties; } @@ -1572,8 +1572,8 @@ model GalleryApplicationUpdate extends UpdateResourceDefinition { /** * Describes the properties of a gallery Application Definition. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GalleryApplicationProperties; } @@ -1710,8 +1710,8 @@ model GalleryApplicationVersionUpdate extends UpdateResourceDefinition { /** * Describes the properties of a gallery image version. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GalleryApplicationVersionProperties; } @@ -1761,8 +1761,8 @@ model GallerySoftDeletedResource /** * Describes the properties of a soft-deleted resource. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GallerySoftDeletedResourceProperties; } @@ -2024,8 +2024,8 @@ model GalleryInVMAccessControlProfileVersionUpdate /** * Describes the properties of an inVMAccessControlProfile version. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: GalleryInVMAccessControlProfileVersionProperties; } @@ -2067,8 +2067,8 @@ model PirSharedGalleryResource extends PirResource { /** * The identifier information of shared gallery. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty identifier?: SharedGalleryIdentifier; } @@ -2347,8 +2347,8 @@ model PirCommunityGalleryResource { /** * The identifier information of community gallery. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty identifier?: CommunityGalleryIdentifier; } diff --git a/specification/compute/Sku.Management/tspconfig.yaml b/specification/compute/Sku.Management/tspconfig.yaml index 1fc89e7eb1c9..fd90aa8138b7 100644 --- a/specification/compute/Sku.Management/tspconfig.yaml +++ b/specification/compute/Sku.Management/tspconfig.yaml @@ -8,7 +8,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/Skus/{version-status}/{version}/skus.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/Consumption/tspconfig.yaml b/specification/consumption/resource-manager/Microsoft.Consumption/Consumption/tspconfig.yaml index 4160218e5e53..c6b31695af39 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/Consumption/tspconfig.yaml +++ b/specification/consumption/resource-manager/Microsoft.Consumption/Consumption/tspconfig.yaml @@ -10,7 +10,7 @@ options: output-file: "{version-status}/{version}/openapi.json" emit-lro-options: "all" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-consumption" diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Archive.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Archive.models.tsp index 183f9a7fa8c8..898da645d2e5 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Archive.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Archive.models.tsp @@ -87,8 +87,8 @@ model ArchiveUpdateParameters { /** * The properties of the connected registry update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ArchiveUpdateProperties; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CacheRule.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CacheRule.models.tsp index c626b99d6c7d..eb3aa2deb803 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CacheRule.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CacheRule.models.tsp @@ -41,8 +41,8 @@ model CacheRuleUpdateParameters { /** * The properties of the cache rule update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: CacheRuleUpdateProperties; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ConnectedRegistry.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ConnectedRegistry.models.tsp index abb525e2e6fa..ae892d7a35ab 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ConnectedRegistry.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ConnectedRegistry.models.tsp @@ -355,8 +355,8 @@ model ConnectedRegistryUpdateParameters { /** * The properties of the connected registry update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ConnectedRegistryUpdateProperties; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CredentialSet.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CredentialSet.models.tsp index a72c0d275e63..424fd6223681 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CredentialSet.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/CredentialSet.models.tsp @@ -103,8 +103,8 @@ model CredentialSetUpdateParameters { /** * The properties of the credential set update parameters */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: CredentialSetUpdateProperties; /** diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Registry.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Registry.models.tsp index 9a0b53ef7472..fd5a95c1a576 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Registry.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Registry.models.tsp @@ -619,8 +619,8 @@ model RegistryUpdateParameters { /** * The properties that the container registry will be updated with. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: RegistryPropertiesUpdateParameters; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Replication.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Replication.models.tsp index 90a9ae153beb..3a040c745bc4 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Replication.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Replication.models.tsp @@ -40,8 +40,8 @@ model ReplicationUpdateParameters { /** * The parameters for updating a replication's properties */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ReplicationUpdateParametersProperties; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ScopeMap.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ScopeMap.models.tsp index 0af23feea838..1208b899ac35 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ScopeMap.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/ScopeMap.models.tsp @@ -44,8 +44,8 @@ model ScopeMapUpdateParameters { /** * The update parameters for scope map properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ScopeMapPropertiesUpdateParameters; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Token.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Token.models.tsp index 2beca3836e2a..9951c6f4985c 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Token.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Token.models.tsp @@ -136,8 +136,8 @@ model TokenUpdateParameters { /** * The properties of the token update parameters. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: TokenUpdateProperties; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Webhook.models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Webhook.models.tsp index e65e7067f486..dba1beb8428b 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Webhook.models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/Webhook.models.tsp @@ -70,8 +70,8 @@ model WebhookCreateParameters { /** * The properties that the webhook will be created with. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: WebhookPropertiesCreateParameters; } @@ -121,8 +121,8 @@ model WebhookUpdateParameters { /** * The properties that the webhook will be updated with. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: WebhookPropertiesUpdateParameters; } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/back-compatible.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/back-compatible.tsp index 198c68b0cdeb..e3b45719d262 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/back-compatible.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/back-compatible.tsp @@ -3,7 +3,49 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; using Microsoft.ContainerRegistry; -// Remove deprecated @flattenProperty decorators since they're handled by @Azure.ResourceManager.Private.conditionalClientFlatten in models.tsp +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Archive.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ArchiveVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CacheRule.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ConnectedRegistry.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CredentialSet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExportPipeline.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ImportPipeline.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PipelineRun.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateEndpointConnection.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Registry.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Replication.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScopeMap.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Token.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Webhook.properties, + "autorest" +); @@clientName(IPRule.value, "IPAddressOrRange"); diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/models.tsp index 09053436e066..1e09d442e2a8 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/models.tsp @@ -217,8 +217,8 @@ model OperationDefinition { /** * The properties information for the container registry operation. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: OperationPropertiesDefinition; /** diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.go.md b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.go.md index 93ec8e00d94d..2da1c2991897 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.go.md +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.go.md @@ -23,4 +23,44 @@ directive: where: $.definitions.ErrorResponse transform: > $['x-ms-client-name'] = 'ErrorResponseForContainerRegistry'; -``` \ No newline at end of file + - from: containerregistry_build.json + where: $.definitions.Task.properties + transform: > + $.identity['$ref'] = '../../../Registry/stable/2025-11-01/containerregistry.json#/definitions/IdentityProperties'; + - from: containerregistry_build.json + where: $.definitions.TaskRun.properties + transform: > + $.identity['$ref'] = '../../../Registry/stable/2025-11-01/containerregistry.json#/definitions/IdentityProperties'; + - from: containerregistry_build.json + where: $.definitions.TaskRunUpdateParameters.properties + transform: > + $.identity['$ref'] = '../../../Registry/stable/2025-11-01/containerregistry.json#/definitions/IdentityProperties'; + - from: containerregistry_build.json + where: $.definitions.TaskUpdateParameters.properties + transform: > + $.identity['$ref'] = '../../../Registry/stable/2025-11-01/containerregistry.json#/definitions/IdentityProperties'; + - from: containerregistry_build.json + where: $.definitions.Run.allOf + transform: > + $['$ref'] = '../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource'; + - from: containerregistry_build.json + where: $.definitions.TaskRun.allOf + transform: > + $['$ref'] = '../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource'; + - from: containerregistry_build.json + where: $.definitions.Resource.properties + transform: > + $.systemData['$ref'] = '../../../../../../common-types/resource-management/v6/types.json#/definitions/systemData'; + - from: containerregistry_build.json + where: $.definitions.ProxyResource.properties + transform: > + $.systemData['$ref'] = '../../../../../../common-types/resource-management/v6/types.json#/definitions/systemData'; +``` + +### Tag: package-2025-11 + +``` yaml $(go) && $(tag) == 'package-2025-11' +input-file: + - stable/2025-11-01/containerregistry.json + - ../RegistryTasks/preview/2019-06-01-preview/containerregistry_build.json +``` diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.java.md b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.java.md index ae13cff88ab0..237d93815605 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.java.md +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/readme.java.md @@ -7,4 +7,14 @@ Please also specify `--azure-libraries-for-java-folder=`. +### Tag: package-2025-11-python + +``` yaml $(tag) == 'package-2025-11-python' +input-file: + - stable/2025-11-01/containerregistry.json + - ../RegistryTasks/preview/2025-03-01-preview/containerregistry_build.json +``` + + ``` yaml $(python) title: ContainerRegistryManagementClient azure-arm: true diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/tspconfig.yaml b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/tspconfig.yaml index 8a6b2c53d252..d3b0e9a211de 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/tspconfig.yaml +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/Registry/tspconfig.yaml @@ -10,7 +10,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{version-status}/{version}/containerregistry.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" emit-lro-options: "all" "@azure-tools/typespec-csharp": diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/back-compatible.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/back-compatible.tsp index 2bab9394d8a0..d4aa79867d5d 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/back-compatible.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/back-compatible.tsp @@ -3,6 +3,18 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; using Microsoft.ContainerRegistry; +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AgentPool.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Run.properties, "autorest"); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Task.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TaskRun.properties, + "autorest" +); + @@clientName(AgentPools.create::parameters.resource, "agentPool"); @@clientName(AgentPools.update::parameters.properties, "updateParameters"); diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/models.tsp b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/models.tsp index b946783a6891..cd5c0997b127 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/models.tsp +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/models.tsp @@ -388,8 +388,8 @@ model AgentPoolUpdateParameters { /** * The properties associated with the agent pool */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AgentPoolPropertiesUpdateParameters; /** @@ -919,8 +919,8 @@ model TaskRunUpdateParameters { /** * The properties for updating a task run. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: TaskRunPropertiesUpdateParameters; /** @@ -1326,8 +1326,8 @@ model TaskUpdateParameters { /** * The properties for updating a task. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: TaskPropertiesUpdateParameters; /** diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/tspconfig.yaml b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/tspconfig.yaml index 96d8eca5f811..180ff2f54cb8 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/tspconfig.yaml +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/RegistryTasks/tspconfig.yaml @@ -10,7 +10,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{version-status}/{version}/containerregistry_build.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" emit-lro-options: "all" "@azure-tools/typespec-csharp": diff --git a/specification/containerservice/DeploymentSafeguards.Management/back-compatible.tsp b/specification/containerservice/DeploymentSafeguards.Management/back-compatible.tsp new file mode 100644 index 000000000000..b125568288a3 --- /dev/null +++ b/specification/containerservice/DeploymentSafeguards.Management/back-compatible.tsp @@ -0,0 +1,11 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Microsoft.ContainerService; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DeploymentSafeguard.properties, + "autorest" +); diff --git a/specification/containerservice/DeploymentSafeguards.Management/main.tsp b/specification/containerservice/DeploymentSafeguards.Management/main.tsp index e85e4b4dce81..a71716112f2c 100644 --- a/specification/containerservice/DeploymentSafeguards.Management/main.tsp +++ b/specification/containerservice/DeploymentSafeguards.Management/main.tsp @@ -1,6 +1,7 @@ import "@typespec/versioning"; import "@azure-tools/typespec-azure-resource-manager"; import "./deploymentsafeguards.tsp"; +import "./back-compatible.tsp"; using Azure.ResourceManager; using TypeSpec.Http; diff --git a/specification/containerservice/DeploymentSafeguards.Management/tspconfig.yaml b/specification/containerservice/DeploymentSafeguards.Management/tspconfig.yaml index 553e8f1f6337..5d13c6edeac3 100644 --- a/specification/containerservice/DeploymentSafeguards.Management/tspconfig.yaml +++ b/specification/containerservice/DeploymentSafeguards.Management/tspconfig.yaml @@ -12,8 +12,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." arm-types-dir: "{project-root}/../../common-types/resource-management" output-file: "{azure-resource-provider-folder}/{service-name}/deploymentsafeguards/{version-status}/{version}/deploymentsafeguards.json" diff --git a/specification/containerservice/Fleet.Management/back-compatible.tsp b/specification/containerservice/Fleet.Management/back-compatible.tsp new file mode 100644 index 000000000000..4c4398c6b9b8 --- /dev/null +++ b/specification/containerservice/Fleet.Management/back-compatible.tsp @@ -0,0 +1,29 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Microsoft.ContainerService; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Fleet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(FleetMember.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Gate.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(UpdateRun.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(FleetUpdateStrategy.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AutoUpgradeProfile.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/containerservice/Fleet.Management/main.tsp b/specification/containerservice/Fleet.Management/main.tsp index cfa045fe32c2..9137d48b84a3 100644 --- a/specification/containerservice/Fleet.Management/main.tsp +++ b/specification/containerservice/Fleet.Management/main.tsp @@ -7,6 +7,7 @@ import "./update/common.tsp"; import "./update/run.tsp"; import "./update/strategy.tsp"; import "./update/autoupgradeprofile.tsp"; +import "./back-compatible.tsp"; using Azure.ResourceManager; using TypeSpec.Http; diff --git a/specification/containerservice/Fleet.Management/tspconfig.yaml b/specification/containerservice/Fleet.Management/tspconfig.yaml index 32bb0c8745f0..4e3aa5645578 100644 --- a/specification/containerservice/Fleet.Management/tspconfig.yaml +++ b/specification/containerservice/Fleet.Management/tspconfig.yaml @@ -12,8 +12,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." arm-types-dir: "{project-root}/../../common-types/resource-management" output-file: "{azure-resource-provider-folder}/{service-name}/fleet/{version-status}/{version}/fleets.json" diff --git a/specification/containerservice/cspell.yaml b/specification/containerservice/cspell.yaml index 563da5110003..a44576e10d32 100644 --- a/specification/containerservice/cspell.yaml +++ b/specification/containerservice/cspell.yaml @@ -13,6 +13,7 @@ words: - cncf - dcos - ebpf + - nftables - gmsa - iloveyou - imds diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AdvancedNetworkingTransitEncryption.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AdvancedNetworkingTransitEncryption.json new file mode 100644 index 000000000000..be1fa9ee31c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AdvancedNetworkingTransitEncryption.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "advancedNetworking": { + "enabled": true, + "observability": { + "enabled": false + }, + "security": { + "enabled": true, + "advancedNetworkPolicies": "FQDN", + "transitEncryption": { + "type": "WireGuard" + } + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "advancedNetworking": { + "enabled": true, + "observability": { + "enabled": false + }, + "security": { + "enabled": true, + "advancedNetworkPolicies": "FQDN", + "transitEncryption": { + "type": "WireGuard" + } + } + }, + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "advancedNetworking": { + "enabled": true, + "observability": { + "enabled": false + }, + "security": { + "enabled": true, + "advancedNetworkPolicies": "FQDN", + "transitEncryption": { + "type": "WireGuard" + } + } + }, + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsAbortOperation.json new file mode 100644 index 000000000000..3be61c32b3d9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsAbortOperation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsAssociate_CRG.json new file mode 100644 index 000000000000..d4aa1c1274d7 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsAssociate_CRG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/CapacityReservationGroups/crg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCompleteUpgrade.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCompleteUpgrade.json new file mode 100644 index 000000000000..086ffd6fa531 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCompleteUpgrade.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json new file mode 100644 index 000000000000..7c8758720190 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_CustomNodeConfig.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "seccompDefault": "Unconfined" + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..ef7d49908fba --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_DedicatedHostGroup.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..96eb3136b23d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableEncryptionAtHost.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableEncryptionAtHost": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableFIPS.json new file mode 100644 index 000000000000..05c2f8d5b25d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableFIPS.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..83e3d3774e31 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_EnableUltraSSD.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.13", + "currentOrchestratorVersion": "1.17.13", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableUltraSSD": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Ephemeral.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Ephemeral.json new file mode 100644 index 000000000000..0db92f435c68 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Ephemeral.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "osDiskSizeGB": 64 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskType": "Ephemeral", + "kubeletDiskType": "OS", + "osDiskSizeGB": 64 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_GPUMIG.json new file mode 100644 index 000000000000..3131d807de27 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_GPUMIG.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG2g", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json new file mode 100644 index 000000000000..f3c133cee424 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_MessageOfTheDay.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "messageOfTheDay": "Zm9vCg==" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_NodeCustomization.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_NodeCustomization.json new file mode 100644 index 000000000000..296efc0adfa9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_NodeCustomization.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "nodeCustomizationProfile": { + "nodeCustomizationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/nodeCustomizations/nodecustomization1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "nodeCustomizationProfile": { + "nodeCustomizationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/nodeCustomizations/nodecustomization1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "nodeCustomizationProfile": { + "nodeCustomizationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/nodeCustomizations/nodecustomization1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_OSSKU.json new file mode 100644 index 000000000000..b9a94f2ff9b0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_OSSKU.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 12345, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "kubeletConfig": { + "cpuManagerPolicy": "static", + "cpuCfsQuota": true, + "cpuCfsQuotaPeriod": "200ms", + "imageGcHighThreshold": 90, + "imageGcLowThreshold": 70, + "topologyManagerPolicy": "best-effort", + "allowedUnsafeSysctls": [ + "kernel.msg*", + "net.core.somaxconn" + ], + "failSwapOn": false, + "podMaxPids": 100 + }, + "linuxOSConfig": { + "sysctls": { + "netCoreWmemDefault": 65536, + "netIpv4TcpTwReuse": true, + "netIpv4IpLocalPortRange": "20000 60000", + "kernelThreadsMax": 99999 + }, + "transparentHugePageEnabled": "always", + "transparentHugePageDefrag": "madvise", + "swapFileSizeMB": 1500 + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..40b3e61b8d40 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Snapshot.json new file mode 100644 index 000000000000..c3242d1b3208 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Snapshot.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.19.6", + "currentOrchestratorVersion": "1.19.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..d0beb5eebc4c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json new file mode 100644 index 000000000000..7dc7e8fddb86 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.9.6", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "manual": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ] + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 3 + }, + { + "size": "Standard_D2_v3", + "count": 2 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json new file mode 100644 index 000000000000..bce4c8b34539 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "1.29.0", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": { + "size": "Standard_D2_v2", + "minCount": 1, + "maxCount": 5 + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.29.0", + "currentOrchestratorVersion": "1.29.0", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": { + "size": "Standard_D2_v2", + "minCount": 1, + "maxCount": 5 + } + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 1 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.29.0", + "currentOrchestratorVersion": "1.29.0", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "type": "VirtualMachines", + "virtualMachinesProfile": { + "scale": { + "autoscale": { + "size": "Standard_D2_v2", + "minCount": 1, + "maxCount": 5 + } + } + }, + "virtualMachineNodesStatus": [ + { + "size": "Standard_D2_v2", + "count": 1 + } + ], + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..211e3ce21db2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WasmWasi.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WasmWasi.json new file mode 100644 index 000000000000..8037d2ecd07a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WasmWasi.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.17.8", + "currentOrchestratorVersion": "1.17.8", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osDiskSizeGB": 64, + "mode": "User", + "workloadRuntime": "WasmWasi" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json new file mode 100644 index 000000000000..00bbbe375cfb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.8", + "currentOrchestratorVersion": "1.23.8", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022", + "windowsProfile": { + "disableOutboundNat": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json new file mode 100644 index 000000000000..3a80ca5f9b92 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsCreate_WindowsOSSKU.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "wnp2", + "parameters": { + "properties": { + "orchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/wnp2", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "wnp2", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.23.3", + "currentOrchestratorVersion": "1.23.3", + "count": 3, + "vmSize": "Standard_D4s_v3", + "maxPods": 110, + "osType": "Windows", + "osSKU": "Windows2022" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..dbce009a7504 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDeleteMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDeleteMachines.json new file mode 100644 index 000000000000..972792ae7f06 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDeleteMachines.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machines": { + "machineNames": [ + "aks-nodepool1-42263519-vmss00000a", + "aks-nodepool1-42263519-vmss00000b" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid1/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json new file mode 100644 index 000000000000..1dde7d580a20 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "ignorePodDisruptionBudget": true + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..0223cf2acde2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "ebwiyfneowv", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..250aaff68af3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..feceacd0e7e0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsList.json new file mode 100644 index 000000000000..fbb67ac26a4b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "eTag": "ewnfuib" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json new file mode 100644 index 000000000000..f87890fbb57f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPoolsUpgradeNodeImageVersion.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.ContainerService/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2018-07-31" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "UpgradingNodeImageVersion", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu-1604-2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Start.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Start.json new file mode 100644 index 000000000000..9c2ae9099b6a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Start.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Running" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Starting", + "count": 50, + "enableAutoScaling": true, + "minCount": 3, + "maxCount": 55, + "powerState": { + "code": "Running" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Stop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Stop.json new file mode 100644 index 000000000000..80913fba47ab --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Stop.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "powerState": { + "code": "Stopped" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Stopping", + "count": 0, + "enableAutoScaling": false, + "minCount": null, + "maxCount": null, + "powerState": { + "code": "Stopped" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Update.json new file mode 100644 index 000000000000..d24c87ca2a0a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/AgentPools_Update.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/GetGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/GetGuardrailsVersions.json new file mode 100644 index 000000000000..0a6ce2d813c2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/GetGuardrailsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/GetSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/GetSafeguardsVersions.json new file mode 100644 index 000000000000..c6b7be0e3099 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/GetSafeguardsVersions.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "version": "v1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Create_Or_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Create_Or_Update.json new file mode 100644 index 000000000000..51e4c3e62e06 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Create_Or_Update.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "identityBindingName": "identitybinding1", + "parameters": { + "properties": { + "managedIdentity": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/identityBindings/identitybinding1", + "type": "Microsoft.ContainerService/managedClusters/identityBindings", + "name": "identitybinding1", + "properties": { + "managedIdentity": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "objectId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "oidcIssuer": { + "oidcIssuerUrl": "https://oidc-endpoint" + }, + "provisioningState": "Succeeded" + }, + "eTag": "string" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/identityBindings/identitybinding1", + "type": "Microsoft.ContainerService/managedClusters/identityBindings", + "name": "identitybinding1", + "properties": { + "managedIdentity": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "objectId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "oidcIssuer": { + "oidcIssuerUrl": "https://oidc-endpoint" + }, + "provisioningState": "Succeeded" + }, + "eTag": "string" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Delete.json new file mode 100644 index 000000000000..6cd9b58bcc08 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "identityBindingName": "identitybinding1" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-09-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Get.json new file mode 100644 index 000000000000..5cd4384b75d6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "identityBindingName": "identitybinding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/identityBindings/identitybinding1", + "type": "Microsoft.ContainerService/managedClusters/identityBindings", + "name": "identitybinding1", + "properties": { + "managedIdentity": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "objectId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "oidcIssuer": { + "oidcIssuerUrl": "https://oidc-endpoint" + }, + "provisioningState": "Succeeded" + }, + "eTag": "string" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_List.json new file mode 100644 index 000000000000..ca44760c0d1d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/IdentityBindings_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/identityBindings/identitybinding1", + "type": "Microsoft.ContainerService/managedClusters/identityBindings", + "name": "identitybinding1", + "properties": { + "managedIdentity": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "objectId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "oidcIssuer": { + "oidcIssuerUrl": "https://oidc-endpoint" + }, + "provisioningState": "Succeeded" + }, + "eTag": "string" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Create_Or_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Create_Or_Update.json new file mode 100644 index 000000000000..9434e871cddf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Create_Or_Update.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "jwtAuthenticatorName": "jwt1", + "parameters": { + "properties": { + "issuer": { + "url": "https://example.com", + "audiences": [ + "https://example.com/audience1", + "https://example.com/audience2" + ] + }, + "claimValidationRules": [ + { + "expression": "has(claims.sub)", + "message": "Sub is required" + }, + { + "expression": "claims.sub != ''", + "message": "Sub cannot be empty" + } + ], + "claimMappings": { + "username": { + "expression": "'aks:jwt:' + claims.sub" + }, + "groups": { + "expression": "claims.groups.split(',').map(group, 'aks:jwt:' + group)" + }, + "extra": [ + { + "key": "example.com/extrakey", + "valueExpression": "claims.customfield" + } + ] + }, + "userValidationRules": [ + { + "expression": "user.groups.all(group, group.startsWith('aks:jwt:admin:'))", + "message": "Must be in admin user group" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/jwtAuthenticators/jwt1", + "type": "Microsoft.ContainerService/managedClusters/jwtAuthenticators", + "name": "jwt1", + "properties": { + "provisioningState": "Succeeded", + "issuer": { + "url": "https://example.com", + "audiences": [ + "https://example.com/audience1", + "https://example.com/audience2" + ] + }, + "claimValidationRules": [ + { + "expression": "has(claims.sub)", + "message": "Sub is required" + }, + { + "expression": "claims.sub != ''", + "message": "Sub cannot be empty" + } + ], + "claimMappings": { + "username": { + "expression": "'aks:jwt:' + claims.sub" + }, + "groups": { + "expression": "claims.groups.split(',').map(group, 'aks:jwt:' + group)" + }, + "extra": [ + { + "key": "example.com/extrakey", + "valueExpression": "claims.customfield" + } + ] + }, + "userValidationRules": [ + { + "expression": "user.groups.all(group, group.startsWith('aks:jwt:admin:'))", + "message": "Must be in admin user group" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/jwtAuthenticators/jwt1", + "type": "Microsoft.ContainerService/managedClusters/jwtAuthenticators", + "name": "jwt1", + "properties": { + "provisioningState": "Succeeded", + "issuer": { + "url": "https://example.com", + "audiences": [ + "https://example.com/audience1", + "https://example.com/audience2" + ] + }, + "claimValidationRules": [ + { + "expression": "has(claims.sub)", + "message": "Sub is required" + }, + { + "expression": "claims.sub != ''", + "message": "Sub cannot be empty" + } + ], + "claimMappings": { + "username": { + "expression": "'aks:jwt:' + claims.sub" + }, + "groups": { + "expression": "claims.groups.split(',').map(group, 'aks:jwt:' + group)" + }, + "extra": [ + { + "key": "example.com/extrakey", + "valueExpression": "claims.customfield" + } + ] + }, + "userValidationRules": [ + { + "expression": "user.groups.all(group, group.startsWith('aks:jwt:admin:'))", + "message": "Must be in admin user group" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Delete.json new file mode 100644 index 000000000000..d407f998389e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "jwtAuthenticatorName": "jwt1" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-09-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Get.json new file mode 100644 index 000000000000..b022b58ff7c3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_Get.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "jwtAuthenticatorName": "jwt1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/jwtAuthenticators/jwt1", + "type": "Microsoft.ContainerService/managedClusters/jwtAuthenticators", + "name": "jwt1", + "properties": { + "provisioningState": "Succeeded", + "issuer": { + "url": "https://example.com", + "audiences": [ + "https://example.com/audience1", + "https://example.com/audience2" + ] + }, + "claimValidationRules": [ + { + "expression": "has(claims.sub)", + "message": "Sub is required" + }, + { + "expression": "claims.sub != ''", + "message": "Sub cannot be empty" + } + ], + "claimMappings": { + "username": { + "expression": "'aks:jwt:' + claims.sub" + }, + "groups": { + "expression": "claims.groups.split(',').map(group, 'aks:jwt:' + group)" + }, + "extra": [ + { + "key": "example.com/extrakey", + "valueExpression": "claims.customfield" + } + ] + }, + "userValidationRules": [ + { + "expression": "user.groups.all(group, group.startsWith('aks:jwt:admin:'))", + "message": "Must be in admin user group" + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_List.json new file mode 100644 index 000000000000..80ebba97b8a2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/JWTAuthenticators_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/jwtAuthenticators/jwt1", + "type": "Microsoft.ContainerService/managedClusters/jwtAuthenticators", + "name": "jwt1", + "properties": { + "provisioningState": "Succeeded", + "issuer": { + "url": "https://example.com", + "audiences": [ + "https://example.com/audience1", + "https://example.com/audience2" + ] + }, + "claimValidationRules": [ + { + "expression": "has(claims.sub)", + "message": "Sub is required" + }, + { + "expression": "claims.sub != ''", + "message": "Sub cannot be empty" + } + ], + "claimMappings": { + "username": { + "expression": "'aks:jwt:' + claims.sub" + }, + "groups": { + "expression": "claims.groups.split(',').map(group, 'aks:jwt:' + group)" + }, + "extra": [ + { + "key": "example.com/extrakey", + "valueExpression": "claims.customfield" + } + ] + }, + "userValidationRules": [ + { + "expression": "user.groups.all(group, group.startsWith('aks:jwt:admin:'))", + "message": "Must be in admin user group" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/KubernetesVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/KubernetesVersions_List.json new file mode 100644 index 000000000000..085646baa992 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/KubernetesVersions_List.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "values": [ + { + "version": "1.23", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.23.12": { + "upgrades": [ + "1.23.15", + "1.24.6", + "1.24.9" + ] + }, + "1.23.15": { + "upgrades": [ + "1.24.6", + "1.24.9" + ] + } + } + }, + { + "version": "1.24", + "isDefault": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.24.6": { + "upgrades": [ + "1.24.9", + "1.25.4", + "1.25.5" + ] + }, + "1.24.9": { + "upgrades": [ + "1.25.4", + "1.25.5" + ] + } + } + }, + { + "version": "1.25", + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.25.4": { + "upgrades": [ + "1.25.5", + "1.26.0" + ] + }, + "1.25.5": { + "upgrades": [ + "1.26.0" + ] + } + } + }, + { + "version": "1.26", + "isPreview": true, + "capabilities": { + "supportPlan": [ + "KubernetesOfficial" + ] + }, + "patchVersions": { + "1.26.0": { + "upgrades": [] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ListGuardrailsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ListGuardrailsVersions.json new file mode 100644 index 000000000000..bed8fd443eca --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ListGuardrailsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/guardrailsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/guardrailsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ListSafeguardsVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ListSafeguardsVersions.json new file mode 100644 index 000000000000..e4541c41971d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ListSafeguardsVersions.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/safeguardsVersions/v1.0.0", + "type": "Microsoft.ContainerService/locations/safeguardsVersions", + "name": "v1.0.0", + "properties": { + "isDefaultVersion": true, + "support": "Preview" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Create_Or_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Create_Or_Update.json new file mode 100644 index 000000000000..3c28844a7580 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Create_Or_Update.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes", + "parameters": { + "properties": { + "primaryAgentPoolName": "agentpool1", + "allowServicePlacement": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Delete.json new file mode 100644 index 000000000000..993959959e1d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-09-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Get.json new file mode 100644 index 000000000000..3d2cdea42249 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "loadBalancerName": "kubernetes" + }, + "responses": { + "200": { + "body": { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_List.json new file mode 100644 index 000000000000..bc4c40d08bc4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "kubernetes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/loadBalancers/kubernetes", + "properties": { + "primaryAgentPoolName": "agentPool1", + "allowServicePlacement": true, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Rebalance.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Rebalance.json new file mode 100644 index 000000000000..33388cc39c81 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/LoadBalancers_Rebalance.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "loadBalancerNames": [ + "kubernetes" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-09-02-preview" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineCreate_Update.json new file mode 100644 index 000000000000..a38d462e55e1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineCreate_Update.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "machine1", + "parameters": { + "zones": [ + "1" + ], + "properties": { + "operatingSystem": { + "osType": "Linux", + "osSKU": "Ubuntu", + "enableFIPS": false + }, + "hardware": { + "vmSize": "Standard_DS1_v2" + }, + "kubernetes": { + "orchestratorVersion": "1.30", + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "kubeletDiskType": "OS", + "maxPods": 110 + }, + "tags": { + "name1": "val1" + }, + "priority": "Spot", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/machines/machine1", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "name": "machine1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "operatingSystem": { + "osType": "Linux", + "osSKU": "Ubuntu", + "enableFIPS": false + }, + "hardware": { + "vmSize": "Standard_DS1_v2" + }, + "kubernetes": { + "orchestratorVersion": "1.30", + "currentOrchestratorVersion": "1.30.6", + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "kubeletDiskType": "OS", + "maxPods": 110, + "nodeName": "aks-nodepool1-machine1-25481572-vm0" + }, + "tags": { + "name1": "val1" + }, + "status": { + "creationTimestamp": "2025-04-02T12:00:00Z", + "driftAction": "Synced", + "vmState": "Running" + }, + "priority": "Spot", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2023.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/machines/machine1", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "name": "machine1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Creating", + "operatingSystem": { + "osType": "Linux", + "osSKU": "Ubuntu", + "enableFIPS": false + }, + "hardware": { + "vmSize": "Standard_DS1_v2" + }, + "kubernetes": { + "orchestratorVersion": "1.30", + "currentOrchestratorVersion": "1.30.6", + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "kubeletDiskType": "OS", + "maxPods": 110, + "nodeName": "aks-nodepool1-machine1-25481572-vm0" + }, + "tags": { + "name1": "val1" + }, + "status": { + "creationTimestamp": "2025-04-02T12:00:00Z", + "driftAction": "Synced", + "vmState": "Running" + }, + "priority": "Spot", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2023.03.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineGet.json new file mode 100644 index 000000000000..5ef449318655 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "machineName": "aks-nodepool1-42263519-vmss00000t" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "zones": [ + "1" + ], + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0", + "provisioningState": "Succeeded", + "kubernetes": { + "orchestratorVersion": "1.30", + "currentOrchestratorVersion": "1.30.6", + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "kubeletDiskType": "OS", + "maxPods": 110 + }, + "hardware": { + "vmSize": "Standard_DS1_v2" + }, + "priority": "Spot", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2023.03.11" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineList.json new file mode 100644 index 000000000000..24b3933595c6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MachineList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.ContainerService/managedClusters/round/agentPools/nodepool1/machines/aks-nodepool1-25481572-vmss000000", + "name": "aks-nodepool1-25481572-vmss000000", + "type": "Microsoft.ContainerService/managedClusters/agentPools/machines", + "zones": [ + "1" + ], + "properties": { + "network": { + "ipAddresses": [ + { + "ip": "172.20.2.4", + "family": "IPv4" + }, + { + "ip": "10.0.0.1", + "family": "IPv4" + } + ] + }, + "resourceId": "/subscriptions/26fe00f8-9173-4872-9134-bb1d2e00343a/resourceGroups/dummyRG/providers/Microsoft.Compute/virtualMachineScaleSets/aks-nodepool1-25481572-vmss/virtualMachines/0", + "provisioningState": "Succeeded", + "kubernetes": { + "orchestratorVersion": "1.30", + "currentOrchestratorVersion": "1.30.6", + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "kubeletDiskType": "OS", + "maxPods": 110 + }, + "hardware": { + "vmSize": "Standard_DS1_v2" + }, + "priority": "Spot", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2023.03.11" + } + } + ], + "nextLink": "http://xxxx.azure.com?encodedToken=c2tpcFRva2VuPTE" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json new file mode 100644 index 000000000000..4a80d9280195 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedAutoUpgradeSchedule", + "parameters": { + "properties": { + "maintenanceWindow": { + "schedule": { + "relativeMonthly": { + "intervalMonths": 3, + "weekIndex": "First", + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "type": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations", + "name": "aksManagedAutoUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "weekly": { + "intervalWeeks": 3, + "dayOfWeek": "Monday" + } + }, + "durationHours": 10, + "utcOffset": "+05:30", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json new file mode 100644 index 000000000000..da0eacb2fd78 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json new file mode 100644 index 000000000000..61f87333afc9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsGet_MaintenanceWindow.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "configName": "aksManagedNodeOSUpgradeSchedule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 3 + } + }, + "durationHours": 4, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "09:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json new file mode 100644 index 000000000000..1803e1a69887 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MaintenanceConfigurationsList_MaintenanceWindow.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedNodeOSUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "daily": { + "intervalDays": 5 + } + }, + "durationHours": 10, + "utcOffset": "-07:00", + "startDate": "2023-01-01", + "startTime": "13:30" + } + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/maintenanceConfigurations/default", + "name": "aksManagedAutoUpgradeSchedule", + "properties": { + "maintenanceWindow": { + "schedule": { + "absoluteMonthly": { + "intervalMonths": 3, + "dayOfMonth": 15 + } + }, + "durationHours": 5, + "utcOffset": "+00:00", + "startDate": "2023-01-01", + "startTime": "08:30", + "notAllowedDates": [ + { + "start": "2023-02-18", + "end": "2023-02-25" + }, + { + "start": "2023-12-23", + "end": "2024-01-05" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsCreate.json new file mode 100644 index 000000000000..35ded08275c2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsDelete.json new file mode 100644 index 000000000000..dc85b98378b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsGet.json new file mode 100644 index 000000000000..e1b6c73ea681 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsList.json new file mode 100644 index 000000000000..e01e2655cdd9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..32b9ab143aee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json new file mode 100644 index 000000000000..e158147b7f00 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClusterSnapshotsUpdateTags.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1", + "type": "Microsoft.ContainerService/ManagedClusterSnapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1" + }, + "snapshotType": "ManagedCluster", + "managedClusterPropertiesReadOnly": { + "kubernetesVersion": "1.20.5", + "sku": { + "name": "Basic", + "tier": "Free" + }, + "enableRbac": true, + "networkProfile": { + "networkPlugin": "kubenet", + "networkPolicy": "calico", + "networkMode": "bridge", + "loadBalancerSku": "standard" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersAbortOperation.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersAbortOperation.json new file mode 100644 index 000000000000..99a45df3284a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersAbortOperation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2017-08-31", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersAssociate_CRG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersAssociate_CRG.json new file mode 100644 index 000000000000..fbd1e62d9442 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersAssociate_CRG.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "capacityReservationGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/capacityReservationGroups/crg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json new file mode 100644 index 000000000000..62ca605ae9c4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json new file mode 100644 index 000000000000..ba3d91c0b6ea --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_AzureServiceMesh.json @@ -0,0 +1,346 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "name": "istioegress1" + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + } + } + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "name": "istioegress1" + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "addonProfiles": { + "azureKeyvaultSecretsProvider": { + "enabled": true, + "config": { + "enableSecretRotation": "true", + "rotationPollInterval": "2m" + } + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "serviceMeshProfile": { + "mode": "Istio", + "istio": { + "components": { + "ingressGateways": [ + { + "enabled": true, + "mode": "Internal" + } + ], + "egressGateways": [ + { + "enabled": true, + "name": "istioegress1" + } + ] + }, + "certificateAuthority": { + "plugin": { + "keyVaultId": "/subscriptions/854c9ddb-fe9e-4aea-8d58-99ed88282881/resourceGroups/ddama-test/providers/Microsoft.KeyVault/vaults/my-akv", + "certObjectName": "ca-cert", + "keyObjectName": "ca-key", + "rootCertObjectName": "root-cert", + "certChainObjectName": "cert-chain" + } + }, + "revisions": [ + "asm-1-17" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_CustomCATrustCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_CustomCATrustCertificates.json new file mode 100644 index 000000000000..377de91985c1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_CustomCATrustCertificates.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "securityProfile": { + "customCATrustCertificates": [ + "ZHVtbXlFeGFtcGxlVGVzdFZhbHVlRm9yQ2VydGlmaWNhdGVUb0JlQWRkZWQ=" + ] + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json new file mode 100644 index 000000000000..6f583088acf5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DedicatedHostGroup.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "hostGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.Compute/hostGroups/hostgroup1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json new file mode 100644 index 000000000000..1fdb453aa0db --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DisableRunCommand.json @@ -0,0 +1,262 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "KubernetesOfficial" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json new file mode 100644 index 000000000000..e70390f46cb8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_DualStackNetworking.json @@ -0,0 +1,318 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + }, + "ipFamilies": [ + "IPv4", + "IPv6" + ] + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16", + "fd11:1234::/64" + ], + "serviceCidrs": [ + "10.0.0.0/16", + "fd00:1234::/108" + ], + "ipFamilies": [ + "IPv4", + "IPv6" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2, + "countIPv6": 1 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip3-ipv6" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json new file mode 100644 index 000000000000..4fd0f9deec83 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableAIToolchainOperator.json @@ -0,0 +1,235 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aiToolchainOperatorProfile": { + "enabled": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json new file mode 100644 index 000000000000..11f3be045a19 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableEncryptionAtHost.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json new file mode 100644 index 000000000000..18f5536c516a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnableUltraSSD.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableUltraSSD": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json new file mode 100644 index 000000000000..198f5e42b7eb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_EnabledFIPS.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_GPUMIG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_GPUMIG.json new file mode 100644 index 000000000000..e6c86b708717 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_GPUMIG.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_ND96asr_v4", + "maxPods": 110, + "osType": "Linux", + "gpuInstanceProfile": "MIG3g", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_HTTPProxy.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_HTTPProxy.json new file mode 100644 index 000000000000..409b73009eeb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_HTTPProxy.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_IngressProfile_ApplicationLoadBalancer.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_IngressProfile_ApplicationLoadBalancer.json new file mode 100644 index 000000000000..baabe14e7012 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_IngressProfile_ApplicationLoadBalancer.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "applicationLoadBalancer": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json new file mode 100644 index 000000000000..41f5942604ee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "ingressProfile": { + "webAppRouting": { + "enabled": true, + "dnsZoneResourceIds": [ + "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.Network/dnszones/DNS_ZONE_NAME" + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_MCSnapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_MCSnapshot.json new file mode 100644 index 000000000000..f742ce322cee --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_MCSnapshot.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedclustersnapshots/snapshot1" + }, + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json new file mode 100644 index 000000000000..9f93b8483fc4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_ManagedNATGateway.json @@ -0,0 +1,228 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "managedOutboundIPProfile": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "managedNATGateway", + "natGatewayProfile": { + "idleTimeoutInMinutes": 4, + "managedOutboundIPProfile": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json new file mode 100644 index 000000000000..fe6809ab8d24 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_NodeAutoProvisioning.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "networkPlugin": "azure", + "networkPluginMode": "overlay", + "networkDataplane": "cilium", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json new file mode 100644 index 000000000000..b7e5d5cb7afd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_NodePublicIPPrefix.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodePublicIPPrefixID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/publicIPPrefixes/public-ip-prefix" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_OSSKU.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_OSSKU.json new file mode 100644 index 000000000000..b8e141fea361 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_OSSKU.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "osSKU": "AzureLinux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "osSKU": "AzureLinux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "httpProxyConfig": { + "httpProxy": "http://myproxy.server.com:8080", + "httpsProxy": "https://myproxy.server.com:8080", + "noProxy": [ + "localhost", + "127.0.0.1" + ], + "trustedCa": "Q29uZ3JhdHMhIFlvdSBoYXZlIGZvdW5kIGEgaGlkZGVuIG1lc3NhZ2U=" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..2b2135814a61 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PodIdentity.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PodIdentity.json new file mode 100644 index 000000000000..97f311257705 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PodIdentity.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "podIdentityProfile": { + "enabled": true, + "allowNetworkPluginKubenet": true + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Premium.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Premium.json new file mode 100644 index 000000000000..162e672792fd --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Premium.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "addonProfiles": {}, + "enableRBAC": true, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "sku": { + "name": "Base", + "tier": "Premium" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "disableRunCommand": true + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "supportPlan": "AKSLongTermSupport" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json new file mode 100644 index 000000000000..aee185e16cda --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json @@ -0,0 +1,261 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "addonProfiles": {}, + "enableRBAC": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "fqdnSubdomain": "domain1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "privateDNSZone": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.Network/privateDnsZones/privatelink.location1.azmk8s.io" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "privateFQDN": "domain1.privatelink.location1.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json new file mode 100644 index 000000000000..d05a1315d676 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true + }, + "addonProfiles": {}, + "enableRBAC": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableEncryptionAtHost": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "apiServerAccessProfile": { + "enablePrivateCluster": true, + "enablePrivateClusterPublicFQDN": true, + "privateDNSZone": "system" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "fqdn": "dnsprefix1-ee788a1f.hcp.location1.azmk8s.io", + "privateFQDN": "dnsprefix1-aae7e0f0.5cef6058-b6b5-414d-8cb1-4bd14eb0b15c.privatelink.location1.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_SecurityProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_SecurityProfile.json new file mode 100644 index 000000000000..b61a25287b69 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_SecurityProfile.json @@ -0,0 +1,288 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + }, + "securityGating": { + "enabled": true, + "identities": [ + { + "azureContainerRegistry": "registry1", + "identity": { + "clientId": "client1", + "resourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.ManagedIdentity/userAssignedIdentities/IDENTITY_NAME" + } + } + ], + "allowSecretAccess": true + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + }, + "securityGating": { + "enabled": true, + "identities": [ + { + "azureContainerRegistry": "registry1", + "identity": { + "clientId": "client1", + "resourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.ManagedIdentity/userAssignedIdentities/IDENTITY_NAME" + } + } + ], + "allowSecretAccess": true + } + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "securityProfile": { + "defender": { + "logAnalyticsWorkspaceResourceId": "/subscriptions/SUB_ID/resourcegroups/RG_NAME/providers/microsoft.operationalinsights/workspaces/WORKSPACE_NAME", + "securityMonitoring": { + "enabled": true + }, + "securityGating": { + "enabled": true, + "identities": [ + { + "azureContainerRegistry": "registry1", + "identity": { + "clientId": "client1", + "resourceId": "/subscriptions/SUB_ID/resourceGroups/RG_NAME/providers/Microsoft.ManagedIdentity/userAssignedIdentities/IDENTITY_NAME" + } + } + ], + "allowSecretAccess": true + } + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Snapshot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Snapshot.json new file mode 100644 index 000000000000..ca8e4d62969c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Snapshot.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "enableFIPS": true, + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..71ecb8125ac9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,312 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": false, + "until": "2022-11-01T13:00:00Z" + } + }, + "autoScalerProfile": { + "balance-similar-node-groups": "true", + "expander": "priority", + "max-node-provision-time": "15m", + "new-pod-scale-up-delay": "1m", + "scale-down-delay-after-add": "15m", + "scan-interval": "20s", + "skip-nodes-with-system-pods": "false" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "scaleDownMode": "Deallocate", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json new file mode 100644 index 000000000000..4436fdebc402 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWindowsGmsa.json @@ -0,0 +1,296 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "gmsaProfile": { + "enabled": true + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json new file mode 100644 index 000000000000..6755f96593c5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithAHUB.json @@ -0,0 +1,290 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser", + "licenseType": "Windows_Server" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..f501ef1c2e1f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,279 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json new file mode 100644 index 000000000000..fad5f9e2b2e0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json @@ -0,0 +1,266 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enableNamespaceResources": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "enableNamespaceResources": true + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json new file mode 100644 index 000000000000..1739874086f5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_UserAssignedNATGateway.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": false, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "userAssignedNATGateway" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_VirtualMachines.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_VirtualMachines.json new file mode 100644 index 000000000000..031dbb1fb15a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersCreate_VirtualMachines.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "type": "VirtualMachines", + "mode": "System", + "enableFIPS": true + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..41dd97f6bebf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..73f1534f8090 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "beywbwei", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "azurePortalFQDN": "dnsprefix1-abcd1234.portal.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "eTag": "nvewbvoi", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "podCidrs": [ + "10.244.0.0/16" + ], + "serviceCidrs": [ + "10.0.0.0/16" + ], + "ipFamilies": [ + "IPv4" + ], + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "upgradeSettings": { + "overrideSettings": { + "forceUpgrade": true, + "until": "2022-11-01T13:00:00Z" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..57a45b6d2c60 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "a3ViZUNvbmZpZzE=" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..bc240ed6eb2d --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json new file mode 100644 index 000000000000..ee6edbc5f94e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet_MeshRevisionProfile.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json new file mode 100644 index 000000000000..e1a17c42afed --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersGet_MeshUpgradeProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "mode": "istio" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList.json new file mode 100644 index 000000000000..81f0e4fb0f69 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "eTag": "nvweuib", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6", + "eTag": "byuefvwi" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..bec8a345eb80 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..a58433cff102 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json new file mode 100644 index 000000000000..fddb5116d2d0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList_MeshRevisionProfiles.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/location1/meshRevisionProfiles/istio", + "type": "Microsoft.ContainerService/locations/meshRevisionProfiles", + "name": "istio", + "properties": { + "meshRevisions": [ + { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + }, + { + "revision": "asm-1-18", + "upgrades": [], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.24", + "1.25", + "1.26", + "1.27" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json new file mode 100644 index 000000000000..b73598d91b4e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersList_MeshUpgradeProfiles.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshUpgradeProfiles/istio", + "type": "Microsoft.ContainerService/managedClusters/meshUpgradeProfiles", + "name": "istio", + "properties": { + "revision": "asm-1-17", + "upgrades": [ + "1-18" + ], + "compatibleWith": [ + { + "name": "kubernetes", + "versions": [ + "1.23", + "1.24", + "1.25", + "1.26" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..d76507f73c75 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..34e9532a87e3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..41dd97f6bebf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json new file mode 100644 index 000000000000..41dd97f6bebf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersRotateServiceAccountSigningKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersStart.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersStart.json new file mode 100644 index 000000000000..41dd97f6bebf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersStop.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersStop.json new file mode 100644 index 000000000000..41dd97f6bebf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..26a6a49ab007 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "currentOrchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesCreate_Update.json new file mode 100644 index 000000000000..8cf00a9aecf0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesCreate_Update.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "managedNamespaceName": "namespace1", + "parameters": { + "tags": { + "tagKey1": "tagValue1" + }, + "properties": { + "labels": { + "kubernetes.io/metadata.name": "true" + }, + "annotations": { + "annatationKey": "annatationValue" + }, + "defaultResourceQuota": { + "cpuRequest": "3m", + "cpuLimit": "3m", + "memoryRequest": "5Gi", + "memoryLimit": "5Gi" + }, + "defaultNetworkPolicy": { + "ingress": "AllowSameNamespace", + "egress": "AllowAll" + }, + "adoptionPolicy": "IfIdentical", + "deletePolicy": "Keep" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/managedNamespaces/namespace1", + "name": "namespace1", + "type": "Microsoft.ContainerService/managedClusters/managedNamespaces", + "location": "eastus2", + "tags": { + "tagKey1": "tagValue1" + }, + "properties": { + "labels": { + "kubernetes.io/metadata.name": "true" + }, + "annotations": { + "annatationKey": "annatationValue" + }, + "provisioningState": "Succeeded", + "defaultResourceQuota": { + "cpuRequest": "3m", + "cpuLimit": "3m", + "memoryRequest": "5Gi", + "memoryLimit": "5Gi" + }, + "defaultNetworkPolicy": { + "ingress": "AllowSameNamespace", + "egress": "AllowAll" + }, + "adoptionPolicy": "IfIdentical", + "deletePolicy": "Keep" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/managedNamespaces/namespace1", + "name": "namespace1", + "type": "Microsoft.ContainerService/managedClusters/managedNamespaces", + "location": "eastus2", + "tags": { + "tagKey1": "tagValue1" + }, + "properties": { + "labels": { + "kubernetes.io/metadata.name": "true" + }, + "annotations": { + "annatationKey": "annatationValue" + }, + "provisioningState": "Updating", + "defaultResourceQuota": { + "cpuRequest": "3m", + "cpuLimit": "3m", + "memoryRequest": "5Gi", + "memoryLimit": "5Gi" + }, + "defaultNetworkPolicy": { + "ingress": "AllowSameNamespace", + "egress": "AllowAll" + }, + "adoptionPolicy": "IfIdentical", + "deletePolicy": "Keep" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesDelete.json new file mode 100644 index 000000000000..217676162eaa --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "managedNamespaceName": "namespace1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus2/operations/00000000-0000-0000-0000-000000000000?api-version=2025-09-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesGet.json new file mode 100644 index 000000000000..398bce6d7316 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "managedNamespaceName": "namespace1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/managedNamespaces/namespace1", + "name": "namespace1", + "type": "Microsoft.ContainerService/managedClusters/managedNamespaces", + "tags": { + "tagKey1": "tagValue1" + }, + "location": "eastus2", + "properties": { + "labels": { + "kubernetes.azure.com/managedByArm": "true" + }, + "annotations": { + "annatationKey": "annatationValue" + }, + "provisioningState": "Succeeded", + "defaultResourceQuota": { + "cpuRequest": "3m", + "cpuLimit": "3m", + "memoryRequest": "5Gi", + "memoryLimit": "5Gi" + }, + "defaultNetworkPolicy": { + "ingress": "AllowSameNamespace", + "egress": "AllowAll" + }, + "adoptionPolicy": "IfIdentical", + "deletePolicy": "Keep" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesList.json new file mode 100644 index 000000000000..a62ac0272731 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "managedNamespaceName": "namespace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/managedNamespaces/namespace1", + "name": "namespace1", + "type": "Microsoft.ContainerService/managedClusters/managedNamespaces", + "tags": { + "tagKey1": "tagValue1" + }, + "location": "eastus2", + "properties": { + "labels": { + "kubernetes.azure.com/managedByArm": "true" + }, + "annotations": { + "annatationKey": "annatationValue" + }, + "provisioningState": "Succeeded", + "defaultResourceQuota": { + "cpuRequest": "3m", + "cpuLimit": "3m", + "memoryRequest": "5Gi", + "memoryLimit": "5Gi" + }, + "defaultNetworkPolicy": { + "ingress": "AllowSameNamespace", + "egress": "AllowAll" + }, + "adoptionPolicy": "IfIdentical", + "deletePolicy": "Keep" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesListCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesListCredentialResult.json new file mode 100644 index 000000000000..3ea89413d834 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesListCredentialResult.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "managedNamespaceName": "namespace1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "Y3JlZGVudGlhbFZhbHVlMQ==" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesUpdateTags.json new file mode 100644 index 000000000000..1a716690539c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ManagedNamespacesUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "managedNamespaceName": "namespace1", + "parameters": { + "tags": { + "tagKey1": "tagValue1", + "tagKey2": "tagValue2" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "tagValue1", + "tagKey2": "tagValue2" + }, + "location": "eastus2", + "properties": { + "labels": { + "kubernetes.azure.com/managedByArm": "true" + }, + "annotations": { + "annatationKey": "annatationValue" + }, + "provisioningState": "Succeeded", + "defaultResourceQuota": { + "cpuRequest": "3m", + "cpuLimit": "3m", + "memoryRequest": "5Gi", + "memoryLimit": "5Gi" + }, + "defaultNetworkPolicy": { + "ingress": "AllowSameNamespace", + "egress": "AllowAll" + }, + "adoptionPolicy": "IfIdentical", + "deletePolicy": "Keep" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_CreateOrUpdate.json new file mode 100644 index 000000000000..3d0f6a601d7b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "meshMembershipName": "meshmembership1", + "parameters": { + "properties": { + "managedMeshID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.AppLink/applinks/applink1/appLinkMembers/member1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshMemberships/meshmembership1", + "name": "meshmembership1", + "type": "Microsoft.ContainerService/managedClusters/meshMemberships", + "properties": { + "managedMeshID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.AppLink/applinks/applink1/appLinkMembers/member1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshMemberships/meshmembership1", + "name": "meshmembership1", + "type": "Microsoft.ContainerService/managedClusters/meshMemberships", + "properties": { + "managedMeshID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.AppLink/applinks/applink1/appLinkMembers/member1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_Delete.json new file mode 100644 index 000000000000..f4c8b9bd8b22 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "meshMembershipName": "meshmembership1" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-09-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_Get.json new file mode 100644 index 000000000000..db6e11d370a9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "meshMembershipName": "meshmembership1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshMemberships/meshmembership1", + "name": "meshmembership1", + "type": "Microsoft.ContainerService/managedClusters/meshMemberships", + "properties": { + "managedMeshID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.AppLink/applinks/applink1/appLinkMembers/member1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_ListByManagedCluster.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_ListByManagedCluster.json new file mode 100644 index 000000000000..ccca639d4d1b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/MeshMemberships_ListByManagedCluster.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/meshMemberships/meshmembership1", + "name": "meshmembership1", + "type": "Microsoft.ContainerService/managedClusters/meshMemberships", + "properties": { + "managedMeshID": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.AppLink/applinks/applink1/appLinkMembers/member1" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/NodeImageVersions_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/NodeImageVersions_List.json new file mode 100644 index 000000000000..bf9c687ec68f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/NodeImageVersions_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "location1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "fullName": "AKSCBLMariner-V1-202308.28.0", + "os": "AKSCBLMariner", + "sku": "V1", + "version": "202308.28.0" + }, + { + "fullName": "AKSUbuntu-2204gen2minimalcontainerd-202401.12.0", + "os": "AKSUbuntu", + "sku": "2204gen2minimalcontainerd", + "version": "202401.12.0" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultGet.json new file mode 100644 index 000000000000..8f779cf1ef05 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultGetByAgentPool.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultGetByAgentPool.json new file mode 100644 index 000000000000..ad6a019da85b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultGetByAgentPool.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "operationId": "00000000-0000-0000-0000-000000000001" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/operations/00000000-0000-0000-0000-000000000001", + "name": "00000000-0000-0000-0000-000000000001", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultList.json new file mode 100644 index 000000000000..fac174aa1294 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OperationStatusResultList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4a", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4a", + "status": "InProgress", + "percentComplete": 40, + "startTime": "2023-07-26T12:14:26.3179428Z" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/operations/d11edb09-6e27-429f-9fe5-17baf773bc4b", + "name": "d11edb09-6e27-429f-9fe5-17baf773bc4b", + "status": "Failed", + "startTime": "2023-07-26T12:14:26.3179428Z", + "endTime": "2023-07-26T12:14:50.3179428Z", + "error": { + "code": "ReconcileAgentPoolIdentityError", + "message": "Reconcile agent pool nodepool1 identity failed" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/Operation_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/Operation_List.json new file mode 100644 index 000000000000..7628fb233912 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/Operation_List.json @@ -0,0 +1,3573 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets the status of an asynchronous operation", + "operation": "Get Operation", + "provider": "Microsoft Container Service", + "resource": "Operation" + }, + "name": "Microsoft.ContainerService/locations/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists the supported orchestrators", + "operation": "List Orchestrators", + "provider": "Microsoft Container Service", + "resource": "Orchestrator" + }, + "name": "Microsoft.ContainerService/locations/orchestrators/read", + "origin": "user,system" + }, + { + "display": { + "description": "Lists operations available on Microsoft.ContainerService resource provider", + "operation": "List Available Container Service Operations", + "provider": "Microsoft Container Service", + "resource": "Available Container Service Operations" + }, + "name": "Microsoft.ContainerService/operations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Registers Subscription with Microsoft.ContainerService resource provider", + "operation": "Register Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Register Subscription" + }, + "name": "Microsoft.ContainerService/register/action", + "origin": "user,system" + }, + { + "display": { + "description": "Unregisters Subscription with Microsoft.ContainerService resource provider", + "operation": "Unregister Subscription for Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Service Unregister Subscription" + }, + "name": "Microsoft.ContainerService/unregister/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the status of an asynchronous operation result", + "operation": "Get Operation Result", + "provider": "Microsoft Container Service", + "resource": "OperationResult" + }, + "name": "Microsoft.ContainerService/locations/operationresults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a container service", + "operation": "Get Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new container service or updates an existing one", + "operation": "Create or Update Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a container service", + "operation": "Delete Container Service", + "provider": "Microsoft Container Service", + "resource": "Container Services" + }, + "name": "Microsoft.ContainerService/containerServices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster", + "operation": "Get Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new managed cluster or updates an existing one", + "operation": "Create or Update Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a managed cluster", + "operation": "Delete Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Starts a managed cluster", + "operation": "Start Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/start/action", + "origin": "user,system" + }, + { + "display": { + "description": "Stops a managed cluster", + "operation": "Stop Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/stop/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets a maintenance configuration", + "operation": "Get a maintenance configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new MaintenanceConfiguration or updates an existing one", + "operation": "Create or Update maintenance configuratio", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a maintenance configuration", + "operation": "Delete Maintenance Configuration", + "provider": "Microsoft Container Service", + "resource": "Maintenance Configurations" + }, + "name": "Microsoft.ContainerService/managedClusters/maintenanceConfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an agent pool", + "operation": "Get Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new agent pool or updates an existing one", + "operation": "Create or Update Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes an agent pool", + "operation": "Delete Agent Pool", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the Agent Pool", + "operation": "Get Agent Pool UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Upgrade the node image version of agent pool", + "operation": "Upgrade agent pool node image version", + "provider": "Microsoft Container Service", + "resource": "Agent Pools" + }, + "name": "Microsoft.ContainerService/managedClusters/agentPools/upgradeNodeImageVersion/write", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available agent pool versions of the cluster", + "operation": "Get Available Agent Pool Versions", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/availableAgentPoolVersions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name", + "operation": "Get Managed Cluster AccessProfile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get a managed cluster access profile by role name using list credential", + "operation": "Get Managed Cluster AccessProfile by List Credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/accessProfiles/listCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the upgrade profile of the cluster", + "operation": "Get UpgradeProfile", + "provider": "Microsoft Container Service", + "resource": "UpgradeProfile" + }, + "name": "Microsoft.ContainerService/managedClusters/upgradeProfiles/read", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterAdmin credential of a managed cluster", + "operation": "List clusterAdmin credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterAdminCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterUser credential of a managed cluster", + "operation": "List clusterUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "List the clusterMonitoringUser credential of a managed cluster", + "operation": "List clusterMonitoringUser credential", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/listClusterMonitoringUserCredential/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the service principal profile of a managed cluster", + "operation": "Reset service principal profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetServicePrincipalProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Resolve the private link service id of a managed cluster", + "operation": "Resolve private link service id", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resolvePrivateLinkServiceId/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reset the AAD profile of a managed cluster", + "operation": "Reset AAD profile", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/resetAADProfile/action", + "origin": "user,system" + }, + { + "display": { + "description": "Rotate certificates of a managed cluster", + "operation": "Rotate certificates of the cluster", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/rotateClusterCertificates/action", + "origin": "user,system" + }, + { + "display": { + "description": "Run user issued command against managed kubernetes server.", + "operation": "RunCommand", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/runCommand/action", + "origin": "user,system" + }, + { + "display": { + "description": "Retrieve result from previous issued command.", + "operation": "CommandResult", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/commandResults/read", + "origin": "user,system" + }, + { + "display": { + "description": "Get the diagnostic setting for a managed cluster resource", + "operation": "Read Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/read", + "origin": "system" + }, + { + "display": { + "description": "Creates or updates the diagnostic setting for a managed cluster resource", + "operation": "Write Diagnostic Setting", + "provider": "Microsoft Container Service", + "resource": "Managed Clusters" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/diagnosticSettings/write", + "origin": "system" + }, + { + "display": { + "description": "Get Managed Cluster Detector", + "operation": "Get Managed Cluster Detector", + "provider": "Microsoft Container Service", + "resource": "Managed Cluster Detector" + }, + "name": "Microsoft.ContainerService/managedClusters/detectors/read", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the diagnostics state of the cluster", + "operation": "Get Diagnostics State", + "provider": "Microsoft Container Service", + "resource": "Diagnostics State" + }, + "name": "Microsoft.ContainerService/managedClusters/diagnosticsState/read", + "origin": "user,system" + }, + { + "display": { + "description": "Determines if user is allowed to approve a private endpoint connection", + "operation": "Approve Private Endpoint Connections", + "provider": "Microsoft Container Service", + "resource": "Approve Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnectionsApproval/action", + "origin": "user,system" + }, + { + "display": { + "description": "Get private endpoint connection", + "operation": "Get private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/read", + "origin": "user,system" + }, + { + "display": { + "description": "Approve or Reject a private endpoint connection", + "operation": "Update private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete private endpoint connection", + "operation": "Delete private endpoint connection", + "provider": "Microsoft Container Service", + "resource": "Private Endpoint Connections" + }, + "name": "Microsoft.ContainerService/managedClusters/privateEndpointConnections/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets an extension addon", + "operation": "Get an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/read", + "origin": "system" + }, + { + "display": { + "description": "Creates a new extension addon or updates an existing one", + "operation": "Create or Update extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/write", + "origin": "system" + }, + { + "display": { + "description": "Deletes an extension addon", + "operation": "Delete an extension addon", + "provider": "Microsoft Container Service", + "resource": "ExtensionAddons" + }, + "name": "Microsoft.ContainerService/managedClusters/extensionaddons/delete", + "origin": "system" + }, + { + "display": { + "description": "Get a snapshot", + "operation": "Get Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new snapshot", + "operation": "Create Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes a snapshot", + "operation": "Delete Snapshot", + "provider": "Microsoft Container Service", + "resource": "Snapshots" + }, + "name": "Microsoft.ContainerService/snapshots/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get eventgrid filter", + "operation": "Get eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/read", + "origin": "system" + }, + { + "display": { + "description": "Create or Update eventgrid filter", + "operation": "Create or Update eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/write", + "origin": "system" + }, + { + "display": { + "description": "Delete an eventgrid filter", + "operation": "Delete an eventgrid filter", + "provider": "Microsoft Container Service", + "resource": "EventGridFilters" + }, + "name": "Microsoft.ContainerService/managedClusters/eventGridFilters/delete", + "origin": "system" + }, + { + "display": { + "description": "Reads initializerconfigurations", + "operation": "Gets/List initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes initializerconfigurations", + "operation": "Creates/Updates initializerconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes/DeletesCollection initializerconfigurations resource", + "operation": "Initializerconfigurations", + "provider": "Microsoft Container Service", + "resource": "Initializerconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/initializerconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads mutatingwebhookconfigurations", + "operation": "Gets/List mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes mutatingwebhookconfigurations", + "operation": "Creates/Updates mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes mutatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection mutatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Mutatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/mutatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads validatingwebhookconfigurations", + "operation": "Gets/List validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes validatingwebhookconfigurations", + "operation": "Creates/Updates validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes validatingwebhookconfigurations", + "operation": "Deletes/DeletesCollection validatingwebhookconfigurations resource", + "provider": "Microsoft Container Service", + "resource": "Validatingwebhookconfigurations" + }, + "name": "Microsoft.ContainerService/managedClusters/admissionregistration.k8s.io/validatingwebhookconfigurations/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads customresourcedefinitions", + "operation": "Gets/List customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes customresourcedefinitions", + "operation": "Creates/Updates customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes customresourcedefinitions", + "operation": "Deletes/DeletesCollection customresourcedefinitions resource", + "provider": "Microsoft Container Service", + "resource": "Customresourcedefinitions" + }, + "name": "Microsoft.ContainerService/managedClusters/apiextensions.k8s.io/customresourcedefinitions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservices", + "operation": "Gets/List apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes apiservices", + "operation": "Creates/Updates apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes apiservices", + "operation": "Deletes/DeletesCollection apiservices resource", + "provider": "Microsoft Container Service", + "resource": "Apiservices" + }, + "name": "Microsoft.ContainerService/managedClusters/apiregistration.k8s.io/apiservices/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads controllerrevisions", + "operation": "Gets/List controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes controllerrevisions", + "operation": "Creates/Updates controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes controllerrevisions", + "operation": "Deletes/DeletesCollection controllerrevisions resource", + "provider": "Microsoft Container Service", + "resource": "Controllerrevisions" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/controllerrevisions/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads statefulsets", + "operation": "Gets/List statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes statefulsets", + "operation": "Creates/Updates statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes statefulsets", + "operation": "Deletes/DeletesCollection statefulsets resource", + "provider": "Microsoft Container Service", + "resource": "Statefulsets" + }, + "name": "Microsoft.ContainerService/managedClusters/apps/statefulsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes tokenreviews", + "operation": "Creates/Updates tokenreviews resource", + "provider": "Microsoft Container Service", + "resource": "Tokenreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/tokenreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes localsubjectaccessreviews", + "operation": "Creates/Updates localsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Localsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/localsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectaccessreviews", + "operation": "Creates/Updates selfsubjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes selfsubjectrulesreviews", + "operation": "Creates/Updates selfsubjectrulesreviews resource", + "provider": "Microsoft Container Service", + "resource": "Selfsubjectrulesreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/selfsubjectrulesreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Writes subjectaccessreviews", + "operation": "Creates/Updates subjectaccessreviews resource", + "provider": "Microsoft Container Service", + "resource": "Subjectaccessreviews" + }, + "name": "Microsoft.ContainerService/managedClusters/authorization.k8s.io/subjectaccessreviews/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads horizontalpodautoscalers", + "operation": "Gets/List horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes horizontalpodautoscalers", + "operation": "Creates/Updates horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes horizontalpodautoscalers", + "operation": "Deletes/DeletesCollection horizontalpodautoscalers resource", + "provider": "Microsoft Container Service", + "resource": "Horizontalpodautoscalers" + }, + "name": "Microsoft.ContainerService/managedClusters/autoscaling/horizontalpodautoscalers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads cronjobs", + "operation": "Gets/List cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes cronjobs", + "operation": "Creates/Updates cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes cronjobs", + "operation": "Deletes/DeletesCollection cronjobs resource", + "provider": "Microsoft Container Service", + "resource": "Cronjobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/cronjobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads jobs", + "operation": "Gets/List jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes jobs", + "operation": "Creates/Updates jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes jobs", + "operation": "Deletes/DeletesCollection jobs resource", + "provider": "Microsoft Container Service", + "resource": "Jobs" + }, + "name": "Microsoft.ContainerService/managedClusters/batch/jobs/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificatesigningrequests", + "operation": "Gets/List certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes certificatesigningrequests", + "operation": "Creates/Updates certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes certificatesigningrequests", + "operation": "Deletes/DeletesCollection certificatesigningrequests resource", + "provider": "Microsoft Container Service", + "resource": "Certificatesigningrequests" + }, + "name": "Microsoft.ContainerService/managedClusters/certificates.k8s.io/certificatesigningrequests/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads leases", + "operation": "Gets/List leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes leases", + "operation": "Creates/Updates leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes leases", + "operation": "Deletes/DeletesCollection leases resource", + "provider": "Microsoft Container Service", + "resource": "Leases" + }, + "name": "Microsoft.ContainerService/managedClusters/coordination.k8s.io/leases/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Writes bindings", + "operation": "Creates/Updates bindings resource", + "provider": "Microsoft Container Service", + "resource": "Bindings" + }, + "name": "Microsoft.ContainerService/managedClusters/bindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Reads componentstatuses", + "operation": "Gets/List componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes componentstatuses", + "operation": "Creates/Updates componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes componentstatuses", + "operation": "Deletes/DeletesCollection componentstatuses resource", + "provider": "Microsoft Container Service", + "resource": "Componentstatuses" + }, + "name": "Microsoft.ContainerService/managedClusters/componentstatuses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads configmaps", + "operation": "Gets/List configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes configmaps", + "operation": "Creates/Updates configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes configmaps", + "operation": "Deletes/DeletesCollection configmaps resource", + "provider": "Microsoft Container Service", + "resource": "Configmaps" + }, + "name": "Microsoft.ContainerService/managedClusters/configmaps/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads endpoints", + "operation": "Gets/List endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes endpoints", + "operation": "Creates/Updates endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes endpoints", + "operation": "Deletes/DeletesCollection endpoints resource", + "provider": "Microsoft Container Service", + "resource": "Endpoints" + }, + "name": "Microsoft.ContainerService/managedClusters/endpoints/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads limitranges", + "operation": "Gets/List limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes limitranges", + "operation": "Creates/Updates limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes limitranges", + "operation": "Deletes/DeletesCollection limitranges resource", + "provider": "Microsoft Container Service", + "resource": "Limitranges" + }, + "name": "Microsoft.ContainerService/managedClusters/limitranges/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads namespaces", + "operation": "Gets/List namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes namespaces", + "operation": "Creates/Updates namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes namespaces", + "operation": "Deletes/DeletesCollection namespaces resource", + "provider": "Microsoft Container Service", + "resource": "Namespaces" + }, + "name": "Microsoft.ContainerService/managedClusters/namespaces/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes nodes", + "operation": "Creates/Updates nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes nodes", + "operation": "Deletes/DeletesCollection nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/nodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumeclaims", + "operation": "Gets/List persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumeclaims", + "operation": "Creates/Updates persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumeclaims", + "operation": "Deletes/DeletesCollection persistentvolumeclaims resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumeclaims" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumeclaims/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads persistentvolumes", + "operation": "Gets/List persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes persistentvolumes", + "operation": "Creates/Updates persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes persistentvolumes", + "operation": "Deletes/DeletesCollection persistentvolumes resource", + "provider": "Microsoft Container Service", + "resource": "Persistentvolumes" + }, + "name": "Microsoft.ContainerService/managedClusters/persistentvolumes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes pods", + "operation": "Creates/Updates pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes pods", + "operation": "Deletes/DeletesCollection pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Exec into pods resource", + "operation": "Exec into pods resource ", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/pods/exec/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podtemplates", + "operation": "Gets/List podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podtemplates", + "operation": "Creates/Updates podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podtemplates", + "operation": "Deletes/DeletesCollection podtemplates resource", + "provider": "Microsoft Container Service", + "resource": "Podtemplates" + }, + "name": "Microsoft.ContainerService/managedClusters/podtemplates/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicationcontrollers", + "operation": "Gets/List replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicationcontrollers", + "operation": "Creates/Updates replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicationcontrollers", + "operation": "Deletes/DeletesCollection replicationcontrollers resource", + "provider": "Microsoft Container Service", + "resource": "Replicationcontrollers" + }, + "name": "Microsoft.ContainerService/managedClusters/replicationcontrollers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resourcequotas", + "operation": "Gets/List resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes resourcequotas", + "operation": "Creates/Updates resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes resourcequotas", + "operation": "Deletes/DeletesCollection resourcequotas resource", + "provider": "Microsoft Container Service", + "resource": "Resourcequotas" + }, + "name": "Microsoft.ContainerService/managedClusters/resourcequotas/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads secrets", + "operation": "Gets/List secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes secrets", + "operation": "Creates/Updates secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes secrets", + "operation": "Deletes/DeletesCollection secrets resource", + "provider": "Microsoft Container Service", + "resource": "Secrets" + }, + "name": "Microsoft.ContainerService/managedClusters/secrets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads serviceaccounts", + "operation": "Gets/List serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes serviceaccounts", + "operation": "Creates/Updates serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes serviceaccounts", + "operation": "Deletes/DeletesCollection serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads services", + "operation": "Gets/List services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes services", + "operation": "Creates/Updates services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes services", + "operation": "Deletes/DeletesCollection services resource", + "provider": "Microsoft Container Service", + "resource": "Services" + }, + "name": "Microsoft.ContainerService/managedClusters/services/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events", + "operation": "Gets/List events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes events", + "operation": "Creates/Updates events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes events", + "operation": "Deletes/DeletesCollection events resource", + "provider": "Microsoft Container Service", + "resource": "Events" + }, + "name": "Microsoft.ContainerService/managedClusters/events.k8s.io/events/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads daemonsets", + "operation": "Gets/List daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes daemonsets", + "operation": "Creates/Updates daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes daemonsets", + "operation": "Deletes/DeletesCollection daemonsets resource", + "provider": "Microsoft Container Service", + "resource": "Daemonsets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/daemonsets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads deployments", + "operation": "Gets/List deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes deployments", + "operation": "Creates/Updates deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes deployments", + "operation": "Deletes/DeletesCollection deployments resource", + "provider": "Microsoft Container Service", + "resource": "Deployments" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/deployments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads replicasets", + "operation": "Gets/List replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes replicasets", + "operation": "Creates/Updates replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes replicasets", + "operation": "Deletes/DeletesCollection replicasets resource", + "provider": "Microsoft Container Service", + "resource": "Replicasets" + }, + "name": "Microsoft.ContainerService/managedClusters/extensions/replicasets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads pods", + "operation": "Gets/List pods resource", + "provider": "Microsoft Container Service", + "resource": "Pods" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/pods/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads nodes", + "operation": "Gets/List nodes resource", + "provider": "Microsoft Container Service", + "resource": "Nodes" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics.k8s.io/nodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networkpolicies", + "operation": "Gets/List networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes networkpolicies", + "operation": "Creates/Updates networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes networkpolicies", + "operation": "Deletes/DeletesCollection networkpolicies resource", + "provider": "Microsoft Container Service", + "resource": "Networkpolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/networkpolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ingresses", + "operation": "Gets/List ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes ingresses", + "operation": "Creates/Updates ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes ingresses", + "operation": "Deletes/DeletesCollection ingresses resource", + "provider": "Microsoft Container Service", + "resource": "Ingresses" + }, + "name": "Microsoft.ContainerService/managedClusters/networking.k8s.io/ingresses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads runtimeclasses", + "operation": "Gets/List runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes runtimeclasses", + "operation": "Creates/Updates runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes runtimeclasses", + "operation": "Deletes/DeletesCollection runtimeclasses resource", + "provider": "Microsoft Container Service", + "resource": "Runtimeclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/node.k8s.io/runtimeclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api", + "operation": "Gets/List api resource", + "provider": "Microsoft Container Service", + "resource": "Api" + }, + "name": "Microsoft.ContainerService/managedClusters/api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads api/v1", + "operation": "Gets/List api/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Api/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/api/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apis", + "operation": "Gets/List apis resource", + "provider": "Microsoft Container Service", + "resource": "Apis" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io", + "operation": "Gets/List admissionregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1", + "operation": "Gets/List admissionregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads admissionregistration.k8s.io/v1beta1", + "operation": "Gets/List admissionregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Admissionregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/admissionregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io", + "operation": "Gets/List apiextensions.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1", + "operation": "Gets/List apiextensions.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiextensions.k8s.io/v1beta1", + "operation": "Gets/List apiextensions.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiextensions.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiextensions.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io", + "operation": "Gets/List apiregistration.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1", + "operation": "Gets/List apiregistration.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiregistration.k8s.io/v1beta1", + "operation": "Gets/List apiregistration.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apiregistration.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apiregistration.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps", + "operation": "Gets/List apps resource", + "provider": "Microsoft Container Service", + "resource": "Apps" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1", + "operation": "Gets/List apps/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta1", + "operation": "Gets/List apps/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apps/v1beta2", + "operation": "Gets/List apps/v1beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Apps/V1beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/apps/v1beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io", + "operation": "Gets/List authentication.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1", + "operation": "Gets/List authentication.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authentication.k8s.io/v1beta1", + "operation": "Gets/List authentication.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authentication.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authentication.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io", + "operation": "Gets/List authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1", + "operation": "Gets/List authorization.k8s.io/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads authorization.k8s.io/v1beta1", + "operation": "Gets/List authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling", + "operation": "Gets/List autoscaling resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v1", + "operation": "Gets/List autoscaling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta1", + "operation": "Gets/List autoscaling/v2beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoscaling/v2beta2", + "operation": "Gets/List autoscaling/v2beta2 resource", + "provider": "Microsoft Container Service", + "resource": "Autoscaling/V2beta2" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/autoscaling/v2beta2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch", + "operation": "Gets/List batch resource", + "provider": "Microsoft Container Service", + "resource": "Batch" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1", + "operation": "Gets/List batch/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads batch/v1beta1", + "operation": "Gets/List batch/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Batch/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/batch/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io", + "operation": "Gets/List certificates.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads certificates.k8s.io/v1beta1", + "operation": "Gets/List certificates.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Certificates.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/certificates.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io", + "operation": "Gets/List coordination.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination/v1", + "operation": "Gets/List coordination/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads coordination.k8s.io/v1beta1", + "operation": "Gets/List coordination.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Coordination.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/coordination.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io", + "operation": "Gets/List events.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads events.k8s.io/v1beta1", + "operation": "Gets/List events.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Events.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/events.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions", + "operation": "Gets/List extensions resource", + "provider": "Microsoft Container Service", + "resource": "Extensions" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads extensions/v1beta1", + "operation": "Gets/List extensions/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Extensions/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/extensions/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io", + "operation": "Gets/List metrics.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics.k8s.io/v1beta1", + "operation": "Gets/List metrics.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Metrics.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/metrics.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io", + "operation": "Gets/List networking.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking/v1", + "operation": "Gets/List networking/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads networking.k8s.io/v1beta1", + "operation": "Gets/List networking.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Networking.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/networking.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io", + "operation": "Gets/List node.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads node.k8s.io/v1beta1", + "operation": "Gets/List node.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Node.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/node.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy", + "operation": "Gets/List policy resource", + "provider": "Microsoft Container Service", + "resource": "Policy" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads policy/v1beta1", + "operation": "Gets/List policy/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Policy/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/policy/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io", + "operation": "Gets/List rbac.authorization.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization/v1", + "operation": "Gets/List rbac.authorization/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rbac.authorization.k8s.io/v1beta1", + "operation": "Gets/List rbac.authorization.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Rbac.Authorization.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/rbac.authorization.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io", + "operation": "Gets/List scheduling.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling/v1", + "operation": "Gets/List scheduling/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads scheduling.k8s.io/v1beta1", + "operation": "Gets/List scheduling.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Scheduling.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/scheduling.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io", + "operation": "Gets/List storage.k8s.io resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage/v1", + "operation": "Gets/List storage/v1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storage.k8s.io/v1beta1", + "operation": "Gets/List storage.k8s.io/v1beta1 resource", + "provider": "Microsoft Container Service", + "resource": "Storage.K8s.Io/V1beta1" + }, + "name": "Microsoft.ContainerService/managedClusters/apis/storage.k8s.io/v1beta1/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads healthz", + "operation": "Gets/List healthz resource", + "provider": "Microsoft Container Service", + "resource": "Healthz" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Healthz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/healthz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads livez", + "operation": "Gets/List livez resource", + "provider": "Microsoft Container Service", + "resource": "Livez" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Livez/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/livez/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads logs", + "operation": "Gets/List logs resource", + "provider": "Microsoft Container Service", + "resource": "Logs" + }, + "name": "Microsoft.ContainerService/managedClusters/logs/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads metrics", + "operation": "Gets/List metrics resource", + "provider": "Microsoft Container Service", + "resource": "Metrics" + }, + "name": "Microsoft.ContainerService/managedClusters/metrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads v2", + "operation": "Gets/List v2 resource", + "provider": "Microsoft Container Service", + "resource": "Openapi/V2" + }, + "name": "Microsoft.ContainerService/managedClusters/openapi/v2/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads readyz", + "operation": "Gets/List readyz resource", + "provider": "Microsoft Container Service", + "resource": "Readyz" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads autoregister-completion", + "operation": "Gets/List autoregister-completion resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Autoregister-Completion" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/autoregister-completion/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads etcd", + "operation": "Gets/List etcd resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Etcd" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/etcd/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads log", + "operation": "Gets/List log resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Log" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/log/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ping", + "operation": "Gets/List ping resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Ping" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/ping/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-openapi-controller", + "operation": "Gets/List apiservice-openapi-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Openapi-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-openapi-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-registration-controller", + "operation": "Gets/List apiservice-registration-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Registration-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-registration-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads apiservice-status-available-controller", + "operation": "Gets/List apiservice-status-available-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Apiservice-Status-Available-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/apiservice-status-available-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-controller", + "operation": "Gets/List bootstrap-controller resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Controller" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/bootstrap-controller/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ca-registration", + "operation": "Gets/List ca-registration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Ca-Registration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/ca-registration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads crd-informer-synced", + "operation": "Gets/List crd-informer-synced resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Crd-Informer-Synced" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/crd-informer-synced/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads generic-apiserver-start-informers", + "operation": "Gets/List generic-apiserver-start-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Generic-Apiserver-Start-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/generic-apiserver-start-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads kube-apiserver-autoregistration", + "operation": "Gets/List kube-apiserver-autoregistration resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Kube-Apiserver-Autoregistration" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/kube-apiserver-autoregistration/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-roles", + "operation": "Gets/List bootstrap-roles resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/rbac/bootstrap-roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads bootstrap-system-priority-classes", + "operation": "Gets/List bootstrap-system-priority-classes resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Bootstrap-System-Priority-Classes" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/scheduling/bootstrap-system-priority-classes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-controllers", + "operation": "Gets/List start-apiextensions-controllers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Controllers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-controllers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-apiextensions-informers", + "operation": "Gets/List start-apiextensions-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Apiextensions-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-apiextensions-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-aggregator-informers", + "operation": "Gets/List start-kube-aggregator-informers resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Aggregator-Informers" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-aggregator-informers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads start-kube-apiserver-admission-initializer", + "operation": "Gets/List start-kube-apiserver-admission-initializer resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Poststarthook/Start-Kube-Apiserver-Admission-Initializer" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/poststarthook/start-kube-apiserver-admission-initializer/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads shutdown", + "operation": "Gets/List shutdown resource", + "provider": "Microsoft Container Service", + "resource": "Readyz/Shutdown" + }, + "name": "Microsoft.ContainerService/managedClusters/readyz/shutdown/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads resetMetrics", + "operation": "Gets/List resetMetrics resource", + "provider": "Microsoft Container Service", + "resource": "Resetmetrics" + }, + "name": "Microsoft.ContainerService/managedClusters/resetMetrics/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-ui", + "operation": "Gets/List swagger-ui resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads swagger-api", + "operation": "Gets/List swagger-api resource", + "provider": "Microsoft Container Service", + "resource": "Swagger-Api" + }, + "name": "Microsoft.ContainerService/managedClusters/swagger-api/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads ui", + "operation": "Gets/List ui resource", + "provider": "Microsoft Container Service", + "resource": "Ui" + }, + "name": "Microsoft.ContainerService/managedClusters/ui/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads version", + "operation": "Gets/List version resource", + "provider": "Microsoft Container Service", + "resource": "Version" + }, + "name": "Microsoft.ContainerService/managedClusters/version/read", + "origin": "user,system" + }, + { + "display": { + "description": "Reads poddisruptionbudgets", + "operation": "Gets/List poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes poddisruptionbudgets", + "operation": "Creates/Updates poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes poddisruptionbudgets", + "operation": "Deletes/DeletesCollection poddisruptionbudgets resource", + "provider": "Microsoft Container Service", + "resource": "Poddisruptionbudgets" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/poddisruptionbudgets/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads podsecuritypolicies", + "operation": "Gets/List podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes podsecuritypolicies", + "operation": "Creates/Updates podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes podsecuritypolicies", + "operation": "Deletes/DeletesCollection podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterrolebindings", + "operation": "Gets/List clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterrolebindings", + "operation": "Creates/Updates clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterrolebindings", + "operation": "Deletes/DeletesCollection clusterrolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Clusterrolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterrolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads clusterroles", + "operation": "Gets/List clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes clusterroles", + "operation": "Creates/Updates clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes clusterroles", + "operation": "Deletes/DeletesCollection clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads rolebindings", + "operation": "Gets/List rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes rolebindings", + "operation": "Creates/Updates rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes rolebindings", + "operation": "Deletes/DeletesCollection rolebindings resource", + "provider": "Microsoft Container Service", + "resource": "Rolebindings" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/rolebindings/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads roles", + "operation": "Gets/List roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes roles", + "operation": "Creates/Updates roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes roles", + "operation": "Deletes/DeletesCollection roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads priorityclasses", + "operation": "Gets/List priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes priorityclasses", + "operation": "Creates/Updates priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes priorityclasses", + "operation": "Deletes/DeletesCollection priorityclasses resource", + "provider": "Microsoft Container Service", + "resource": "Priorityclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/scheduling.k8s.io/priorityclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Use action on podsecuritypolicies", + "operation": "Use podsecuritypolicies resource", + "provider": "Microsoft Container Service", + "resource": "Podsecuritypolicies" + }, + "name": "Microsoft.ContainerService/managedClusters/policy/podsecuritypolicies/use/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds clusterroles", + "operation": "Bind clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates", + "operation": "Escalate clusterroles resource", + "provider": "Microsoft Container Service", + "resource": "Clusterroles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/clusterroles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Binds roles", + "operation": "Bind roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/bind/action", + "origin": "user,system" + }, + { + "display": { + "description": "Escalates roles", + "operation": "Escalate roles resource", + "provider": "Microsoft Container Service", + "resource": "Roles" + }, + "name": "Microsoft.ContainerService/managedClusters/rbac.authorization.k8s.io/roles/escalate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate serviceaccounts", + "operation": "Impersonate serviceaccounts resource", + "provider": "Microsoft Container Service", + "resource": "Serviceaccounts" + }, + "name": "Microsoft.ContainerService/managedClusters/serviceaccounts/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate users", + "operation": "Impersonate users resource", + "provider": "Microsoft Container Service", + "resource": "Users" + }, + "name": "Microsoft.ContainerService/managedClusters/users/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate groups", + "operation": "Impersonate groups resource", + "provider": "Microsoft Container Service", + "resource": "Groups" + }, + "name": "Microsoft.ContainerService/managedClusters/groups/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Impersonate userextras", + "operation": "Impersonate userextras resource", + "provider": "Microsoft Container Service", + "resource": "Userextras" + }, + "name": "Microsoft.ContainerService/managedClusters/authentication.k8s.io/userextras/impersonate/action", + "origin": "user,system" + }, + { + "display": { + "description": "Reads storageclasses", + "operation": "Gets/List storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes storageclasses", + "operation": "Creates/Updates storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes storageclasses", + "operation": "Deletes/DeletesCollection storageclasses resource", + "provider": "Microsoft Container Service", + "resource": "Storageclasses" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/storageclasses/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads volumeattachments", + "operation": "Gets/List volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes volumeattachments", + "operation": "Creates/Updates volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes volumeattachments", + "operation": "Deletes/DeletesCollection volumeattachments resource", + "provider": "Microsoft Container Service", + "resource": "Volumeattachments" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/volumeattachments/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csidrivers", + "operation": "Gets/List csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csidrivers", + "operation": "Creates/Updates csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csidrivers", + "operation": "Deletes/DeletesCollection csidrivers resource", + "provider": "Microsoft Container Service", + "resource": "Csidrivers" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csidrivers/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Reads csinodes", + "operation": "Gets/List csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/read", + "origin": "user,system" + }, + { + "display": { + "description": "Writes csinodes", + "operation": "Creates/Updates csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/write", + "origin": "user,system" + }, + { + "display": { + "description": "Deletes csinodes", + "operation": "Deletes/DeletesCollection csinodes resource", + "provider": "Microsoft Container Service", + "resource": "Csinodes" + }, + "name": "Microsoft.ContainerService/managedClusters/storage.k8s.io/csinodes/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Gets the available metrics for Managed Cluster", + "operation": "Read Managed Cluster metric definitions", + "provider": "Microsoft Container Service", + "resource": "The metric definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/metricDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Gets the available logs for Managed Cluster", + "operation": "Read Managed Cluster log definitions", + "provider": "Microsoft Container Service", + "resource": "The log definition of Managed Cluster" + }, + "name": "Microsoft.ContainerService/managedClusters/providers/Microsoft.Insights/logDefinitions/read", + "origin": "system" + }, + { + "display": { + "description": "Get a Open Shift Managed Cluster", + "operation": "Get Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Managed Cluster or updates an existing one", + "operation": "Create or Update Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Managed Cluster", + "operation": "Delete Open Shift Managed Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Managed Cluster" + }, + "name": "Microsoft.ContainerService/openShiftManagedClusters/delete", + "origin": "user,system" + }, + { + "display": { + "description": "Get a Open Shift Cluster", + "operation": "Get Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/read", + "origin": "user,system" + }, + { + "display": { + "description": "Creates a new Open Shift Cluster or updates an existing one", + "operation": "Create or Update Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/write", + "origin": "user,system" + }, + { + "display": { + "description": "Delete a Open Shift Cluster", + "operation": "Delete Open Shift Cluster", + "provider": "Microsoft Container Service", + "resource": "Open Shift Cluster" + }, + "name": "Microsoft.ContainerService/openShiftClusters/delete", + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json new file mode 100644 index 000000000000..a80ee8792193 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/OutboundNetworkDependenciesEndpointsList.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "azure-resource-management", + "endpoints": [ + { + "domainName": "management.azure.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "images", + "endpoints": [ + { + "domainName": "mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.data.mcr.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https", + "description": "mcr cdn" + } + ] + } + ] + }, + { + "category": "artifacts", + "endpoints": [ + { + "domainName": "packages.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "acs-mirror.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "time-sync", + "endpoints": [ + { + "domainName": "ntp.ubuntu.com", + "endpointDetails": [ + { + "port": 123, + "protocol": "UDP" + } + ] + } + ] + }, + { + "category": "ubuntu-optional", + "endpoints": [ + { + "domainName": "security.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "azure.archive.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "changelogs.ubuntu.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "gpu", + "endpoints": [ + { + "domainName": "nvidia.github.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "us.download.nvidia.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "apt.dockerproject.org", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "windows", + "endpoints": [ + { + "domainName": "onegetcdn.azureedge.net", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "go.microsoft.com", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + }, + { + "domainName": "*.mp.microsoft.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "www.msftconnecttest.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + }, + { + "domainName": "ctldl.windowsupdate.com", + "endpointDetails": [ + { + "port": 80, + "protocol": "Http" + } + ] + } + ] + }, + { + "category": "apiserver", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 443, + "protocol": "Https" + } + ] + } + ] + }, + { + "category": "tunnel-classic", + "endpoints": [ + { + "domainName": "*.azmk8s.io", + "endpointDetails": [ + { + "port": 9000, + "protocol": "TCP" + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..2f159a9ab282 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..01d6b26fbab2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..356702a872d3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..a5c5be6630a1 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1", + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateLinkResourcesList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..cc057317a619 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/PrivateLinkResourcesList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "management", + "type": "Microsoft.ContainerService/managedClusters/privateLinkResources", + "groupId": "management", + "requiredMembers": [ + "management" + ], + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ResolvePrivateLinkServiceId.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ResolvePrivateLinkServiceId.json new file mode 100644 index 000000000000..605c863e259e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/ResolvePrivateLinkServiceId.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "name": "management" + } + }, + "responses": { + "200": { + "body": { + "privateLinkServiceID": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/plsName" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandRequest.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandRequest.json new file mode 100644 index 000000000000..46ecf626167a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "requestPayload": { + "command": "kubectl apply -f ns.yaml", + "context": "", + "clusterToken": "" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2025-09-02-preview" + } + }, + "200": { + "description": "to mitigate RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE", + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandResultFailed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandResultFailed.json new file mode 100644 index 000000000000..f83c96253cd0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandResultFailed.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2025-09-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "failed", + "reason": "ImagePullBackoff" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandResultSucceed.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandResultSucceed.json new file mode 100644 index 000000000000..6eb4ceae9724 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/RunCommandResultSucceed.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "commandId": "def7b3ea71bd4f7e9d226ddbc0f00ad9" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/commandResults/0e9872e6629349dc865e27ee6f8bab2d?api-version=2025-09-02-preview" + } + }, + "200": { + "body": { + "id": "def7b3ea71bd4f7e9d226ddbc0f00ad9", + "properties": { + "provisioningState": "succeeded", + "exitCode": 0, + "startedAt": "2021-02-17T00:28:20Z", + "finishedAt": "2021-02-17T00:28:33Z", + "logs": "namespace dummy created" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsCreate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsCreate.json new file mode 100644 index 000000000000..4191e00a6c29 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + }, + "201": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsDelete.json new file mode 100644 index 000000000000..dc85b98378b6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsGet.json new file mode 100644 index 000000000000..ab4be505ba15 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1" + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsList.json new file mode 100644 index 000000000000..8107d98a9973 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsListByResourceGroup.json new file mode 100644 index 000000000000..5606bc4d6e8f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsUpdateTags.json new file mode 100644 index 000000000000..9c78110fe9d4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/SnapshotsUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "snapshot1", + "parameters": { + "tags": { + "key2": "new-val2", + "key3": "val3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "snapshot1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/snapshots/snapshot1", + "type": "Microsoft.ContainerService/Snapshots", + "location": "westus", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-08-09T20:13:23.298420761Z" + }, + "properties": { + "creationData": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/cluster1/agentPools/pool0" + }, + "snapshotType": "NodePool", + "nodeImageVersion": "AKSUbuntu-1804gen2containerd-2021.09.11", + "kubernetesVersion": "1.20.5", + "osType": "Linux", + "osSku": "Ubuntu", + "vmSize": "Standard_D2s_v3", + "enableFIPS": false + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json new file mode 100644 index 000000000000..a006f8cc89e8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_CreateOrUpdate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1", + "trustedAccessRoleBinding": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_Delete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_Delete.json new file mode 100644 index 000000000000..d39a89895b54 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ContainerService/locations/eastus/operationresults/00000000-0000-0000-0000-000000000000?api-version=2017-08-31" + } + }, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_Get.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_Get.json new file mode 100644 index 000000000000..786c78a7a4b3 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "trustedAccessRoleBindingName": "binding1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_List.json new file mode 100644 index 000000000000..c6c43025af19 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoleBindings_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/trustedAccessRoleBindings/binding1", + "type": "Microsoft.ContainerService/managedClusters/trustedAccessRoleBindings", + "name": "binding1", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/b/providers/Microsoft.MachineLearningServices/workspaces/c", + "roles": [ + "Microsoft.MachineLearningServices/workspaces/reader", + "Microsoft.MachineLearningServices/workspaces/writer" + ] + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoles_List.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoles_List.json new file mode 100644 index 000000000000..eb9f656c49c2 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/examples/TrustedAccessRoles_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-09-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sourceResourceType": "Microsoft.MachineLearningServices/workspaces", + "name": "reader", + "rules": [ + { + "verbs": [ + "get" + ], + "apiGroups": [ + "" + ], + "resources": [ + "pods" + ], + "resourceNames": [], + "nonResourceURLs": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/managedClusters.json new file mode 100644 index 000000000000..c318a3da1c7f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/preview/2025-09-02-preview/managedClusters.json @@ -0,0 +1,13149 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2025-09-02-preview" + }, + "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.ContainerService/operations": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "Operations_List", + "summary": "Gets a list of operations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List available operations for the container service resource provider": { + "$ref": "./examples/Operation_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/kubernetesVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListKubernetesVersions", + "summary": "Gets a list of supported Kubernetes versions in the specified subscription.", + "description": "Contains extra metadata on the version, including supported patch versions, capabilities, available upgrades, and details on preview status of the version", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KubernetesVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Kubernetes Versions": { + "$ref": "./examples/KubernetesVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/nodeImageVersions": { + "get": { + "tags": [ + "ContainerService" + ], + "summary": "Gets a list of supported NodeImage versions in the specified subscription.", + "description": "Only returns the latest version of each node image. For example there may be an AKSUbuntu-1804gen2containerd-2024.01.26, but only AKSUbuntu-1804gen2containerd-2024.02.02 is visible in this list.", + "operationId": "ContainerService_ListNodeImageVersions", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NodeImageVersionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Node Image Versions": { + "$ref": "./examples/NodeImageVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets the upgrade profile of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Lists the admin credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Lists the user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + }, + { + "$ref": "#/parameters/CredentialFormatParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Lists the cluster monitoring user credentials of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ServerFqdnParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The managed cluster to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing managed cluster was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "The new managed cluster was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create/Update Managed Cluster with EnableNamespaceResources": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableNamespaceResources.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + }, + "Create Managed Cluster with OSSKU": { + "$ref": "./examples/ManagedClustersCreate_OSSKU.json" + }, + "Create Managed Cluster with GPUMIG": { + "$ref": "./examples/ManagedClustersCreate_GPUMIG.json" + }, + "Create/Update Managed Cluster with EnableAHUB": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithAHUB.json" + }, + "Create Managed Cluster with EncryptionAtHost enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableEncryptionAtHost.json" + }, + "Create Managed Cluster with UltraSSD enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableUltraSSD.json" + }, + "Create Managed Cluster with PodIdentity enabled": { + "$ref": "./examples/ManagedClustersCreate_PodIdentity.json" + }, + "Create Managed Private Cluster with fqdn subdomain specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterFQDNSubdomain.json" + }, + "Create Managed Private Cluster with Public FQDN specified": { + "$ref": "./examples/ManagedClustersCreate_PrivateClusterPublicFQDN.json" + }, + "Create Managed Cluster with RunCommand disabled": { + "$ref": "./examples/ManagedClustersCreate_DisableRunCommand.json" + }, + "Create Managed Cluster with LongTermSupport": { + "$ref": "./examples/ManagedClustersCreate_Premium.json" + }, + "Create Managed Cluster with Node Public IP Prefix": { + "$ref": "./examples/ManagedClustersCreate_NodePublicIPPrefix.json" + }, + "Create Managed Cluster with Azure Key Vault Secrets Provider Addon": { + "$ref": "./examples/ManagedClustersCreate_AzureKeyvaultSecretsProvider.json" + }, + "Create/Update Managed Cluster with Azure Service Mesh": { + "$ref": "./examples/ManagedClustersCreate_AzureServiceMesh.json" + }, + "Create Managed Cluster with FIPS enabled OS": { + "$ref": "./examples/ManagedClustersCreate_EnabledFIPS.json" + }, + "Create Managed Cluster with HTTP proxy configured": { + "$ref": "./examples/ManagedClustersCreate_HTTPProxy.json" + }, + "Create Managed Cluster with Security Profile configured": { + "$ref": "./examples/ManagedClustersCreate_SecurityProfile.json" + }, + "Create Managed Cluster with Web App Routing Ingress Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_WebAppRouting.json" + }, + "Create Managed Cluster with Application Load Balancer Profile configured": { + "$ref": "./examples/ManagedClustersCreate_IngressProfile_ApplicationLoadBalancer.json" + }, + "Create Managed Cluster with AKS-managed NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_ManagedNATGateway.json" + }, + "Create Managed Cluster with user-assigned NAT gateway as outbound type": { + "$ref": "./examples/ManagedClustersCreate_UserAssignedNATGateway.json" + }, + "Create Managed Cluster using an agent pool snapshot": { + "$ref": "./examples/ManagedClustersCreate_Snapshot.json" + }, + "Create Managed Cluster using a managed cluster snapshot": { + "$ref": "./examples/ManagedClustersCreate_MCSnapshot.json" + }, + "Create/Update Managed Cluster with Windows gMSA enabled": { + "$ref": "./examples/ManagedClustersCreate_UpdateWindowsGmsa.json" + }, + "Create/Update Managed Cluster with dual-stack networking": { + "$ref": "./examples/ManagedClustersCreate_DualStackNetworking.json" + }, + "Associate Managed Cluster with Capacity Reservation Group": { + "$ref": "./examples/ManagedClustersAssociate_CRG.json" + }, + "Create Managed Cluster with Dedicated Host Group": { + "$ref": "./examples/ManagedClustersCreate_DedicatedHostGroup.json" + }, + "Create Managed Cluster with CustomCATrustCertificates populated": { + "$ref": "./examples/ManagedClustersCreate_CustomCATrustCertificates.json" + }, + "Create Managed Cluster with VirtualMachines pool type": { + "$ref": "./examples/ManagedClustersCreate_VirtualMachines.json" + }, + "Create Managed Cluster with AI Toolchain Operator enabled": { + "$ref": "./examples/ManagedClustersCreate_EnableAIToolchainOperator.json" + }, + "Create Managed Cluster with Node Auto Provisioning": { + "$ref": "./examples/ManagedClustersCreate_NodeAutoProvisioning.json" + }, + "Create Managed Cluster with Advanced Networking Transit Encryption": { + "$ref": "./examples/AdvancedNetworkingTransitEncryption.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_ListByManagedCluster", + "summary": "Gets a list of maintenance configurations in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List maintenance configurations configured with maintenance window by Managed Cluster": { + "$ref": "./examples/MaintenanceConfigurationsList_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/maintenanceConfigurations/{configName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Get", + "summary": "Gets the specified maintenance configuration of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Maintenance Configuration Configured With Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsGet_MaintenanceWindow.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "summary": "Creates or updates a maintenance configuration in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The maintenance configuration to create or update." + } + ], + "responses": { + "200": { + "description": "The existing maintenance configuration was successfully updated.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "The new maintenance configuration was successfully created.", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create/Update Maintenance Configuration with Maintenance Window": { + "$ref": "./examples/MaintenanceConfigurationsCreate_Update_MaintenanceWindow.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "operationId": "MaintenanceConfigurations_Delete", + "summary": "Deletes a maintenance configuration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "configName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the maintenance configuration." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Delete Maintenance Configuration For Node OS Upgrade": { + "$ref": "./examples/MaintenanceConfigurationsDelete_MaintenanceWindow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/managedNamespaces": { + "get": { + "tags": [ + "ManagedNamespaces" + ], + "operationId": "ManagedNamespaces_ListByManagedCluster", + "summary": "Gets a list of managed namespaces in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedNamespaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List namespaces by Managed Cluster": { + "$ref": "./examples/ManagedNamespacesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/managedNamespaces/{managedNamespaceName}": { + "get": { + "tags": [ + "ManagedNamespaces" + ], + "operationId": "ManagedNamespaces_Get", + "summary": "Gets the specified namespace of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ManagedNamespaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedNamespace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Namespace": { + "$ref": "./examples/ManagedNamespacesGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedNamespaces" + ], + "operationId": "ManagedNamespaces_CreateOrUpdate", + "summary": "Creates or updates a namespace managed by ARM for the specified managed cluster. Users can configure aspects like resource quotas, network ingress/egress policies, and more. See aka.ms/aks/managed-namespaces for more details.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ManagedNamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedNamespace" + }, + "description": "The namespace to create or update." + } + ], + "responses": { + "200": { + "description": "The existing namespace was successfully updated.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedNamespace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "The new namespace was successfully created.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ManagedNamespace" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Namespace": { + "$ref": "./examples/ManagedNamespacesCreate_Update.json" + } + } + }, + "delete": { + "tags": [ + "ManagedNamespaces" + ], + "operationId": "ManagedNamespaces_Delete", + "summary": "Deletes a namespace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ManagedNamespaceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Namespace": { + "$ref": "./examples/ManagedNamespacesDelete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedNamespaces" + ], + "operationId": "ManagedNamespaces_Update", + "summary": "Updates tags on a managed namespace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ManagedNamespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the patch namespace operation, we only support patch tags for now." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedNamespace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Managed Namespace Tags": { + "$ref": "./examples/ManagedNamespacesUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/managedNamespaces/{managedNamespaceName}/listCredential": { + "post": { + "tags": [ + "ManagedNamespaces" + ], + "operationId": "ManagedNamespaces_ListCredential", + "summary": "Lists the credentials of a namespace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ManagedNamespaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List managed namespace credentials": { + "$ref": "./examples/ManagedNamespacesListCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/agentPools/{agentPoolName}/abort": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_AbortLatestOperation", + "summary": "Aborts last operation running on agent pool.", + "description": "Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on agent pool": { + "$ref": "./examples/AgentPoolsAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the specified managed cluster agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The agent pool to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing agent pool was successfully updated.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "The new agent pool was successfully created.", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + }, + "Create Agent Pool with OSSKU": { + "$ref": "./examples/AgentPoolsCreate_OSSKU.json" + }, + "Create Agent Pool with Windows OSSKU": { + "$ref": "./examples/AgentPoolsCreate_WindowsOSSKU.json" + }, + "Create Windows Agent Pool with disabling OutboundNAT": { + "$ref": "./examples/AgentPoolsCreate_WindowsDisableOutboundNAT.json" + }, + "Create Agent Pool with GPUMIG": { + "$ref": "./examples/AgentPoolsCreate_GPUMIG.json" + }, + "Create Agent Pool with Ephemeral OS Disk": { + "$ref": "./examples/AgentPoolsCreate_Ephemeral.json" + }, + "Create Agent Pool with KubeletConfig and LinuxOSConfig": { + "$ref": "./examples/AgentPoolsCreate_CustomNodeConfig.json" + }, + "Create Agent Pool with EncryptionAtHost enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableEncryptionAtHost.json" + }, + "Create Agent Pool with UltraSSD enabled": { + "$ref": "./examples/AgentPoolsCreate_EnableUltraSSD.json" + }, + "Create Agent Pool with FIPS enabled OS": { + "$ref": "./examples/AgentPoolsCreate_EnableFIPS.json" + }, + "Create Agent Pool using an agent pool snapshot": { + "$ref": "./examples/AgentPoolsCreate_Snapshot.json" + }, + "Create Agent Pool with Krustlet and the WASI runtime": { + "$ref": "./examples/AgentPoolsCreate_WasmWasi.json" + }, + "Create Agent Pool with Message of the Day": { + "$ref": "./examples/AgentPoolsCreate_MessageOfTheDay.json" + }, + "Stop Agent Pool": { + "$ref": "./examples/AgentPools_Stop.json" + }, + "Start Agent Pool": { + "$ref": "./examples/AgentPools_Start.json" + }, + "Associate Agent Pool with Capacity Reservation Group": { + "$ref": "./examples/AgentPoolsAssociate_CRG.json" + }, + "Create Agent Pool with Dedicated Host Group": { + "$ref": "./examples/AgentPoolsCreate_DedicatedHostGroup.json" + }, + "Create Agent Pool with VirtualMachines pool type": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines.json" + }, + "Create Agent Pool with VirtualMachines pool type with autoscaling enabled": { + "$ref": "./examples/AgentPoolsCreate_TypeVirtualMachines_Autoscale.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/IgnorePodDisruptionBudgetParameter" + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + }, + "Delete Agent Pool by ignoring PodDisruptionBudget": { + "$ref": "./examples/AgentPoolsDelete_IgnorePodDisruptionBudget.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets the upgrade profile for an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/completeUpgrade": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CompleteUpgrade", + "summary": "Completes the upgrade of an agent pool.", + "description": "Completes the upgrade operation for the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Complete agent pool upgrade": { + "$ref": "./examples/AgentPoolsCompleteUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/deleteMachines": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_DeleteMachines", + "summary": "Deletes specific machines in an agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "name": "machines", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPoolDeleteMachinesParameter" + }, + "description": "A list of machines from the agent pool to be deleted." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Specific Machines in an Agent Pool": { + "$ref": "./examples/AgentPoolsDeleteMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_List", + "summary": "Gets a list of machines in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Machines in an Agentpool by Managed Cluster": { + "$ref": "./examples/MachineList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/machines/{machineName}": { + "get": { + "tags": [ + "Machines" + ], + "operationId": "Machines_Get", + "summary": "Get a specific machine in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Machine in an Agent Pools by Managed Cluster": { + "$ref": "./examples/MachineGet.json" + } + } + }, + "put": { + "tags": [ + "Machines" + ], + "operationId": "Machines_CreateOrUpdate", + "summary": "Creates or updates a machine in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "#/parameters/MachineNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Machine" + }, + "description": "The machine to create or update." + }, + { + "name": "If-Match", + "in": "header", + "description": "The request should only proceed if an entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "The request should only proceed if no entity matches this string.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + } + ], + "responses": { + "200": { + "description": "The existing machine was successfully updated.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "201": { + "description": "The new machine was successfully created.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Machine": { + "$ref": "./examples/MachineCreate_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported Kubernetes versions for the specified agent pool.", + "description": "See [supported Kubernetes versions](https://docs.microsoft.com/azure/aks/supported-kubernetes-versions) for more details about the version lifecycle.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset the Service Principal Profile of a managed cluster.", + "description": "This action cannot be performed on a cluster that is not using a service principal", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "The service principal profile to set on the managed cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset the AAD Profile of a managed cluster.", + "description": "**WARNING**: This API will be deprecated. Please see [AKS-managed Azure Active Directory integration](https://aka.ms/aks-managed-aad) to update your cluster with AKS-managed Azure AD.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "The AAD profile to set on the Managed Cluster" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclusters/{resourceName}/abort": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_AbortLatestOperation", + "summary": "Aborts last operation running on managed cluster.", + "description": "Aborts the currently running operation on the managed cluster. The Managed Cluster will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, an error is returned.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Abort operation on managed cluster": { + "$ref": "./examples/ManagedClustersAbortOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotates the certificates of a managed cluster.", + "description": "See [Certificate rotation](https://docs.microsoft.com/azure/aks/certificate-rotation) for more details about rotating managed cluster certificates.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateServiceAccountSigningKeys": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateServiceAccountSigningKeys", + "summary": "Rotates the service account signing keys of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Rotate Cluster Service Account Signing Keys": { + "$ref": "./examples/ManagedClustersRotateServiceAccountSigningKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/stop": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Stop", + "summary": "Stops a Managed Cluster", + "description": "This can only be performed on Azure Virtual Machine Scale set backed clusters. Stopping a cluster stops the control plane and agent nodes entirely, while maintaining all object and cluster state. A cluster does not accrue charges while it is stopped. See [stopping a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about stopping a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Stop Managed Cluster": { + "$ref": "./examples/ManagedClustersStop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/start": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Start", + "summary": "Starts a previously stopped Managed Cluster", + "description": "See [starting a cluster](https://docs.microsoft.com/azure/aks/start-stop-cluster) for more details about starting a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Start Managed Cluster": { + "$ref": "./examples/ManagedClustersStart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the specified private endpoint connection.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The updated private endpoint connection." + } + ], + "responses": { + "200": { + "description": "The existing private endpoint connection was successfully updated.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The new private endpoint connection was successfully created.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeNodeImageVersion": { + "post": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_UpgradeNodeImageVersion", + "summary": "Upgrades the node image version of an agent pool to the latest.", + "description": "Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upgrade Agent Pool Node Image Version": { + "$ref": "./examples/AgentPoolsUpgradeNodeImageVersion.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "privateLinkResources" + ], + "operationId": "PrivateLinkResources_List", + "summary": "Gets a list of private link resources in the specified managed cluster.", + "description": "To learn more about private clusters, see: https://docs.microsoft.com/azure/aks/private-clusters", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Cluster": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resolvePrivateLinkServiceId": { + "post": { + "tags": [ + "resolvePrivateLinkServiceId" + ], + "operationId": "ResolvePrivateLinkServiceId_POST", + "summary": "Gets the private link service ID for the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Parameters required in order to resolve a private link service ID." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resolve the Private Link Service ID for Managed Cluster": { + "$ref": "./examples/ResolvePrivateLinkServiceId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/runCommand": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RunCommand", + "summary": "Submits a command to run against the Managed Cluster.", + "description": "AKS will create a pod to run the command. This is primarily useful for private clusters. For more information see [AKS Run Command](https://docs.microsoft.com/azure/aks/private-clusters#aks-run-command-preview).", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "requestPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandRequest" + }, + "description": "The run command request" + } + ], + "responses": { + "200": { + "description": "command finished with async pattern, tracking by location header. !!! this is for autorest only, you never get 200 from this api !!!", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "submitNewCommand": { + "$ref": "./examples/RunCommandRequest.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/commandResults/{commandId}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetCommandResult", + "summary": "Gets the results of a command which has been run on the Managed Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "Id of the command." + } + ], + "responses": { + "200": { + "description": "command finished", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "command running in progress", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "commandSucceedResult": { + "$ref": "./examples/RunCommandResultSucceed.json" + }, + "commandFailedResult": { + "$ref": "./examples/RunCommandResultFailed.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/outboundNetworkDependenciesEndpoints": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListOutboundNetworkDependenciesEndpoints", + "summary": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster.", + "description": "Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified managed cluster. The operation returns properties of each egress endpoint.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List OutboundNetworkDependenciesEndpoints by Managed Cluster": { + "$ref": "./examples/OutboundNetworkDependenciesEndpointsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_List", + "summary": "Gets a list of operations in the specified managedCluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatusResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List of OperationStatusResult": { + "$ref": "./examples/OperationStatusResultList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_Get", + "summary": "Get the status of a specific operation in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/operations/{operationId}": { + "get": { + "tags": [ + "OperationStatusResult" + ], + "operationId": "OperationStatusResult_GetByAgentPool", + "summary": "Get the status of a specific operation in the specified agent pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/AgentPoolNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatusResult": { + "$ref": "./examples/OperationStatusResultGetByAgentPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Gets a list of snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots": { + "$ref": "./examples/SnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "summary": "Lists snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Snapshots by Resource Group": { + "$ref": "./examples/SnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/snapshots/{resourceName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Gets a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Snapshot": { + "$ref": "./examples/SnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "summary": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "201": { + "description": "The new snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create/Update Snapshot": { + "$ref": "./examples/SnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_UpdateTags", + "summary": "Updates tags on a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Snapshot Tags": { + "$ref": "./examples/SnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Snapshot": { + "$ref": "./examples/SnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_List", + "summary": "Gets a list of managed cluster snapshots in the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots": { + "$ref": "./examples/ManagedClusterSnapshotsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_ListByResourceGroup", + "summary": "Lists managed cluster snapshots in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshotListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Cluster Snapshots by Resource Group": { + "$ref": "./examples/ManagedClusterSnapshotsListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedclustersnapshots/{resourceName}": { + "get": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Get", + "summary": "Gets a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_CreateOrUpdate", + "summary": "Creates or updates a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The managed cluster snapshot to create or update." + } + ], + "responses": { + "200": { + "description": "The existing managed cluster snapshot was successfully updated.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "201": { + "description": "The new managed cluster snapshot was successfully created.", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create/Update Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsCreate.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_UpdateTags", + "summary": "Updates tags on a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update managed cluster snapshot Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterSnapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Managed Cluster Snapshot Tags": { + "$ref": "./examples/ManagedClusterSnapshotsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusterSnapshots" + ], + "operationId": "ManagedClusterSnapshots_Delete", + "summary": "Deletes a managed cluster snapshot.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Managed Cluster Snapshot": { + "$ref": "./examples/ManagedClusterSnapshotsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/trustedAccessRoles": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoles_List", + "summary": "List supported trusted access roles.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access roles": { + "$ref": "./examples/TrustedAccessRoles_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_List", + "summary": "List trusted access role bindings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBindingListResult" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List trusted access role bindings": { + "$ref": "./examples/TrustedAccessRoleBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/trustedAccessRoleBindings/{trustedAccessRoleBindingName}": { + "get": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Get", + "summary": "Get a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_CreateOrUpdate", + "summary": "Create or update a trusted access role binding", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + }, + { + "name": "trustedAccessRoleBinding", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "A trusted access role binding" + } + ], + "responses": { + "200": { + "description": "The existing trusted access role binding was successfully updated.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "201": { + "description": "The new trusted access role binding was successfully created.", + "schema": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + } + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "TrustedAccess" + ], + "operationId": "TrustedAccessRoleBindings_Delete", + "summary": "Delete a trusted access role binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/TrustedAccessRoleBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error details", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a trusted access role binding": { + "$ref": "./examples/TrustedAccessRoleBindings_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetGuardrailsVersions", + "summary": "Gets supported Guardrails version in the specified subscription and location.", + "description": "Contains Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get guardrails available versions": { + "$ref": "./examples/GetGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/guardrailsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListGuardrailsVersions", + "summary": "Gets a list of supported Guardrails versions in the specified subscription and location.", + "description": "Contains list of Guardrails version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuardrailsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Guardrails Versions": { + "$ref": "./examples/ListGuardrailsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions/{version}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetSafeguardsVersions", + "summary": "Gets supported Safeguards version in the specified subscription and location.", + "description": "Contains Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/VersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Safeguards available versions": { + "$ref": "./examples/GetSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/safeguardsVersions": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListSafeguardsVersions", + "summary": "Gets a list of supported Safeguards versions in the specified subscription and location.", + "description": "Contains list of Safeguards version along with its support info and whether it is a default version.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SafeguardsAvailableVersionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Safeguards Versions": { + "$ref": "./examples/ListSafeguardsVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshRevisionProfiles", + "summary": "Lists mesh revision profiles for all meshes in the specified location.", + "description": "Contains extra metadata on each revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List mesh revision profiles in a location": { + "$ref": "./examples/ManagedClustersList_MeshRevisionProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/locations/{location}/meshRevisionProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshRevisionProfile", + "summary": "Gets a mesh revision profile for a specified mesh in the specified location.", + "description": "Contains extra metadata on the revision, including supported revisions, cluster compatibility and available upgrades", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshRevisionProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a mesh revision profile for a mesh mode": { + "$ref": "./examples/ManagedClustersGet_MeshRevisionProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListMeshUpgradeProfiles", + "summary": "Lists available upgrades for all service meshes in a specific cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfileList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists version compatibility and upgrade profile for all service meshes in a cluster": { + "$ref": "./examples/ManagedClustersList_MeshUpgradeProfiles.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshUpgradeProfiles/{mode}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetMeshUpgradeProfile", + "summary": "Gets available upgrades for a service mesh in a cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshModeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets version compatibility and upgrade profile for a service mesh in a cluster": { + "$ref": "./examples/ManagedClustersGet_MeshUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_ListByManagedCluster", + "summary": "Gets a list of load balancers in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Load Balancers by Managed Cluster": { + "$ref": "./examples/LoadBalancers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rebalanceLoadBalancers": { + "post": { + "tags": [ + "LoadBalancers" + ], + "operationId": "ManagedClusters_RebalanceLoadBalancers", + "summary": "Rebalance nodes across specific load balancers.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RebalanceLoadBalancersRequestBody" + }, + "description": "The names of the load balancers to be rebalanced. If set to empty, all load balancers will be rebalanced." + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/LoadBalancers_Rebalance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/loadBalancers/{loadBalancerName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Get", + "summary": "Gets the specified load balancer.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Load Balancer": { + "$ref": "./examples/LoadBalancers_Get.json" + } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_CreateOrUpdate", + "summary": "Creates or updates a load balancer in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "The load balancer to create or update." + } + ], + "responses": { + "200": { + "description": "The existing load balancer has been successfully updated", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "201": { + "description": "The new load balancer has been successfully created", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update a Load Balancer": { + "$ref": "./examples/LoadBalancers_Create_Or_Update.json" + } + } + }, + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Delete", + "summary": "Deletes a load balancer in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/LoadBalancerNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a Load Balancer": { + "$ref": "./examples/LoadBalancers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/identityBindings": { + "get": { + "tags": [ + "IdentityBindings" + ], + "operationId": "IdentityBindings_ListByManagedCluster", + "summary": "Gets a list of identity bindings in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IdentityBindingListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Identity Bindings by Managed Cluster": { + "$ref": "./examples/IdentityBindings_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/identityBindings/{identityBindingName}": { + "get": { + "tags": [ + "IdentityBindings" + ], + "operationId": "IdentityBindings_Get", + "summary": "Gets the specified Identity Binding.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/IdentityBindingNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IdentityBinding" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Binding": { + "$ref": "./examples/IdentityBindings_Get.json" + } + } + }, + "put": { + "tags": [ + "IdentityBindings" + ], + "operationId": "IdentityBindings_CreateOrUpdate", + "summary": "Creates or updates an identity binding in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/IdentityBindingNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentityBinding" + }, + "description": "The identity binding to create or update." + } + ], + "responses": { + "200": { + "description": "The existing identity binding has been successfully updated", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/IdentityBinding" + } + }, + "201": { + "description": "The new identity binding has been successfully created", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/IdentityBinding" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update Identity Binding": { + "$ref": "./examples/IdentityBindings_Create_Or_Update.json" + } + } + }, + "delete": { + "tags": [ + "IdentityBindings" + ], + "operationId": "IdentityBindings_Delete", + "summary": "Deletes an identity binding in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/IdentityBindingNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Identity Binding": { + "$ref": "./examples/IdentityBindings_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/jwtAuthenticators": { + "get": { + "tags": [ + "JWTAuthenticators" + ], + "operationId": "JWTAuthenticators_ListByManagedCluster", + "summary": "Gets a list of JWT authenticators in the specified managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JWTAuthenticatorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List JWT authenticators by Managed Cluster": { + "$ref": "./examples/JWTAuthenticators_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/jwtAuthenticators/{jwtAuthenticatorName}": { + "get": { + "tags": [ + "JWTAuthenticators" + ], + "operationId": "JWTAuthenticators_Get", + "summary": "Gets the specified JWT authenticator of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/JWTAuthenticatorNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JWTAuthenticator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get JWT Authenticator": { + "$ref": "./examples/JWTAuthenticators_Get.json" + } + } + }, + "put": { + "tags": [ + "JWTAuthenticators" + ], + "operationId": "JWTAuthenticators_CreateOrUpdate", + "summary": "Creates or updates JWT authenticator in the managed cluster and updates the managed cluster to apply the settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/JWTAuthenticatorNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JWTAuthenticator" + }, + "description": "The JWT authenticator to create or update." + } + ], + "responses": { + "200": { + "description": "The existing JWT authenticator was successfully updated.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/JWTAuthenticator" + } + }, + "201": { + "description": "The new JWT authenticator was successfully created.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/JWTAuthenticator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create or update JWT Authenticator": { + "$ref": "./examples/JWTAuthenticators_Create_Or_Update.json" + } + } + }, + "delete": { + "tags": [ + "JWTAuthenticators" + ], + "operationId": "JWTAuthenticators_Delete", + "summary": "Deletes a JWT authenticator and updates the managed cluster to apply the settings.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/JWTAuthenticatorNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete JWT Authenticator": { + "$ref": "./examples/JWTAuthenticators_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshMemberships": { + "get": { + "tags": [ + "MeshMemberships" + ], + "operationId": "MeshMemberships_ListByManagedCluster", + "summary": "Lists mesh memberships in a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshMembershipsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Mesh Memberships by Managed Cluster": { + "$ref": "./examples/MeshMemberships_ListByManagedCluster.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/meshMemberships/{meshMembershipName}": { + "get": { + "tags": [ + "MeshMemberships" + ], + "operationId": "MeshMemberships_Get", + "summary": "Gets the mesh membership of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshMembershipNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeshMembership" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Mesh Membership": { + "$ref": "./examples/MeshMemberships_Get.json" + } + } + }, + "put": { + "tags": [ + "MeshMemberships" + ], + "operationId": "MeshMemberships_CreateOrUpdate", + "summary": "Creates or updates the mesh membership of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshMembershipNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MeshMembership" + }, + "description": "The mesh membership to create or update." + } + ], + "responses": { + "200": { + "description": "The existing mesh membership was successfully updated.", + "schema": { + "$ref": "#/definitions/MeshMembership" + } + }, + "201": { + "description": "The new mesh membership was successfully created.", + "schema": { + "$ref": "#/definitions/MeshMembership" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update Mesh Membership": { + "$ref": "./examples/MeshMemberships_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "MeshMemberships" + ], + "operationId": "MeshMemberships_Delete", + "summary": "Deletes the mesh membership of a managed cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/MeshMembershipNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Mesh Membership": { + "$ref": "./examples/MeshMemberships_Delete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "x-ms-identifiers": [], + "description": "The list of operations" + } + }, + "description": "The List Operation response." + }, + "OperationValue": { + "type": "object", + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Operation Value Display." + } + }, + "description": "Describes the properties of a Operation value." + }, + "OperationValueDisplay": { + "type": "object", + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the 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 Operation Value Display." + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 2048, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ManagedClusterServicePrincipalProfile": { + "type": "object", + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "VirtualMachinesProfile": { + "type": "object", + "properties": { + "scale": { + "$ref": "#/definitions/ScaleProfile", + "description": "Specifications on how to scale a VirtualMachines agent pool." + } + }, + "description": "Specifications on VirtualMachines agent pool." + }, + "ScaleProfile": { + "type": "object", + "properties": { + "manual": { + "type": "array", + "items": { + "$ref": "#/definitions/ManualScaleProfile" + }, + "x-ms-identifiers": [], + "description": "Specifications on how to scale the VirtualMachines agent pool to a fixed size." + }, + "autoscale": { + "$ref": "#/definitions/AutoScaleProfile", + "description": "Specifications on how to auto-scale the VirtualMachines agent pool within a predefined size range." + } + }, + "description": "Specifications on how to scale a VirtualMachines agent pool." + }, + "ManualScaleProfile": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Specifications on number of machines." + }, + "AutoScaleProfile": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'." + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes of the specified sizes." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes of the specified sizes." + } + }, + "description": "Specifications on auto-scaling." + }, + "VirtualMachineNodesStatus": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineNodes" + }, + "x-ms-identifiers": [], + "description": "The status of nodes in a VirtualMachines agent pool." + }, + "VirtualMachineNodes": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "The VM size of the agents used to host this group of nodes." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of nodes." + } + }, + "description": "Current status on a group of nodes of the same vm size." + }, + "ManagedClusterAgentPoolProfileProperties": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "type": "string", + "description": "The size of the agent pool VMs. VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "messageOfTheDay": { + "type": "string", + "description": "Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)." + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "The ID of the subnet which agent pool nodes and optionally pods will join on startup. If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "The ID of the subnet which pods will join when launched. If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podIPAllocationMode": { + "$ref": "#/definitions/PodIPAllocationMode" + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "The minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "scaleDownMode": { + "$ref": "#/definitions/ScaleDownMode", + "description": "The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete." + }, + "type": { + "$ref": "#/definitions/AgentPoolType" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode" + }, + "orchestratorVersion": { + "type": "string", + "description": "The version of Kubernetes specified by the user. Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically. Updating the agent pool with the same once it has been created will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool)." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes running on the Agent Pool. If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used." + }, + "nodeImageVersion": { + "type": "string", + "description": "The version of node image" + }, + "upgradeStrategy": { + "type": "string", + "description": "Defines the upgrade strategy for the agent pool. The default is Rolling.", + "enum": [ + "Rolling", + "BlueGreen" + ], + "x-ms-enum": { + "name": "upgradeStrategy", + "modelAsString": true, + "values": [ + { + "value": "Rolling", + "description": "Specifies that the agent pool will conduct rolling upgrade. This is the default upgrade strategy." + }, + { + "value": "BlueGreen", + "description": "Specifies that the agent pool will conduct blue-green upgrade." + } + ] + } + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool. Applies when upgrade strategy is set to Rolling." + }, + "upgradeSettingsBlueGreen": { + "$ref": "#/definitions/AgentPoolBlueGreenUpgradeSettings", + "description": "Settings for Blue-Green upgrade on the agentpool. Applies when upgrade strategy is set to BlueGreen." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "powerState": { + "description": "Whether the Agent Pool is running or stopped. When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded", + "$ref": "#/definitions/PowerState" + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'." + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Whether each node is allocated its own public IP. Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "description": "The public IP prefix ID which VM nodes should use IPs from. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "description": "The Virtual Machine Scale Set eviction policy to use. This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "description": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "nodeInitializationTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Taints added on the nodes during creation that will not be reconciled by AKS. These taints will not be reconciled by AKS and can be removed with a kubectl call. This field can be modified after node pool is created, but nodes will not be recreated with new taints until another operation that requires recreation (e.g. node image upgrade) happens. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`" + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the agent pool nodes." + }, + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux agent nodes." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "description": "Whether to enable host based OS and data drive encryption. This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption" + }, + "enableUltraSSD": { + "type": "boolean", + "description": "Whether to enable UltraSSD" + }, + "enableFIPS": { + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS. See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details." + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot." + }, + "capacityReservationGroupID": { + "$ref": "#/definitions/CapacityReservationGroupID", + "description": "AKS will associate the specified agent pool with the Capacity Reservation Group." + }, + "hostGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/hostGroups" + } + ] + }, + "description": "The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts)." + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows agent pool's specific profile." + }, + "networkProfile": { + "$ref": "#/definitions/AgentPoolNetworkProfile", + "description": "Network-related settings of an agent pool." + }, + "securityProfile": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of an agent pool." + }, + "gpuProfile": { + "$ref": "#/definitions/GPUProfile", + "description": "The GPU settings of an agent pool." + }, + "artifactStreamingProfile": { + "$ref": "#/definitions/AgentPoolArtifactStreamingProfile", + "description": "Configuration for using artifact streaming on AKS." + }, + "virtualMachinesProfile": { + "$ref": "#/definitions/VirtualMachinesProfile" + }, + "virtualMachineNodesStatus": { + "$ref": "#/definitions/VirtualMachineNodesStatus" + }, + "gatewayProfile": { + "$ref": "#/definitions/AgentPoolGatewayProfile", + "description": "Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway." + }, + "status": { + "$ref": "#/definitions/AgentPoolStatus", + "description": "Contains read-only information about the Agent Pool." + }, + "localDNSProfile": { + "$ref": "#/definitions/LocalDNSProfile", + "description": "Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns." + }, + "nodeCustomizationProfile": { + "$ref": "#/definitions/NodeCustomizationProfile", + "description": "Settings to determine the node customization used to provision nodes in a pool." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "AgentPoolNetworkProfile": { + "type": "object", + "properties": { + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + }, + "allowedHostPorts": { + "type": "array", + "description": "The port ranges that are allowed to access. The specified ranges are allowed to overlap.", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationSecurityGroups" + } + ] + } + }, + "description": "The IDs of the application security groups which agent pool will associate when created." + } + }, + "description": "Network settings of an agent pool." + }, + "NodeCustomizationProfile": { + "type": "object", + "description": "Settings to determine the node customization used to provision nodes in a pool.", + "properties": { + "nodeCustomizationId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the node customization resource to use. This can be a version. Omitting the version will use the latest version of the node customization.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerService/nodeCustomizations" + } + ] + } + } + } + }, + "NodePublicIPTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of tags associated with the node public IP address." + }, + "IPTag": { + "type": "object", + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: RoutingPreference." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: Internet." + } + }, + "description": "Contains the IPTag associated with the object." + }, + "PortRange": { + "type": "object", + "description": "The port range.", + "properties": { + "portStart": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd." + }, + "portEnd": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 65535, + "description": "The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart." + }, + "protocol": { + "type": "string", + "description": "The network protocol of the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true, + "values": [ + { + "value": "TCP", + "description": "TCP protocol." + }, + { + "value": "UDP", + "description": "UDP protocol." + } + ] + } + } + } + }, + "ManagedClusterAgentPoolProfile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group. Windows agent pool names must be 6 characters or less.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + }, + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet", + "VirtualMachines" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true, + "values": [ + { + "value": "VirtualMachineScaleSets", + "description": "Create an Agent Pool backed by a Virtual Machine Scale Set." + }, + { + "value": "AvailabilitySet", + "description": "Use of this is strongly discouraged." + }, + { + "value": "VirtualMachines", + "description": "Create an Agent Pool backed by a Single Instance VM orchestration mode." + } + ] + }, + "description": "The type of Agent Pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User", + "Gateway", + "ManagedSystem", + "Machines" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true, + "values": [ + { + "value": "System", + "description": "System agent pools are primarily for hosting critical system pods such as CoreDNS and metrics-server. System agent pools osType must be Linux. System agent pools VM SKU must have at least 2vCPUs and 4GB of memory." + }, + { + "value": "User", + "description": "User agent pools are primarily for hosting your application pods." + }, + { + "value": "Gateway", + "description": "Gateway agent pools are dedicated to providing static egress IPs to pods. For more details, see https://aka.ms/aks/static-egress-gateway." + }, + { + "value": "ManagedSystem", + "description": "ManagedSystem is a system pool managed by AKS. The pool scales dynamically according to cluster usage, and has additional automated monitoring and healing capabilities. There can only be one ManagedSystem pool, and it is recommended to delete all other system pools for the best experience." + }, + { + "value": "Machines", + "description": "Machines agent pools are dedicated to hosting machines. Only limited operations, such as creation and deletion, are allowed at the pool level. Please use the machine APIs to manage the full machine lifecycle." + } + ] + }, + "description": "The mode of an agent pool. A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools" + }, + "AgentPoolListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "type": "object", + "properties": { + "maxSurge": { + "type": "string", + "description": "The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster" + }, + "minSurge": { + "type": "string", + "title": "The minimum number or percentage of nodes that are surged during upgrade.", + "description": "This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If node capacity constraints prevent full surging, AKS would attempt a slower upgrade with fewer surge nodes. The upgrade will proceed only if the available surge capacity meets or exceeds minSurge. If minSurge not specified, the default is 50% of the maxSurge, for example, if maxSurge = 10%, the default is 5%, if maxSurge = 10, the default is 5." + }, + "maxUnavailable": { + "type": "string", + "description": "The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster" + }, + "maxBlockedNodes": { + "type": "string", + "description": "The maximum number or percentage of extra nodes that are allowed to be blocked in the agent pool during an upgrade when undrainable node behavior is Cordon. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is maxSurge. This must always be greater than or equal to maxSurge. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "description": "The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "nodeSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 30, + "minimum": 0, + "description": "The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes." + }, + "undrainableNodeBehavior": { + "type": "string", + "description": "Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes.", + "enum": [ + "Schedule", + "Cordon" + ], + "x-ms-enum": { + "name": "UndrainableNodeBehavior", + "modelAsString": true, + "values": [ + { + "value": "Cordon", + "description": "AKS will cordon the blocked nodes and replace them with surge nodes during upgrade. The blocked nodes will be cordoned and replaced by surge nodes. The blocked nodes will have label 'kubernetes.azure.com/upgrade-status:Quarantined'. A surge node will be retained for each blocked node. A best-effort attempt will be made to delete all other surge nodes. If there are enough surge nodes to replace blocked nodes, then the upgrade operation and the managed cluster will be in failed state. Otherwise, the upgrade operation and the managed cluster will be in canceled state." + }, + { + "value": "Schedule", + "description": "AKS will mark the blocked nodes schedulable, but the blocked nodes are not upgraded. A best-effort attempt will be made to delete all surge nodes. The upgrade operation and the managed cluster will be in failed state if there are any blocked nodes." + } + ] + } + } + }, + "description": "Settings for rolling upgrade on an agentpool" + }, + "AgentPoolBlueGreenUpgradeSettings": { + "type": "object", + "properties": { + "drainBatchSize": { + "type": "string", + "description": "The number or percentage of nodes to drain in batch during blue-green upgrade. Must be a non-zero number. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total number of blue nodes of the initial upgrade operation. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster" + }, + "drainTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 1, + "description": "The drain timeout for a node, i.e., the amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes." + }, + "batchSoakDurationInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 1440, + "minimum": 0, + "description": "The soak duration after draining a batch of nodes, i.e., the amount of time (in minutes) to wait after draining a batch of nodes before moving on the next batch. If not specified, the default is 15 minutes." + }, + "finalSoakDurationInMinutes": { + "type": "integer", + "description": "The soak duration for a node pool, i.e., the amount of time (in minutes) to wait after all old nodes are drained before we remove the old nodes. If not specified, the default is 60 minutes. Only applicable for blue-green upgrade strategy.", + "format": "int32", + "maximum": 10080, + "minimum": 0 + } + }, + "description": "Settings for blue-green upgrade on an agentpool" + }, + "AgentPool": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + }, + "description": "Agent Pool." + }, + "ManagedNamespaceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedNamespace" + }, + "description": "The list of managed namespaces." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of results, if any." + } + }, + "description": "The result of a request to list managed namespaces in a managed cluster." + }, + "ManagedNamespace": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the managed cluster namespace." + }, + "eTag": { + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.", + "readOnly": true, + "type": "string" + }, + "location": { + "type": "string", + "description": "The location of the namespace.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Properties of a namespace.", + "$ref": "#/definitions/NamespaceProperties" + } + }, + "description": "Namespace managed by ARM." + }, + "NamespaceProperties": { + "type": "object", + "description": "Properties of a namespace managed by ARM", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the namespace.", + "enum": [ + "Updating", + "Deleting", + "Creating", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "NamespaceProvisioningState", + "modelAsString": true + } + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The labels of managed namespace." + }, + "annotations": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The annotations of managed namespace." + }, + "portalFqdn": { + "readOnly": true, + "type": "string", + "description": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "defaultResourceQuota": { + "description": "The default resource quota enforced upon the namespace. Customers can have other Kubernetes resource quota objects under the namespace. Resource quotas are additive; if multiple resource quotas are applied to a given namespace, then the effective limit will be one such that all quotas on the namespace can be satisfied.", + "$ref": "#/definitions/ResourceQuota" + }, + "defaultNetworkPolicy": { + "description": "The default network policy enforced upon the namespace. Customers can have other Kubernetes network policy objects under the namespace. Network policies are additive; if a policy or policies apply to a given pod for a given direction, the connections allowed in that direction for the pod is the union of what all applicable policies allow.", + "$ref": "#/definitions/NetworkPolicies" + }, + "adoptionPolicy": { + "type": "string", + "description": "Action if Kubernetes namespace with same name already exists.", + "enum": [ + "Never", + "IfIdentical", + "Always" + ], + "x-ms-enum": { + "name": "AdoptionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Never", + "description": "If the namespace already exists in Kubernetes, attempts to create that same namespace in ARM will fail." + }, + { + "value": "IfIdentical", + "description": "Take over the existing namespace to be managed by ARM, if there is no difference." + }, + { + "value": "Always", + "description": "Always take over the existing namespace to be managed by ARM, some fields might be overwritten." + } + ] + } + }, + "deletePolicy": { + "type": "string", + "description": "Delete options of a namespace.", + "enum": [ + "Keep", + "Delete" + ], + "x-ms-enum": { + "name": "DeletePolicy", + "modelAsString": true, + "values": [ + { + "value": "Keep", + "description": "Only delete the ARM resource, keep the Kubernetes namespace. Also delete the ManagedByARM label." + }, + { + "value": "Delete", + "description": "Delete both the ARM resource and the Kubernetes namespace together." + } + ] + } + } + } + }, + "ResourceQuota": { + "type": "object", + "description": "Resource quota for the namespace.", + "properties": { + "cpuRequest": { + "type": "string", + "description": "CPU request of the namespace in one-thousandth CPU form. See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details." + }, + "cpuLimit": { + "type": "string", + "description": "CPU limit of the namespace in one-thousandth CPU form. See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details." + }, + "memoryRequest": { + "type": "string", + "description": "Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details." + }, + "memoryLimit": { + "type": "string", + "description": "Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details." + } + } + }, + "NetworkPolicies": { + "type": "object", + "description": "Default network policy of the namespace, specifying ingress and egress rules.", + "properties": { + "ingress": { + "$ref": "#/definitions/PolicyRule", + "description": "Ingress policy for the network.", + "default": "AllowSameNamespace" + }, + "egress": { + "$ref": "#/definitions/PolicyRule", + "description": "Egress policy for the network.", + "default": "AllowAll" + } + } + }, + "PolicyRule": { + "type": "string", + "description": "Enum representing different network policy rules.", + "enum": [ + "DenyAll", + "AllowAll", + "AllowSameNamespace" + ], + "x-ms-enum": { + "name": "PolicyRule", + "modelAsString": true, + "values": [ + { + "value": "DenyAll", + "description": "Deny all network traffic." + }, + { + "value": "AllowAll", + "description": "Allow all network traffic." + }, + { + "value": "AllowSameNamespace", + "description": "Allow traffic within the same namespace." + } + ] + } + }, + "MachineListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [ + "id" + ], + "items": { + "$ref": "#/definitions/Machine" + }, + "description": "The list of Machines in cluster." + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The URL to get the next set of machine results.", + "readOnly": true + } + }, + "description": "The response from the List Machines operation." + }, + "Machine": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Availability zone in which machine is located." + }, + "properties": { + "$ref": "#/definitions/MachineProperties", + "description": "The properties of the machine" + } + }, + "description": "A machine provides detailed information about its configuration and status. A machine may be visible here but not in kubectl get nodes; if so, it may be because the machine has not been registered with the Kubernetes API Server yet." + }, + "MachineProperties": { + "type": "object", + "description": "The properties of the machine", + "properties": { + "network": { + "$ref": "#/definitions/MachineNetworkProperties" + }, + "resourceId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/virtualMachines" + } + ] + }, + "description": "Arm resource id of the machine. It can be used to GET underlying VM Instance" + }, + "hardware": { + "$ref": "#/definitions/MachineHardwareProfile" + }, + "operatingSystem": { + "$ref": "#/definitions/MachineOSProfile" + }, + "kubernetes": { + "$ref": "#/definitions/MachineKubernetesProfile" + }, + "mode": { + "description": "Machine only allows 'System' and 'User' mode.", + "$ref": "#/definitions/AgentPoolMode" + }, + "security": { + "$ref": "#/definitions/AgentPoolSecurityProfile", + "description": "The security settings of the machine." + }, + "priority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "The priority for the machine. If not specified, the default is 'Regular'." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags to be persisted on the machine." + }, + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MachineStatus", + "readOnly": true, + "description": "Contains read-only information about the machine." + } + } + }, + "MachineNetworkProperties": { + "type": "object", + "description": "The network properties of the machine", + "properties": { + "ipAddresses": { + "type": "array", + "x-ms-identifiers": [], + "readOnly": true, + "description": "IPv4, IPv6 addresses of the machine", + "items": { + "$ref": "#/definitions/MachineIpAddress" + } + }, + "vnetSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "The ID of the subnet which node and optionally pods will join on startup. If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "podSubnetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "The ID of the subnet which pods will join when launched. If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Whether the machine is allocated its own public IP. Some scenarios may require the machine to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. The default is false." + }, + "nodePublicIPPrefixID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "description": "The public IP prefix ID which VM node should use IPs from. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "nodePublicIPTags": { + "$ref": "#/definitions/NodePublicIPTags", + "description": "IPTags of instance-level public IPs." + } + } + }, + "MachineIpAddress": { + "description": "The machine IP address details.", + "properties": { + "family": { + "description": "To determine if address belongs IPv4 or IPv6 family", + "enum": [ + "IPv4", + "IPv6" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IPFamily", + "values": [ + { + "description": "IPv4 family", + "value": "IPv4" + }, + { + "description": "IPv6 family", + "value": "IPv6" + } + ] + } + }, + "ip": { + "description": "IPv4 or IPv6 address of the machine", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "MachineHardwareProfile": { + "description": "The hardware and GPU settings of the machine.", + "properties": { + "vmSize": { + "type": "string", + "description": "The size of the VM. VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions" + }, + "gpuInstanceProfile": { + "$ref": "#/definitions/GPUInstanceProfile", + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "gpuProfile": { + "$ref": "#/definitions/GPUProfile", + "description": "The GPU settings of the machine." + } + }, + "type": "object" + }, + "MachineOSProfile": { + "description": "The operating system and disk used by the machine.", + "properties": { + "osType": { + "$ref": "#/definitions/OSType" + }, + "osSKU": { + "$ref": "#/definitions/OSSKU" + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk" + }, + "osDiskType": { + "$ref": "#/definitions/OSDiskType" + }, + "enableFIPS": { + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + }, + "linuxProfile": { + "type": "object", + "description": "The Linux machine's specific profile.", + "properties": { + "linuxOSConfig": { + "$ref": "#/definitions/LinuxOSConfig", + "description": "The OS configuration of Linux machine." + }, + "messageOfTheDay": { + "type": "string", + "description": "Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script)." + } + } + }, + "windowsProfile": { + "$ref": "#/definitions/AgentPoolWindowsProfile", + "description": "The Windows machine's specific profile." + } + }, + "type": "object" + }, + "MachineKubernetesProfile": { + "description": "The Kubernetes configurations used by the machine.", + "properties": { + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The node labels on the machine." + }, + "orchestratorVersion": { + "type": "string", + "description": "The version of Kubernetes specified by the user. Both patch version and are supported. When is specified, the latest supported patch version is chosen automatically." + }, + "currentOrchestratorVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes running on the machine. If orchestratorVersion was a fully specified version , this field will be exactly equal to it. If orchestratorVersion was , this field will contain the full version being used." + }, + "kubeletDiskType": { + "$ref": "#/definitions/KubeletDiskType" + }, + "kubeletConfig": { + "$ref": "#/definitions/KubeletConfig", + "description": "The Kubelet configuration on the machine." + }, + "nodeInitializationTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Taints added on the node during creation that will not be reconciled by AKS. These taints will not be reconciled by AKS and can be removed with a kubectl call. These taints allow for required configuration to run before the node is ready to accept workloads, for example 'key1=value1:NoSchedule' that then can be removed with `kubectl taint nodes node1 key1=value1:NoSchedule-`" + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The taints added to new node during machine create. For example, key=value:NoSchedule." + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "The maximum number of pods that can run on a node." + }, + "nodeName": { + "type": "string", + "description": "The node name in the Kubernetes cluster.", + "readOnly": true + }, + "workloadRuntime": { + "$ref": "#/definitions/WorkloadRuntime" + }, + "artifactStreamingProfile": { + "$ref": "#/definitions/AgentPoolArtifactStreamingProfile", + "description": "Configuration for using artifact streaming on AKS." + } + }, + "type": "object" + }, + "MachineStatus": { + "description": "Contains read-only information about the machine.", + "properties": { + "provisioningError": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The error details information of the machine. Preserves the detailed info of failure. If there was no error, this field is omitted." + }, + "creationTimestamp": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Specifies the time at which the machine was created." + }, + "driftAction": { + "description": "The drift action of the machine. Indicates whether a machine has deviated from its expected state due to changes in managed cluster properties, requiring corrective action.", + "readOnly": true, + "enum": [ + "Synced", + "Recreate" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "driftAction", + "values": [ + { + "description": "The machine is up to date.", + "value": "Synced" + }, + { + "description": "The machine has drifted and needs to be deleted and recreated.", + "value": "Recreate" + } + ] + } + }, + "driftReason": { + "type": "string", + "readOnly": true, + "description": "Reason for machine drift. Provides detailed information on why the machine has drifted. This field is omitted if the machine is up to date." + }, + "vmState": { + "description": "Virtual machine state. Indicates the current state of the underlying virtual machine.", + "readOnly": true, + "enum": [ + "Running", + "Deleted" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "vmState", + "values": [ + { + "description": "The virtual machine is currently running.", + "value": "Running" + }, + { + "description": "The virtual machine has been deleted by the user or due to spot eviction.", + "value": "Deleted" + } + ] + } + } + }, + "type": "object" + }, + "PodLinkLocalAccess": { + "type": "string", + "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. If not specified, the default is 'IMDS'.", + "enum": [ + "IMDS", + "None" + ], + "x-ms-enum": { + "name": "PodLinkLocalAccess", + "modelAsString": true, + "values": [ + { + "value": "IMDS", + "description": "Pods with hostNetwork=false can access Azure Instance Metadata Service (IMDS) without restriction." + }, + { + "value": "None", + "description": "Pods with hostNetwork=false cannot access Azure Instance Metadata Service (IMDS)." + } + ] + } + }, + "ManagedClusterWindowsProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

      **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:** 1 character

      **Max-length:** 20 characters" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

      **Minimum-length:** 8 characters

      **Max-length:** 123 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!\"" + }, + "licenseType": { + "type": "string", + "enum": [ + "None", + "Windows_Server" + ], + "x-ms-enum": { + "name": "licenseType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No additional licensing is applied." + }, + { + "value": "Windows_Server", + "description": "Enables Azure Hybrid User Benefits for Windows VMs." + } + ] + }, + "description": "The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details." + }, + "enableCSIProxy": { + "type": "boolean", + "description": "Whether to enable CSI proxy. For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy)." + }, + "gmsaProfile": { + "$ref": "#/definitions/WindowsGmsaProfile", + "description": "The Windows gMSA Profile in the Managed Cluster." + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the managed cluster." + }, + "WindowsGmsaProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Windows gMSA. Specifies whether to enable Windows gMSA in the managed cluster." + }, + "dnsServer": { + "type": "string", + "description": "Specifies the DNS server for Windows gMSA.

      Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + }, + "rootDomainName": { + "type": "string", + "description": "Specifies the root domain name for Windows gMSA.

      Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster." + } + }, + "description": "Windows gMSA Profile in the managed cluster." + }, + "ContainerServiceLinuxProfile": { + "type": "object", + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "The SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ManagedClusterNodeResourceGroupProfile": { + "type": "object", + "properties": { + "restrictionLevel": { + "type": "string", + "enum": [ + "Unrestricted", + "ReadOnly" + ], + "x-ms-enum": { + "name": "RestrictionLevel", + "modelAsString": true, + "values": [ + { + "value": "Unrestricted", + "description": "All RBAC permissions are allowed on the managed node resource group" + }, + { + "value": "ReadOnly", + "description": "Only */read RBAC permissions allowed on the managed node resource group" + } + ] + }, + "description": "The restriction level applied to the cluster's node resource group" + } + }, + "description": "Node resource group lockdown profile for a managed cluster." + }, + "ContainerServiceNetworkProfile": { + "type": "object", + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "Network plugin used for building the Kubernetes network." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "Network plugin mode used for building the Kubernetes network." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "Network policy used for building the Kubernetes network." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "description": "The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "networkDataplane": { + "$ref": "#/definitions/NetworkDataplane", + "description": "Network dataplane used in the Kubernetes cluster." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting", + "managedNATGateway", + "userAssignedNATGateway", + "none" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true, + "values": [ + { + "value": "loadBalancer", + "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. For more information see [outbound type loadbalancer](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-loadbalancer)." + }, + { + "value": "userDefinedRouting", + "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. For more information see [outbound type userDefinedRouting](https://docs.microsoft.com/azure/aks/egress-outboundtype#outbound-type-of-userdefinedrouting)." + }, + { + "value": "managedNATGateway", + "description": "The AKS-managed NAT gateway is used for egress." + }, + { + "value": "userAssignedNATGateway", + "description": "The user-assigned NAT gateway associated to the cluster subnet is used for egress. This is an advanced scenario and requires proper network configuration." + }, + { + "value": "none", + "description": "The AKS cluster is not set with any outbound-type. All AKS nodes follows Azure VM default outbound behavior. Please refer to https://azure.microsoft.com/en-us/updates/default-outbound-access-for-vms-in-azure-will-be-retired-transition-to-a-new-method-of-internet-access/" + } + ] + }, + "default": "loadBalancer", + "description": "The outbound (egress) routing method. This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype)." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "The load balancer sku for the managed cluster. The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + }, + "natGatewayProfile": { + "$ref": "#/definitions/ManagedClusterNATGatewayProfile", + "description": "Profile of the cluster NAT gateway." + }, + "staticEgressGatewayProfile": { + "$ref": "#/definitions/ManagedClusterStaticEgressGatewayProfile", + "description": "The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway." + }, + "podCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking." + }, + "serviceCidrs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR notation IP ranges from which to assign service cluster IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges." + }, + "ipFamilies": { + "type": "array", + "items": { + "type": "string", + "description": "The IP version to use for cluster networking and IP assignment.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "ipFamily", + "modelAsString": true + } + }, + "description": "The IP families used to specify IP versions available to the cluster. IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6." + }, + "podLinkLocalAccess": { + "$ref": "#/definitions/PodLinkLocalAccess", + "description": "Defines access to special link local addresses (Azure Instance Metadata Service, aka IMDS) for pods with hostNetwork=false. if not specified, the default is 'IMDS'." + }, + "kubeProxyConfig": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable on kube-proxy on the cluster (if no 'kubeProxyConfig' exists, kube-proxy is enabled in AKS by default without these customizations)." + }, + "mode": { + "type": "string", + "enum": [ + "IPTABLES", + "IPVS", + "NFTABLES" + ], + "x-ms-enum": { + "name": "mode", + "modelAsString": true, + "values": [ + { + "value": "IPTABLES", + "description": "IPTables proxy mode" + }, + { + "value": "IPVS", + "description": "IPVS proxy mode. Must be using Kubernetes version >= 1.22." + }, + { + "value": "NFTABLES", + "description": "NFTables proxy mode. Must be using Kubernetes version >= 1.33." + } + ] + }, + "description": "Specify which proxy mode to use ('IPTABLES', 'IPVS' or 'NFTABLES')" + }, + "ipvsConfig": { + "type": "object", + "properties": { + "scheduler": { + "type": "string", + "enum": [ + "RoundRobin", + "LeastConnection" + ], + "x-ms-enum": { + "name": "ipvsScheduler", + "modelAsString": true, + "values": [ + { + "value": "RoundRobin", + "description": "Round Robin" + }, + { + "value": "LeastConnection", + "description": "Least Connection" + } + ] + }, + "description": "IPVS scheduler, for more information please see http://www.linuxvirtualserver.org/docs/scheduling.html." + }, + "tcpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for idle IPVS TCP sessions in seconds. Must be a positive integer value." + }, + "tcpFinTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS TCP sessions after receiving a FIN in seconds. Must be a positive integer value." + }, + "udpTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout value used for IPVS UDP packets in seconds. Must be a positive integer value." + } + }, + "description": "Holds configuration customizations for IPVS. May only be specified if 'mode' is set to 'IPVS'." + } + }, + "description": "Holds configuration customizations for kube-proxy. Any values not defined will use the kube-proxy defaulting behavior. See https://v.docs.kubernetes.io/docs/reference/command-line-tools-reference/kube-proxy/ where is represented by a - string. Kubernetes version 1.23 would be '1-23'." + }, + "advancedNetworking": { + "$ref": "#/definitions/AdvancedNetworking" + } + }, + "description": "Profile of network configuration." + }, + "MaintenanceConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + }, + "description": "The list of maintenance configurations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of maintenance configuration results.", + "readOnly": true + } + }, + "description": "The response from the List maintenance configurations operation." + }, + "MaintenanceConfiguration": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "readOnly": true, + "description": "The system metadata relating to this resource." + }, + "properties": { + "description": "Properties of a default maintenance configuration.", + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "x-ms-client-flatten": true + } + }, + "description": "Planned maintenance configuration, used to configure when updates can be deployed to a Managed Cluster. See [planned maintenance](https://docs.microsoft.com/azure/aks/planned-maintenance) for more information about planned maintenance." + }, + "MaintenanceConfigurationProperties": { + "type": "object", + "properties": { + "timeInWeek": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeInWeek" + }, + "x-ms-identifiers": [], + "description": "Time slots during the week when planned maintenance is allowed to proceed. If two array entries specify the same day of the week, the applied configuration is the union of times in both entries." + }, + "notAllowedTime": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSpan" + }, + "x-ms-identifiers": [], + "description": "Time slots on which upgrade is not allowed." + }, + "maintenanceWindow": { + "type": "object", + "$ref": "#/definitions/MaintenanceWindow", + "description": "Maintenance window for the maintenance configuration." + } + }, + "description": "Properties used to configure planned maintenance for a Managed Cluster." + }, + "MaintenanceWindow": { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "description": "Recurrence schedule for the maintenance window." + }, + "durationHours": { + "type": "integer", + "format": "int32", + "minimum": 4, + "maximum": 24, + "default": 24, + "description": "Length of maintenance window range from 4 to 24 hours." + }, + "utcOffset": { + "type": "string", + "pattern": "^(-|\\+)[0-9]{2}:[0-9]{2}$", + "description": "The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'." + }, + "startDate": { + "type": "string", + "format": "date", + "description": "The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away." + }, + "startTime": { + "type": "string", + "pattern": "^\\d{2}:\\d{2}$", + "description": "The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'." + }, + "notAllowedDates": { + "type": "array", + "items": { + "$ref": "#/definitions/DateSpan" + }, + "x-ms-identifiers": [], + "description": "Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time." + } + }, + "description": "Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster.", + "required": [ + "schedule", + "durationHours", + "startTime" + ] + }, + "Schedule": { + "type": "object", + "properties": { + "daily": { + "$ref": "#/definitions/DailySchedule" + }, + "weekly": { + "$ref": "#/definitions/WeeklySchedule" + }, + "absoluteMonthly": { + "$ref": "#/definitions/AbsoluteMonthlySchedule" + }, + "relativeMonthly": { + "$ref": "#/definitions/RelativeMonthlySchedule" + } + }, + "description": "One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule." + }, + "DailySchedule": { + "type": "object", + "properties": { + "intervalDays": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7, + "description": "Specifies the number of days between each set of occurrences." + } + }, + "description": "For schedules like: 'recur every day' or 'recur every 3 days'.", + "required": [ + "intervalDays" + ] + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "intervalWeeks": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4, + "description": "Specifies the number of weeks between each set of occurrences." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'.", + "required": [ + "intervalWeeks", + "dayOfWeek" + ] + }, + "AbsoluteMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "dayOfMonth": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 31, + "description": "The date of the month." + } + }, + "description": "For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'.", + "required": [ + "intervalMonths", + "dayOfMonth" + ] + }, + "RelativeMonthlySchedule": { + "type": "object", + "properties": { + "intervalMonths": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 6, + "description": "Specifies the number of months between each set of occurrences." + }, + "weekIndex": { + "type": "string", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "First", + "description": "First." + }, + { + "value": "Second", + "description": "Second." + }, + { + "value": "Third", + "description": "Third." + }, + { + "value": "Fourth", + "description": "Fourth." + }, + { + "value": "Last", + "description": "Last." + } + ] + }, + "description": "The week index. Specifies on which instance of the allowed days specified in daysOfWeek the maintenance occurs." + }, + "dayOfWeek": { + "$ref": "#/definitions/WeekDay", + "description": "Specifies on which day of the week the maintenance occurs." + } + }, + "description": "For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'.", + "required": [ + "intervalMonths", + "weekIndex", + "dayOfWeek" + ] + }, + "DateSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date", + "description": "The start date of the date span." + }, + "end": { + "type": "string", + "format": "date", + "description": "The end date of the date span." + } + }, + "description": "A date range. For example, between '2022-12-23' and '2023-01-05'.", + "required": [ + "start", + "end" + ] + }, + "TimeInWeek": { + "type": "object", + "properties": { + "day": { + "$ref": "#/definitions/WeekDay", + "description": "The day of the week." + }, + "hourSlots": { + "type": "array", + "items": { + "$ref": "#/definitions/HourInDay" + }, + "description": "A list of hours in the day used to identify a time range. Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range." + } + }, + "description": "Time in a week." + }, + "WeekDay": { + "type": "string", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDay", + "modelAsString": true + }, + "description": "The weekday enum." + }, + "HourInDay": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0, + "description": "Hour in a day." + }, + "TimeSpan": { + "type": "object", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "The start of a time span" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "The end of a time span" + } + }, + "description": "A time range. For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z." + }, + "RunCommandRequest": { + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to run." + }, + "context": { + "type": "string", + "description": "A base64 encoded zip file containing the files required by the command." + }, + "clusterToken": { + "type": "string", + "description": "AuthToken issued for AKS AAD Server App." + } + }, + "description": "A run command request", + "required": [ + "command" + ] + }, + "RunCommandResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The command id.", + "readOnly": true + }, + "properties": { + "description": "Properties of command result.", + "$ref": "#/definitions/CommandResultProperties", + "x-ms-client-flatten": true + } + }, + "description": "run command result." + }, + "CommandResultProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "provisioning State" + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The exit code of the command" + }, + "startedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command started." + }, + "finishedAt": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time when the command finished." + }, + "logs": { + "type": "string", + "readOnly": true, + "description": "The command output." + }, + "reason": { + "type": "string", + "readOnly": true, + "description": "An explanation of why provisioningState is set to failed (if so)." + } + }, + "description": "The results of a run command" + }, + "ManagedClusterNATGatewayProfile": { + "type": "object", + "properties": { + "managedOutboundIPProfile": { + "$ref": "#/definitions/ManagedClusterManagedOutboundIPProfile", + "description": "Profile of the managed outbound IP resources of the cluster NAT gateway." + }, + "effectiveOutboundIPs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster NAT gateway." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes.", + "default": 4 + } + }, + "description": "Profile of the managed cluster NAT gateway." + }, + "ManagedClusterManagedOutboundIPProfile": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 16, + "minimum": 1, + "description": "The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Profile of the managed outbound IP resources of the managed cluster." + }, + "ManagedClusterLoadBalancerProfile": { + "type": "object", + "properties": { + "managedOutboundIPs": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "countIPv6": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. ", + "default": 0 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "type": "object", + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "type": "object", + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + }, + "enableMultipleStandardLoadBalancers": { + "type": "boolean", + "description": "Enable multiple standard load balancers per AKS cluster or not." + }, + "backendPoolType": { + "type": "string", + "x-ms-enum": { + "name": "BackendPoolType", + "modelAsString": true, + "values": [ + { + "value": "NodeIPConfiguration", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + }, + { + "value": "NodeIP", + "description": "The type of the managed inbound Load Balancer BackendPool. https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#configure-load-balancer-backend." + } + ] + }, + "enum": [ + "NodeIPConfiguration", + "NodeIP" + ], + "description": "The type of the managed inbound Load Balancer BackendPool.", + "default": "NodeIPConfiguration" + }, + "clusterServiceLoadBalancerHealthProbeMode": { + "type": "string", + "x-ms-enum": { + "name": "ClusterServiceLoadBalancerHealthProbeMode", + "modelAsString": true, + "values": [ + { + "value": "ServiceNodePort", + "description": "Each External Traffic Policy Cluster service will have its own health probe targeting service nodePort." + }, + { + "value": "Shared", + "description": "All External Traffic Policy Cluster services in a Standard Load Balancer will have a dedicated health probe targeting the backend nodes' kube-proxy health check port 10256." + } + ] + }, + "enum": [ + "ServiceNodePort", + "Shared" + ], + "description": "The health probing behavior for External Traffic Policy Cluster services.", + "default": "ServiceNodePort" + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ManagedClusterStaticEgressGatewayProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Enable Static Egress Gateway addon. Indicates if Static Egress Gateway addon is enabled or not." + } + }, + "description": "The Static Egress Gateway addon configuration for the cluster." + }, + "ResourceReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "type": "object", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "x-ms-identifiers": [], + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "type": "object", + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "type": "object", + "properties": { + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extended location of the Virtual Machine." + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + }, + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "kind": { + "type": "string", + "description": "This is primarily used to expose different UI experiences in the portal for different kinds" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The Power State of the cluster.", + "readOnly": true + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source Snapshot ID if the cluster will be created/upgraded using a snapshot." + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "description": "The version of Kubernetes the Managed Cluster is requested to run. When you upgrade a supported AKS cluster, Kubernetes minor versions cannot be skipped. All upgrades must be performed sequentially by major version number. For example, upgrades between 1.14.x -> 1.15.x or 1.15.x -> 1.16.x are allowed, however 1.14.x -> 1.16.x is not allowed. See [upgrading an AKS cluster](https://docs.microsoft.com/azure/aks/upgrade-cluster) for more details." + }, + "currentKubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes the Managed Cluster is running." + }, + "dnsPrefix": { + "type": "string", + "description": "The DNS prefix of the Managed Cluster. This cannot be updated once the Managed Cluster has been created." + }, + "fqdnSubdomain": { + "type": "string", + "description": "The FQDN subdomain of the private cluster with custom private dns zone. This cannot be updated once the Managed Cluster has been created." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN of the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "The FQDN of private cluster." + }, + "azurePortalFQDN": { + "readOnly": true, + "type": "string", + "description": "The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "x-ms-identifiers": [], + "description": "The agent pool properties." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "The profile for Linux VMs in the Managed Cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "The profile for Windows VMs in the Managed Cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "The profile of managed cluster add-on." + }, + "podIdentityProfile": { + "$ref": "#/definitions/ManagedClusterPodIdentityProfile", + "description": "The pod identity profile of the Managed Cluster. See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on AAD pod identity integration." + }, + "oidcIssuerProfile": { + "$ref": "#/definitions/ManagedClusterOIDCIssuerProfile", + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "nodeResourceGroup": { + "type": "string", + "description": "The name of the resource group containing agent pool nodes." + }, + "nodeResourceGroupProfile": { + "$ref": "#/definitions/ManagedClusterNodeResourceGroupProfile", + "description": "The node resource group configuration profile." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "supportPlan": { + "$ref": "#/definitions/KubernetesSupportPlan", + "description": "The support plan for the Managed Cluster. If unspecified, the default is 'KubernetesOfficial'." + }, + "enableNamespaceResources": { + "type": "boolean", + "description": "Enable namespace as Azure resource. The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "The network configuration profile." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "The Azure Active Directory configuration." + }, + "autoUpgradeProfile": { + "$ref": "#/definitions/ManagedClusterAutoUpgradeProfile", + "description": "The auto upgrade configuration." + }, + "upgradeSettings": { + "$ref": "#/definitions/ClusterUpgradeSettings", + "description": "Settings for upgrading a cluster." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string", + "description": "Detects similar node pools and balances the number of nodes between them. Valid values are 'true' and 'false'" + }, + "daemonset-eviction-for-empty-nodes": { + "type": "boolean", + "description": "DaemonSet pods will be gracefully terminated from empty nodes. If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "daemonset-eviction-for-occupied-nodes": { + "type": "boolean", + "description": "DaemonSet pods will be gracefully terminated from non-empty nodes. If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted." + }, + "ignore-daemonsets-utilization": { + "type": "boolean", + "description": "Should CA ignore DaemonSet pods when calculating resource utilization for scaling down. If set to true, the resources used by daemonset will be taken into account when making scaling down decisions." + }, + "expander": { + "type": "string", + "description": "Type of node group expander to be used in scale up. Set to be deprecated, please use 'expanders' flag in the future. Available values are: 'least-waste', 'most-pods', 'priority', 'random'.", + "$ref": "#/definitions/expander" + }, + "max-empty-bulk-delete": { + "type": "string", + "description": "The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer. The default is 10." + }, + "max-graceful-termination-sec": { + "type": "string", + "description": "The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. The default is 600." + }, + "max-node-provision-time": { + "type": "string", + "description": "The maximum time the autoscaler waits for a node to be provisioned. The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "max-total-unready-percentage": { + "type": "string", + "description": "The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations. The default is 45. The maximum is 100 and the minimum is 0." + }, + "new-pod-scale-up-delay": { + "type": "string", + "description": "Ignore unscheduled pods before they're a certain age. For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc)." + }, + "ok-total-unready-count": { + "type": "string", + "description": "The number of allowed unready nodes, irrespective of max-total-unready-percentage. This must be an integer. The default is 3." + }, + "scan-interval": { + "type": "string", + "description": "How often cluster is reevaluated for scale up or down. The default is '10'. Values must be an integer number of seconds." + }, + "scale-down-delay-after-add": { + "type": "string", + "description": "How long after scale up that scale down evaluation resumes. The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-delete": { + "type": "string", + "description": "How long after node deletion that scale down evaluation resumes. The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-delay-after-failure": { + "type": "string", + "description": "How long after scale down failure that scale down evaluation resumes. The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unneeded-time": { + "type": "string", + "description": "How long a node should be unneeded before it is eligible for scale down. The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-unready-time": { + "type": "string", + "description": "How long an unready node should be unneeded before it is eligible for scale down. The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported." + }, + "scale-down-utilization-threshold": { + "type": "string", + "description": "Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down. The default is '0.5'." + }, + "skip-nodes-with-local-storage": { + "type": "string", + "description": "If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath. The default is true." + }, + "skip-nodes-with-system-pods": { + "type": "string", + "description": "If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods). The default is true." + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "The access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/diskEncryptionSets" + } + ] + }, + "description": "The Resource ID of the disk encryption set to use for enabling encryption at rest. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{encryptionSetName}'" + }, + "identityProfile": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "The user identity associated with the managed cluster. This identity will be used by the kubelet. Only one user assigned identity is allowed. The only accepted key is \"kubeletidentity\", with value of \"resourceId\": \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}\"." + }, + "privateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + }, + "description": "Private link resources associated with the cluster." + }, + "disableLocalAccounts": { + "type": "boolean", + "description": "If local accounts should be disabled on the Managed Cluster. If set to true, getting static credentials will be disabled for this cluster. This must only be used on Managed Clusters that are AAD enabled. For more details see [disable local accounts](https://docs.microsoft.com/azure/aks/managed-aad#disable-local-accounts-preview)." + }, + "httpProxyConfig": { + "$ref": "#/definitions/ManagedClusterHTTPProxyConfig", + "description": "Configurations for provisioning the cluster with HTTP proxy servers." + }, + "securityProfile": { + "$ref": "#/definitions/ManagedClusterSecurityProfile", + "description": "Security profile for the managed cluster." + }, + "storageProfile": { + "$ref": "#/definitions/ManagedClusterStorageProfile", + "description": "Storage profile for the managed cluster." + }, + "ingressProfile": { + "$ref": "#/definitions/ManagedClusterIngressProfile", + "description": "Ingress profile for the managed cluster." + }, + "publicNetworkAccess": { + "type": "string", + "enum": [ + "Enabled", + "Disabled", + "SecuredByPerimeter" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Inbound/Outbound to the managedCluster is allowed." + }, + { + "value": "Disabled", + "description": "Inbound traffic to managedCluster is disabled, traffic from managedCluster is allowed." + }, + { + "value": "SecuredByPerimeter", + "description": "Inbound/Outbound traffic is managed by Microsoft.Network/NetworkSecurityPerimeters." + } + ] + }, + "description": "PublicNetworkAccess of the managedCluster. Allow or deny public network access for AKS" + }, + "workloadAutoScalerProfile": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfile" + }, + "azureMonitorProfile": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfile" + }, + "serviceMeshProfile": { + "$ref": "#/definitions/ServiceMeshProfile" + }, + "resourceUID": { + "readOnly": true, + "type": "string", + "description": "The resourceUID uniquely identifies ManagedClusters that reuse ARM ResourceIds (i.e: create, delete, create sequence)" + }, + "metricsProfile": { + "$ref": "#/definitions/ManagedClusterMetricsProfile", + "description": "Optional cluster metrics configuration." + }, + "aiToolchainOperatorProfile": { + "$ref": "#/definitions/ManagedClusterAIToolchainOperatorProfile", + "description": "AI toolchain operator settings that apply to the whole cluster." + }, + "nodeProvisioningProfile": { + "$ref": "#/definitions/ManagedClusterNodeProvisioningProfile", + "description": "Node provisioning settings that apply to the whole cluster." + }, + "bootstrapProfile": { + "$ref": "#/definitions/ManagedClusterBootstrapProfile", + "description": "Profile of the cluster bootstrap configuration." + }, + "schedulerProfile": { + "$ref": "#/definitions/SchedulerProfile", + "description": "Profile of the pod scheduler configuration." + }, + "hostedSystemProfile": { + "$ref": "#/definitions/ManagedClusterHostedSystemProfile", + "description": "Settings for hosted system addons. For more information, see https://aka.ms/aks/automatic/systemcomponents." + }, + "status": { + "$ref": "#/definitions/ManagedClusterStatus", + "description": "Contains read-only information about the Managed Cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "PowerState": { + "type": "object", + "description": "Describes the Power State of the cluster", + "properties": { + "code": { + "type": "string", + "description": "Tells whether the cluster is Running or Stopped", + "enum": [ + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "code", + "modelAsString": true, + "values": [ + { + "value": "Running", + "description": "The cluster is running." + }, + { + "value": "Stopped", + "description": "The cluster is stopped." + } + ] + } + } + } + }, + "expander": { + "type": "string", + "enum": [ + "least-waste", + "most-pods", + "priority", + "random" + ], + "x-ms-enum": { + "name": "expander", + "modelAsString": true, + "values": [ + { + "value": "least-waste", + "description": "Selects the node group that will have the least idle CPU (if tied, unused memory) after scale-up. This is useful when you have different classes of nodes, for example, high CPU or high memory nodes, and only want to expand those when there are pending pods that need a lot of those resources." + }, + { + "value": "most-pods", + "description": "Selects the node group that would be able to schedule the most pods when scaling up. This is useful when you are using nodeSelector to make sure certain pods land on certain nodes. Note that this won't cause the autoscaler to select bigger nodes vs. smaller, as it can add multiple smaller nodes at once." + }, + { + "value": "priority", + "description": "Selects the node group that has the highest priority assigned by the user. It's configuration is described in more details [here](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/expander/priority/readme.md)." + }, + { + "value": "random", + "description": "Used when you don't have a particular need for the node groups to scale differently." + } + ] + }, + "description": "The expander to use when scaling up. If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information." + }, + "ManagedClusterAPIServerAccessProfile": { + "type": "object", + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP ranges authorized to access the Kubernetes API server. IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges)." + }, + "enablePrivateCluster": { + "type": "boolean", + "description": "Whether to create the cluster as a private cluster or not. For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters)." + }, + "privateDNSZone": { + "type": "string", + "description": "The private DNS zone mode for the cluster. The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'." + }, + "enablePrivateClusterPublicFQDN": { + "type": "boolean", + "description": "Whether to create additional public FQDN for private cluster or not." + }, + "disableRunCommand": { + "type": "boolean", + "description": "Whether to disable run command for the cluster or not." + }, + "enableVnetIntegration": { + "type": "boolean", + "description": "Whether to enable apiserver vnet integration for the cluster or not." + }, + "subnetId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "The subnet to be used when apiserver vnet integration is enabled. It is required when: 1. creating a new cluster with BYO Vnet; 2. updating an existing cluster to enable apiserver vnet integration." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "description": "The type of identity used for the managed cluster. For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity).", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false, + "values": [ + { + "value": "SystemAssigned", + "description": "Use an implicitly created system assigned managed identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the system assigned managed identity to manipulate Azure resources." + }, + { + "value": "UserAssigned", + "description": "Use a user-specified identity to manage cluster resources. Master components in the control plane such as kube-controller-manager will use the specified user assigned managed identity to manipulate Azure resources." + }, + { + "value": "None", + "description": "Do not use a managed identity for the Managed Cluster, service principal will be used instead." + } + ] + } + }, + "delegatedResources": { + "$ref": "../../../../../../common-types/resource-management/v4/managedidentitywithdelegation.json#/definitions/DelegatedResources", + "description": "The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only." + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "ManagedServiceIdentityUserAssignedIdentitiesValue", + "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 user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed. The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + }, + "description": "The resource ID of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client ID of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object ID of the user assigned identity." + } + }, + "description": "Details about a user assigned identity." + }, + "ManagedClusterAccessProfile": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + }, + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "name": { + "type": "string", + "description": "The Agent Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + }, + "isOutOfSupport": { + "type": "boolean", + "description": "Whether the Kubernetes version is out of support." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "componentsByReleases": { + "type": "array", + "items": { + "$ref": "#/definitions/ComponentsByRelease" + }, + "x-ms-identifiers": [], + "description": "List of components grouped by kubernetes major.minor version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "type": "object", + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "x-ms-identifiers": [], + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAutoUpgradeProfile": { + "type": "object", + "properties": { + "upgradeChannel": { + "type": "string", + "enum": [ + "rapid", + "stable", + "patch", + "node-image", + "none" + ], + "x-ms-enum": { + "name": "upgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "rapid", + "description": "Automatically upgrade the cluster to the latest supported patch release on the latest supported minor version. In cases where the cluster is at a version of Kubernetes that is at an N-2 minor version where N is the latest supported minor version, the cluster first upgrades to the latest supported patch version on N-1 minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster first is upgraded to 1.18.6, then is upgraded to 1.19.1." + }, + { + "value": "stable", + "description": "Automatically upgrade the cluster to the latest supported patch release on minor version N-1, where N is the latest supported minor version. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.18.6." + }, + { + "value": "patch", + "description": "Automatically upgrade the cluster to the latest supported patch version when it becomes available while keeping the minor version the same. For example, if a cluster is running version 1.17.7 and versions 1.17.9, 1.18.4, 1.18.6, and 1.19.1 are available, your cluster is upgraded to 1.17.9." + }, + { + "value": "node-image", + "description": "Automatically upgrade the node image to the latest version available. Consider using nodeOSUpgradeChannel instead as that allows you to configure node OS patching separate from Kubernetes version patching" + }, + { + "value": "none", + "description": "Disables auto-upgrades and keeps the cluster at its current version of Kubernetes." + } + ] + }, + "description": "The upgrade channel for auto upgrade. The default is 'none'. For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel)." + }, + "nodeOSUpgradeChannel": { + "type": "string", + "enum": [ + "Unmanaged", + "None", + "SecurityPatch", + "NodeImage" + ], + "x-ms-enum": { + "name": "nodeOSUpgradeChannel", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No attempt to update your machines OS will be made either by OS or by rolling VHDs. This means you are responsible for your security updates" + }, + { + "value": "Unmanaged", + "description": "OS updates will be applied automatically through the OS built-in patching infrastructure. Newly scaled in machines will be unpatched initially, and will be patched at some later time by the OS's infrastructure. Behavior of this option depends on the OS in question. Ubuntu and Mariner apply security patches through unattended upgrade roughly once a day around 06:00 UTC. Windows does not apply security patches automatically and so for them this option is equivalent to None till further notice" + }, + { + "value": "SecurityPatch", + "description": "AKS downloads and updates the nodes with tested security updates. These updates honor the maintenance window settings and produce a new VHD that is used on new nodes. On some occasions it's not possible to apply the updates in place, in such cases the existing nodes will also be re-imaged to the newly produced VHD in order to apply the changes. This option incurs an extra cost of hosting the new Security Patch VHDs in your resource group for just in time consumption." + }, + { + "value": "NodeImage", + "description": "AKS will update the nodes with a newly patched VHD containing security fixes and bugfixes on a weekly cadence. With the VHD update machines will be rolling reimaged to that VHD following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option as AKS hosts the images." + } + ] + }, + "description": "Manner in which the OS on your nodes is updated. The default is Unmanaged, but may change to either NodeImage or SecurityPatch at GA." + } + }, + "description": "Auto upgrade profile for a managed cluster." + }, + "UpgradeOverrideSettings": { + "type": "object", + "properties": { + "forceUpgrade": { + "type": "boolean", + "description": "Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution." + }, + "until": { + "type": "string", + "format": "date-time", + "description": "Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect." + } + }, + "description": "Settings for overrides when upgrading a cluster." + }, + "ClusterUpgradeSettings": { + "type": "object", + "properties": { + "overrideSettings": { + "$ref": "#/definitions/UpgradeOverrideSettings", + "description": "Settings for overrides." + } + }, + "description": "Settings for upgrading a cluster." + }, + "ManagedClusterAADProfile": { + "type": "object", + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "(DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppID": { + "type": "string", + "description": "(DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy." + }, + "serverAppSecret": { + "type": "string", + "description": "(DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "description": "AADProfile specifies attributes for Azure Active Directory integration. For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad)." + }, + "ManagedClusterAddonProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterPodIdentity": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity." + }, + "bindingSelector": { + "type": "string", + "description": "The binding selector to use for the AzureIdentityBinding resource." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The user assigned identity details." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of the pod identity.", + "enum": [ + "Assigned", + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ManagedClusterPodIdentityProvisioningState", + "modelAsString": true + } + }, + "provisioningInfo": { + "type": "object", + "readOnly": true, + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningError", + "description": "Pod identity assignment error (if any)." + } + } + } + }, + "required": [ + "name", + "namespace", + "identity" + ], + "description": "Details about the pod identity assigned to the Managed Cluster." + }, + "ManagedClusterPodIdentityProvisioningError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityProvisioningErrorBody": { + "type": "object", + "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 display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityProvisioningErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the pod identity provisioning." + }, + "ManagedClusterPodIdentityException": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the pod identity exception." + }, + "namespace": { + "type": "string", + "description": "The namespace of the pod identity exception." + }, + "podLabels": { + "type": "object", + "description": "The pod labels to match.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "name", + "namespace", + "podLabels" + ], + "description": "A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server. See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details." + }, + "ManagedClusterPodIdentityProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the pod identity addon is enabled." + }, + "allowNetworkPluginKubenet": { + "type": "boolean", + "description": "Whether pod identity is allowed to run on clusters with Kubenet networking. Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information." + }, + "userAssignedIdentities": { + "description": "The pod identities to use in the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentity" + }, + "x-ms-identifiers": [] + }, + "userAssignedIdentityExceptions": { + "description": "The pod identity exceptions to allow.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPodIdentityException" + }, + "x-ms-identifiers": [] + } + }, + "description": "The pod identity profile of the Managed Cluster. See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration." + }, + "ManagedClusterOIDCIssuerProfile": { + "type": "object", + "properties": { + "issuerURL": { + "readOnly": true, + "type": "string", + "description": "The OIDC issuer url of the Managed Cluster." + }, + "enabled": { + "type": "boolean", + "description": "Whether the OIDC issuer is enabled." + } + }, + "description": "The OIDC issuer profile of the Managed Cluster." + }, + "ManagedClusterUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "The properties of the upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "The properties of the agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "osType": { + "$ref": "#/definitions/OSType" + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether the Kubernetes version is currently in preview." + }, + "isOutOfSupport": { + "type": "boolean", + "description": "Whether the Kubernetes version is out of support." + } + } + }, + "x-ms-identifiers": [], + "description": "List of orchestrator types and versions available for upgrade." + }, + "componentsByReleases": { + "type": "array", + "items": { + "$ref": "#/definitions/ComponentsByRelease" + }, + "x-ms-identifiers": [], + "description": "List of components grouped by kubernetes major.minor version." + }, + "recentlyUsedVersions": { + "description": "List of historical good versions for rollback operations.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AgentPoolRecentlyUsedVersion" + }, + "x-ms-identifiers": [] + }, + "latestNodeImageVersion": { + "type": "string", + "description": "The latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the agent pool version list." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the agent pool version list." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool version list." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "type": "object", + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "x-ms-identifiers": [], + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "AgentPoolRecentlyUsedVersion": { + "type": "object", + "properties": { + "orchestratorVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor.patch) available for rollback." + }, + "nodeImageVersion": { + "type": "string", + "description": "The node image version available for rollback." + }, + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp when this version was last used." + } + }, + "description": "A historical version that can be used for rollback operations." + }, + "PodIPAllocationMode": { + "type": "string", + "enum": [ + "DynamicIndividual", + "StaticBlock" + ], + "x-ms-enum": { + "name": "PodIPAllocationMode", + "modelAsString": true, + "values": [ + { + "value": "DynamicIndividual", + "description": "Each node gets allocated with a non-contiguous list of IP addresses assignable to pods. This is better for maximizing a small to medium subnet of size /16 or smaller. The Azure CNI cluster with dynamic IP allocation defaults to this mode if the customer does not explicitly specify a podIPAllocationMode" + }, + { + "value": "StaticBlock", + "description": "Each node is statically allocated CIDR block(s) of size /28 = 16 IPs per block to satisfy the maxPods per node. Number of CIDR blocks >= (maxPods / 16). The block, rather than a single IP, counts against the Azure Vnet Private IP limit of 65K. Therefore block mode is suitable for running larger workloads with more than the current limit of 65K pods in a cluster. This mode is better suited to scale with larger subnets of /15 or bigger" + } + ] + }, + "description": "Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "Use Linux." + }, + { + "value": "Windows", + "description": "Use Windows." + } + ] + }, + "description": "The operating system type. The default is Linux." + }, + "OSSKU": { + "type": "string", + "enum": [ + "AzureLinux", + "AzureLinux3", + "CBLMariner", + "Flatcar", + "Mariner", + "Ubuntu", + "Ubuntu2204", + "Ubuntu2404", + "Windows2019", + "Windows2022", + "Windows2025", + "WindowsAnnual" + ], + "x-ms-enum": { + "name": "OSSKU", + "modelAsString": true, + "values": [ + { + "value": "Ubuntu", + "description": "Use Ubuntu as the OS for node images." + }, + { + "value": "Mariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "AzureLinux", + "description": "Use AzureLinux as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information." + }, + { + "value": "AzureLinux3", + "description": "Use AzureLinux3 as the OS for node images. Azure Linux is a container-optimized Linux distro built by Microsoft, visit https://aka.ms/azurelinux for more information. For limitations, visit https://aka.ms/aks/node-images. For OS migration guidance, see https://aka.ms/aks/upgrade-os-version." + }, + { + "value": "Flatcar", + "description": "Use Flatcar Container Linux as the OS for node images. Flatcar is a container-optimized, security-focused Linux OS, with an immutable filesystem and part of the Cloud Native Computing Foundation (CNCF). For more information about Flatcar Container Linux for AKS, see aka.ms/aks/flatcar-container-linux-for-aks" + }, + { + "value": "CBLMariner", + "description": "Deprecated OSSKU. Microsoft recommends that new deployments choose 'AzureLinux' instead." + }, + { + "value": "Windows2019", + "description": "Use Windows2019 as the OS for node images. Unsupported for system node pools. Windows2019 only supports Windows2019 containers; it cannot run Windows2022 containers and vice versa." + }, + { + "value": "Windows2022", + "description": "Use Windows2022 as the OS for node images. Unsupported for system node pools. Windows2022 only supports Windows2022 containers; it cannot run Windows2019 containers and vice versa." + }, + { + "value": "Windows2025", + "description": "Use Windows2025 as the OS for node images. Unsupported for system node pools. Windows2025 supports Windows2022 and Windows 2025 containers; it cannot run Windows2019 containers and vice versa." + }, + { + "value": "WindowsAnnual", + "description": "Use Windows Annual Channel version as the OS for node images. Unsupported for system node pools. Details about supported container images and kubernetes versions under different AKS Annual Channel versions could be seen in https://aka.ms/aks/windows-annual-channel-details." + }, + { + "value": "Ubuntu2204", + "description": "Use Ubuntu2204 as the OS for node images, however, Ubuntu 22.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions" + }, + { + "value": "Ubuntu2404", + "description": "Use Ubuntu2404 as the OS for node images, however, Ubuntu 24.04 may not be supported for all nodepools. For limitations and supported kubernetes versions, see see https://aka.ms/aks/supported-ubuntu-versions" + } + ] + }, + "description": "Specifies the OS SKU used by the agent pool. If not specified, the default is Ubuntu if OSType=Linux or Windows2019 if OSType=Windows. And the default Windows OSSKU will be changed to Windows2022 after Windows2019 is deprecated." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true, + "values": [ + { + "value": "Spot", + "description": "Spot priority VMs will be used. There is no SLA for spot nodes. See [spot on AKS](https://docs.microsoft.com/azure/aks/spot-node-pool) for more information." + }, + { + "value": "Regular", + "description": "Regular VMs will be used." + } + ] + }, + "description": "The Virtual Machine Scale Set priority." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Nodes in the underlying Scale Set of the node pool are deleted when they're evicted." + }, + { + "value": "Deallocate", + "description": "Nodes in the underlying Scale Set of the node pool are set to the stopped-deallocated state upon eviction. Nodes in the stopped-deallocated state count against your compute quota and can cause issues with cluster scaling or upgrading." + } + ] + }, + "description": "The Virtual Machine Scale Set eviction policy. The eviction policy specifies what to do with the VM when it is evicted. The default is Delete. For more information about eviction see [spot VMs](https://docs.microsoft.com/azure/virtual-machines/spot-vms)" + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "description": "The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing)" + }, + "ScaleDownMode": { + "type": "string", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleDownMode", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Create new instances during scale up and remove instances during scale down." + }, + { + "value": "Deallocate", + "description": "Attempt to start deallocated instances (if they exist) during scale up and deallocate instances during scale down." + } + ] + }, + "description": "Describes how VMs are added to or removed from Agent Pools. See [billing states](https://docs.microsoft.com/azure/virtual-machines/states-billing)." + }, + "ProximityPlacementGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/proximityPlacementGroups" + } + ] + }, + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "type": "object", + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "x-ms-identifiers": [], + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "LocalDNSProfile": { + "type": "object", + "description": "Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns.", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Preferred", + "Required", + "Disabled" + ], + "x-ms-enum": { + "name": "LocalDNSMode", + "modelAsString": true, + "values": [ + { + "value": "Preferred", + "description": "If the current orchestrator version supports this feature, prefer enabling localDNS." + }, + { + "value": "Required", + "description": "Enable localDNS." + }, + { + "value": "Disabled", + "description": "Disable localDNS." + } + ] + }, + "description": "Mode of enablement for localDNS.", + "default": "Preferred" + }, + "state": { + "readOnly": true, + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LocalDNSState", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "localDNS is enabled." + }, + { + "value": "Disabled", + "description": "localDNS is disabled." + } + ] + }, + "description": "System-generated state of localDNS." + }, + "vnetDNSOverrides": { + "type": "object", + "description": "VnetDNS overrides apply to DNS traffic from pods with dnsPolicy:default or kubelet (referred to as VnetDNS traffic).", + "$ref": "#/definitions/LocalDNSOverrides" + }, + "kubeDNSOverrides": { + "type": "object", + "description": "KubeDNS overrides apply to DNS traffic from pods with dnsPolicy:ClusterFirst (referred to as KubeDNS traffic).", + "$ref": "#/definitions/LocalDNSOverrides" + } + } + }, + "LocalDNSOverrides": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LocalDNSOverride" + }, + "description": "LocalDNSOverrides is a map of zone names for Vnet and Kube DNS overrides." + }, + "LocalDNSOverride": { + "type": "object", + "description": "Overrides for localDNS profile.", + "properties": { + "queryLogging": { + "type": "string", + "enum": [ + "Error", + "Log" + ], + "x-ms-enum": { + "name": "LocalDNSQueryLogging", + "modelAsString": true, + "values": [ + { + "value": "Error", + "description": "Enables error logging in localDNS. See [errors plugin](https://coredns.io/plugins/errors) for more information." + }, + { + "value": "Log", + "description": "Enables query logging in localDNS. See [log plugin](https://coredns.io/plugins/log) for more information." + } + ] + }, + "description": "Log level for DNS queries in localDNS.", + "default": "Error" + }, + "protocol": { + "type": "string", + "enum": [ + "PreferUDP", + "ForceTCP" + ], + "x-ms-enum": { + "name": "LocalDNSProtocol", + "modelAsString": true, + "values": [ + { + "value": "PreferUDP", + "description": "Prefer UDP protocol for connections from localDNS to upstream DNS server." + }, + { + "value": "ForceTCP", + "description": "Enforce TCP protocol for connections from localDNS to upstream DNS server." + } + ] + }, + "description": "Enforce TCP or prefer UDP protocol for connections from localDNS to upstream DNS server.", + "default": "PreferUDP" + }, + "forwardDestination": { + "type": "string", + "enum": [ + "ClusterCoreDNS", + "VnetDNS" + ], + "x-ms-enum": { + "name": "LocalDNSForwardDestination", + "modelAsString": true, + "values": [ + { + "value": "ClusterCoreDNS", + "description": "Forward DNS queries from localDNS to cluster CoreDNS." + }, + { + "value": "VnetDNS", + "description": "Forward DNS queries from localDNS to DNS server configured in the VNET. A VNET can have multiple DNS servers configured." + } + ] + }, + "description": "Destination server for DNS queries to be forwarded from localDNS.", + "default": "ClusterCoreDNS" + }, + "forwardPolicy": { + "type": "string", + "enum": [ + "Sequential", + "RoundRobin", + "Random" + ], + "x-ms-enum": { + "name": "LocalDNSForwardPolicy", + "modelAsString": true, + "values": [ + { + "value": "Sequential", + "description": "Implements sequential upstream DNS server selection. See [forward plugin](https://coredns.io/plugins/forward) for more information." + }, + { + "value": "RoundRobin", + "description": "Implements round robin upstream DNS server selection. See [forward plugin](https://coredns.io/plugins/forward) for more information." + }, + { + "value": "Random", + "description": "Implements random upstream DNS server selection. See [forward plugin](https://coredns.io/plugins/forward) for more information." + } + ] + }, + "description": "Forward policy for selecting upstream DNS server. See [forward plugin](https://coredns.io/plugins/forward) for more information.", + "default": "Sequential" + }, + "maxConcurrent": { + "type": "integer", + "format": "int32", + "description": "Maximum number of concurrent queries. See [forward plugin](https://coredns.io/plugins/forward) for more information.", + "default": 1000 + }, + "cacheDurationInSeconds": { + "type": "integer", + "format": "int32", + "description": "Cache max TTL in seconds. See [cache plugin](https://coredns.io/plugins/cache) for more information.", + "default": 3600 + }, + "serveStaleDurationInSeconds": { + "type": "integer", + "format": "int32", + "description": "Serve stale duration in seconds. See [cache plugin](https://coredns.io/plugins/cache) for more information.", + "default": 3600 + }, + "serveStale": { + "type": "string", + "enum": [ + "Verify", + "Immediate", + "Disable" + ], + "x-ms-enum": { + "name": "LocalDNSServeStale", + "modelAsString": true, + "values": [ + { + "value": "Verify", + "description": "Serve stale data with verification. First verify that an entry is still unavailable from the source before sending the expired entry to the client. See [cache plugin](https://coredns.io/plugins/cache) for more information." + }, + { + "value": "Immediate", + "description": "Serve stale data immediately. Send the expired entry to the client before checking to see if the entry is available from the source. See [cache plugin](https://coredns.io/plugins/cache) for more information." + }, + { + "value": "Disable", + "description": "Disable serving stale data." + } + ] + }, + "description": "Policy for serving stale data. See [cache plugin](https://coredns.io/plugins/cache) for more information.", + "default": "Immediate" + } + } + }, + "ManagedClusterStatus": { + "type": "object", + "properties": { + "provisioningError": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The error details information of the managed cluster. Preserves the detailed info of failure. If there was no error, this field is omitted." + } + }, + "description": "Contains read-only information about the Managed Cluster." + }, + "AgentPoolStatus": { + "type": "object", + "properties": { + "provisioningError": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "readOnly": true, + "description": "The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted." + } + }, + "description": "Contains read-only information about the Agent Pool." + }, + "ManagedClusterSKU": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a managed cluster SKU.", + "enum": [ + "Base", + "Automatic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true, + "values": [ + { + "value": "Base", + "description": "Base option for the AKS control plane." + }, + { + "value": "Automatic", + "description": "Automatic clusters are optimized to run most production workloads with configuration that follows AKS best practices and recommendations for cluster and workload setup, scalability, and security. For more details about Automatic clusters see aka.ms/aks/automatic." + } + ] + } + }, + "tier": { + "type": "string", + "description": "The tier of a managed cluster SKU. If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details.", + "enum": [ + "Premium", + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true, + "values": [ + { + "value": "Premium", + "description": "Cluster has premium capabilities in addition to all of the capabilities included in 'Standard'. Premium enables selection of LongTermSupport (aka.ms/aks/lts) for certain Kubernetes versions." + }, + { + "value": "Standard", + "description": "Recommended for mission-critical and production workloads. Includes Kubernetes control plane autoscaling, workload-intensive testing, and up to 5,000 nodes per cluster. Guarantees 99.95% availability of the Kubernetes API server endpoint for clusters that use Availability Zones and 99.9% of availability for clusters that don't use Availability Zones." + }, + { + "value": "Free", + "description": "The cluster management is free, but charged for VM, storage, and networking usage. Best for experimenting, learning, simple testing, or workloads with fewer than 10 nodes. Not recommended for production use cases." + } + ] + } + } + }, + "description": "The SKU of a Managed Cluster." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource ID of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + }, + "PrivateLinkResourcesListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + }, + "PrivateLinkResource": { + "description": "A private link resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the private link resource." + }, + "name": { + "type": "string", + "description": "The name of the private link resource.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "type": "string", + "description": "The resource type." + }, + "groupId": { + "type": "string", + "description": "The group ID of the resource." + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The RequiredMembers of the resource" + }, + "privateLinkServiceID": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The private link service ID of the resource, this field is exposed only to NRP internally." + } + } + }, + "OSDiskType": { + "type": "string", + "enum": [ + "Managed", + "Ephemeral" + ], + "x-ms-enum": { + "name": "OSDiskType", + "modelAsString": true, + "values": [ + { + "value": "Managed", + "description": "Azure replicates the operating system disk for a virtual machine to Azure storage to avoid data loss should the VM need to be relocated to another host. Since containers aren't designed to have local state persisted, this behavior offers limited value while providing some drawbacks, including slower node provisioning and higher read/write latency." + }, + { + "value": "Ephemeral", + "description": "Ephemeral OS disks are stored only on the host machine, just like a temporary disk. This provides lower read/write latency, along with faster node scaling and cluster upgrades." + } + ] + }, + "description": "The OS disk type to be used for machines in the agent pool. The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os)." + }, + "KubeletDiskType": { + "type": "string", + "enum": [ + "OS", + "Temporary" + ], + "x-ms-enum": { + "name": "KubeletDiskType", + "modelAsString": true, + "values": [ + { + "value": "OS", + "description": "Kubelet will use the OS disk for its data." + }, + { + "value": "Temporary", + "description": "Kubelet will use the temporary disk for its data." + } + ] + }, + "description": "Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage." + }, + "WorkloadRuntime": { + "type": "string", + "enum": [ + "OCIContainer", + "WasmWasi", + "KataMshvVmIsolation", + "KataVmIsolation" + ], + "x-ms-enum": { + "name": "WorkloadRuntime", + "modelAsString": true, + "values": [ + { + "value": "OCIContainer", + "description": "Nodes will use Kubelet to run standard OCI container workloads." + }, + { + "value": "WasmWasi", + "description": "Nodes will use Krustlet to run WASM workloads using the WASI provider (Preview)." + }, + { + "value": "KataMshvVmIsolation", + "description": "Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods (Preview). Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series. This naming convention will be deprecated in future releases in favor of KataVmIsolation." + }, + { + "value": "KataVmIsolation", + "description": "Nodes can use (Kata + Cloud Hypervisor + Hyper-V) to enable Nested VM-based pods. Due to the use Hyper-V, AKS node OS itself is a nested VM (the root OS) of Hyper-V. Thus it can only be used with VM series that support Nested Virtualization such as Dv3 series." + } + ] + }, + "description": "Determines the type of workload a node can run." + }, + "KubeletConfig": { + "description": "Kubelet configurations of agent nodes. See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "cpuManagerPolicy": { + "type": "string", + "description": "The CPU Manager policy to use. The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'." + }, + "cpuCfsQuota": { + "type": "boolean", + "description": "If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true." + }, + "cpuCfsQuotaPeriod": { + "type": "string", + "description": "The CPU CFS quota period value. The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'." + }, + "imageGcHighThreshold": { + "type": "integer", + "format": "int32", + "description": "The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85%" + }, + "imageGcLowThreshold": { + "type": "integer", + "format": "int32", + "description": "The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80%" + }, + "topologyManagerPolicy": { + "type": "string", + "description": "The Topology Manager policy to use. For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'." + }, + "allowedUnsafeSysctls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`)." + }, + "failSwapOn": { + "type": "boolean", + "description": "If set to true it will make the Kubelet fail to start if swap is enabled on the node." + }, + "containerLogMaxSizeMB": { + "type": "integer", + "format": "int32", + "description": "The maximum size (e.g. 10Mi) of container log file before it is rotated." + }, + "containerLogMaxFiles": { + "type": "integer", + "format": "int32", + "description": "The maximum number of container log files that can be present for a container. The number must be ≥ 2.", + "minimum": 2 + }, + "podMaxPids": { + "type": "integer", + "format": "int32", + "description": "The maximum number of processes per pod." + }, + "seccompDefault": { + "type": "string", + "description": "Specifies the default seccomp profile applied to all workloads. If not specified, 'Unconfined' will be used by default.", + "enum": [ + "Unconfined", + "RuntimeDefault" + ], + "x-ms-enum": { + "name": "SeccompDefault", + "modelAsString": true, + "values": [ + { + "description": "No seccomp profile is applied, allowing all system calls.", + "value": "Unconfined" + }, + { + "description": "The default seccomp profile for container runtime is applied, which restricts certain system calls for enhanced security.", + "value": "RuntimeDefault" + } + ] + } + } + } + }, + "LinuxOSConfig": { + "description": "OS configurations of Linux agent nodes. See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details.", + "type": "object", + "properties": { + "sysctls": { + "$ref": "#/definitions/SysctlConfig", + "description": "Sysctl settings for Linux agent nodes." + }, + "transparentHugePageEnabled": { + "type": "string", + "description": "Whether transparent hugepages are enabled. Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "transparentHugePageDefrag": { + "type": "string", + "description": "Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge)." + }, + "swapFileSizeMB": { + "type": "integer", + "format": "int32", + "description": "The size in MB of a swap file that will be created on each node." + } + } + }, + "AgentPoolWindowsProfile": { + "type": "object", + "description": "The Windows agent pool's specific profile.", + "properties": { + "disableOutboundNat": { + "type": "boolean", + "description": "Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled." + } + } + }, + "AgentPoolSecurityProfile": { + "type": "object", + "properties": { + "sshAccess": { + "$ref": "#/definitions/AgentPoolSSHAccess", + "description": "SSH access method of an agent pool." + }, + "enableVTPM": { + "type": "boolean", + "description": "vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + }, + "enableSecureBoot": { + "type": "boolean", + "description": "Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false." + } + }, + "description": "The security settings of an agent pool." + }, + "GPUProfile": { + "type": "object", + "properties": { + "driver": { + "type": "string", + "description": "Whether to install GPU drivers. When it's not specified, default is Install.", + "enum": [ + "Install", + "None" + ], + "x-ms-enum": { + "name": "GPUDriver", + "modelAsString": true, + "values": [ + { + "value": "Install", + "description": "Install driver." + }, + { + "value": "None", + "description": "Skip driver install." + } + ] + } + }, + "driverType": { + "type": "string", + "enum": [ + "GRID", + "CUDA" + ], + "x-ms-enum": { + "name": "DriverType", + "modelAsString": true, + "values": [ + { + "value": "GRID", + "description": "Install the GRID driver for the GPU, suitable for applications requiring virtualization support." + }, + { + "value": "CUDA", + "description": "Install the CUDA driver for the GPU, optimized for computational tasks in scientific computing and data-intensive applications." + } + ] + }, + "description": "Specify the type of GPU driver to install when creating Windows agent pools. If not provided, AKS selects the driver based on system compatibility. This cannot be changed once the AgentPool has been created. This cannot be set on Linux AgentPools. For Linux AgentPools, the driver is selected based on system compatibility." + } + } + }, + "AgentPoolArtifactStreamingProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Artifact streaming speeds up the cold-start of containers on a node through on-demand image loading. To use this feature, container images must also enable artifact streaming on ACR. If not specified, the default is false." + } + } + }, + "AgentPoolSSHAccess": { + "type": "string", + "enum": [ + "LocalUser", + "Disabled", + "EntraId" + ], + "x-ms-enum": { + "name": "AgentPoolSSHAccess", + "modelAsString": true, + "values": [ + { + "value": "LocalUser", + "description": "Can SSH onto the node as a local user using private key." + }, + { + "value": "Disabled", + "description": "SSH service will be turned off on the node. More information can be found under https://aka.ms/aks/ssh/disable" + }, + { + "value": "EntraId", + "description": "SSH to node with EntraId integration. More information can be found under https://aka.ms/aks/ssh/aad" + } + ] + }, + "description": "SSH access method of an agent pool." + }, + "AgentPoolGatewayProfile": { + "description": "Profile of the managed cluster gateway agent pool.", + "type": "object", + "properties": { + "publicIPPrefixSize": { + "type": "integer", + "format": "int32", + "maximum": 31, + "minimum": 28, + "description": "The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31.", + "default": 31 + } + } + }, + "SysctlConfig": { + "description": "Sysctl settings for Linux agent nodes.", + "type": "object", + "properties": { + "netCoreSomaxconn": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.somaxconn." + }, + "netCoreNetdevMaxBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.netdev_max_backlog." + }, + "netCoreRmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_default." + }, + "netCoreRmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.rmem_max." + }, + "netCoreWmemDefault": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_default." + }, + "netCoreWmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.wmem_max." + }, + "netCoreOptmemMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.core.optmem_max." + }, + "netIpv4TcpMaxSynBacklog": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_syn_backlog." + }, + "netIpv4TcpMaxTwBuckets": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_max_tw_buckets." + }, + "netIpv4TcpFinTimeout": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_fin_timeout." + }, + "netIpv4TcpKeepaliveTime": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_time." + }, + "netIpv4TcpKeepaliveProbes": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.tcp_keepalive_probes." + }, + "netIpv4TcpkeepaliveIntvl": { + "type": "integer", + "format": "int32", + "minimum": 10, + "maximum": 90, + "description": "Sysctl setting net.ipv4.tcp_keepalive_intvl." + }, + "netIpv4TcpTwReuse": { + "type": "boolean", + "description": "Sysctl setting net.ipv4.tcp_tw_reuse." + }, + "netIpv4IpLocalPortRange": { + "type": "string", + "description": "Sysctl setting net.ipv4.ip_local_port_range." + }, + "netIpv4NeighDefaultGcThresh1": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh1." + }, + "netIpv4NeighDefaultGcThresh2": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh2." + }, + "netIpv4NeighDefaultGcThresh3": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting net.ipv4.neigh.default.gc_thresh3." + }, + "netNetfilterNfConntrackMax": { + "type": "integer", + "format": "int32", + "minimum": 131072, + "maximum": 2097152, + "description": "Sysctl setting net.netfilter.nf_conntrack_max." + }, + "netNetfilterNfConntrackBuckets": { + "type": "integer", + "format": "int32", + "minimum": 65536, + "maximum": 524288, + "description": "Sysctl setting net.netfilter.nf_conntrack_buckets." + }, + "fsInotifyMaxUserWatches": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.inotify.max_user_watches." + }, + "fsFileMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.file-max." + }, + "fsAioMaxNr": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.aio-max-nr." + }, + "fsNrOpen": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting fs.nr_open." + }, + "kernelThreadsMax": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting kernel.threads-max." + }, + "vmMaxMapCount": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.max_map_count." + }, + "vmSwappiness": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.swappiness." + }, + "vmVfsCachePressure": { + "type": "integer", + "format": "int32", + "description": "Sysctl setting vm.vfs_cache_pressure." + } + } + }, + "ManagedClusterHTTPProxyConfig": { + "description": "Cluster HTTP proxy configuration.", + "type": "object", + "properties": { + "httpProxy": { + "type": "string", + "description": "The HTTP proxy server endpoint to use." + }, + "httpsProxy": { + "type": "string", + "description": "The HTTPS proxy server endpoint to use." + }, + "noProxy": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The endpoints that should not go through proxy." + }, + "effectiveNoProxy": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "A read-only list of all endpoints for which traffic should not be sent to the proxy. This list is a superset of noProxy and values injected by AKS." + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable HTTP proxy. When disabled, the specified proxy configuration will be not be set on pods and nodes." + } + } + }, + "GPUInstanceProfile": { + "type": "string", + "enum": [ + "MIG1g", + "MIG2g", + "MIG3g", + "MIG4g", + "MIG7g" + ], + "x-ms-enum": { + "name": "GPUInstanceProfile ", + "modelAsString": true + }, + "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU." + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "EdgeZone" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "GuardrailsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "GuardrailsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "GuardrailsAvailableVersion": { + "type": "object", + "description": "Available Guardrails Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/GuardrailsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "GuardrailsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of GuardrailsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuardrailsAvailableVersion" + }, + "description": "Array of AKS supported Guardrails versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Guardrails available version.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersionsProperties": { + "type": "object", + "description": "Whether the version is default or not and support info.", + "properties": { + "isDefaultVersion": { + "type": "boolean", + "readOnly": true + }, + "support": { + "type": "string", + "enum": [ + "Preview", + "Stable" + ], + "x-ms-enum": { + "name": "SafeguardsSupport", + "modelAsString": true, + "values": [ + { + "value": "Preview", + "description": "The version is preview. It is not recommended to use preview versions on critical production clusters. The preview version may not support all use-cases." + }, + { + "value": "Stable", + "description": "The version is stable and can be used on critical production clusters." + } + ] + }, + "description": "Whether the version is preview or stable.", + "readOnly": true + } + } + }, + "SafeguardsAvailableVersion": { + "type": "object", + "description": "Available Safeguards Version", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SafeguardsAvailableVersionsProperties" + } + }, + "required": [ + "properties" + ] + }, + "SafeguardsAvailableVersionsList": { + "type": "object", + "description": "Hold values properties, which is array of SafeguardsVersions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SafeguardsAvailableVersion" + }, + "description": "Array of AKS supported Safeguards versions." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next Safeguards available version.", + "readOnly": true + } + } + }, + "EndpointDependency": { + "description": "A domain name that AKS agent nodes are reaching at.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name of the dependency.", + "type": "string" + }, + "endpointDetails": { + "description": "The Ports and Protocols used when connecting to domainName.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointDetail": { + "description": "connect information from the AKS agent nodes to a single endpoint.", + "type": "object", + "properties": { + "ipAddress": { + "description": "An IP Address that Domain Name currently resolves to.", + "type": "string" + }, + "port": { + "format": "int32", + "description": "The port an endpoint is connected to.", + "type": "integer" + }, + "protocol": { + "description": "The protocol used for connection", + "type": "string" + }, + "description": { + "description": "Description of the detail", + "type": "string" + } + } + }, + "OutboundEnvironmentEndpoint": { + "description": "Egress endpoints which AKS agent nodes connect to for common purpose.", + "type": "object", + "properties": { + "category": { + "description": "The category of endpoints accessed by the AKS agent node, e.g. azure-resource-management, apiserver, etc.", + "type": "string" + }, + "endpoints": { + "description": "The endpoints that AKS agent nodes connect to", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [] + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "description": "Collection of OutboundEnvironmentEndpoint", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterSecurityProfile": { + "type": "object", + "properties": { + "defender": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefender", + "description": "Microsoft Defender settings for the security profile." + }, + "azureKeyVaultKms": { + "$ref": "#/definitions/AzureKeyVaultKms", + "description": "Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile." + }, + "kubernetesResourceObjectEncryptionProfile": { + "$ref": "#/definitions/KubernetesResourceObjectEncryptionProfile", + "description": "Encryption at rest of Kubernetes resource objects. More information on this can be found under https://aka.ms/aks/kubernetesResourceObjectEncryption" + }, + "workloadIdentity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileWorkloadIdentity", + "description": "Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details." + }, + "imageCleaner": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageCleaner", + "description": "Image Cleaner settings for the security profile." + }, + "imageIntegrity": { + "$ref": "#/definitions/ManagedClusterSecurityProfileImageIntegrity", + "description": "Image integrity is a feature that works with Azure Policy to verify image integrity by signature. This will not have any effect unless Azure Policy is applied to enforce image signatures. See https://aka.ms/aks/image-integrity for how to use this feature via policy." + }, + "nodeRestriction": { + "$ref": "#/definitions/ManagedClusterSecurityProfileNodeRestriction", + "description": "[Node Restriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) settings for the security profile." + }, + "customCATrustCertificates": { + "$ref": "#/definitions/ManagedClusterSecurityProfileCustomCATrustCertificates", + "description": "A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority)." + } + }, + "description": "Security profile for the container service cluster." + }, + "ManagedClusterSecurityProfileDefender": { + "type": "object", + "properties": { + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty." + }, + "securityMonitoring": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityMonitoring", + "description": "Microsoft Defender threat detection for Cloud settings for the security profile." + }, + "securityGating": { + "$ref": "#/definitions/ManagedClusterSecurityProfileDefenderSecurityGating", + "description": "Microsoft Defender settings for security gating, validates container images eligibility for deployment based on Defender for Containers security findings. Using Admission Controller, it either audits or prevents the deployment of images that do not meet security standards." + } + }, + "description": "Microsoft Defender settings for the security profile." + }, + "ManagedClusterSecurityProfileDefenderSecurityMonitoring": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender threat detection" + } + }, + "description": "Microsoft Defender settings for the security profile threat detection." + }, + "ManagedClusterSecurityProfileDefenderSecurityGating": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Defender security gating. When enabled, the gating feature will scan container images and audit or block the deployment of images that do not meet security standards according to the configured security rules." + }, + "identities": { + "type": "array", + "description": "List of identities that the admission controller will make use of in order to pull security artifacts from the registry. These are the same identities used by the cluster to pull container images. Each identity provided should have federated identity credential attached to it.", + "items": { + "type": "object", + "properties": { + "azureContainerRegistry": { + "type": "string", + "description": "The container registry for which the identity will be used; the identity specified here should have a federated identity credential attached to it." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "The identity object used to access the registry" + } + } + } + }, + "allowSecretAccess": { + "type": "boolean", + "description": "In use only while registry access granted by secret rather than managed identity. Set whether to grant the Defender gating agent access to the cluster's secrets for pulling images from registries. If secret access is denied and the registry requires pull secrets, the add-on will not perform any image validation. Default value is false." + } + }, + "description": "Microsoft Defender settings for security gating, validates container images eligibility for deployment based on Defender for Containers security findings. Using Admission Controller, it either audits or prevents the deployment of images that do not meet security standards." + }, + "ManagedClusterStorageProfile": { + "type": "object", + "properties": { + "diskCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileDiskCSIDriver", + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "fileCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileFileCSIDriver", + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "snapshotController": { + "$ref": "#/definitions/ManagedClusterStorageProfileSnapshotController", + "description": "Snapshot Controller settings for the storage profile." + }, + "blobCSIDriver": { + "$ref": "#/definitions/ManagedClusterStorageProfileBlobCSIDriver", + "description": "AzureBlob CSI Driver settings for the storage profile." + } + }, + "description": "Storage profile for the container service cluster." + }, + "AzureKeyVaultKms": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Azure Key Vault key management service. The default is false." + }, + "keyId": { + "type": "string", + "description": "Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty." + }, + "keyVaultNetworkAccess": { + "type": "string", + "enum": [ + "Public", + "Private" + ], + "default": "Public", + "x-ms-enum": { + "name": "KeyVaultNetworkAccessTypes", + "modelAsString": true + }, + "description": "Network access of the key vault. Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`." + }, + "keyVaultResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty." + } + }, + "description": "Azure Key Vault key management service settings for the security profile." + }, + "KubernetesResourceObjectEncryptionProfile": { + "type": "object", + "properties": { + "infrastructureEncryption": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Disabled", + "description": "Whether to enable encryption at rest of Kubernetes resource objects using service-managed keys. More information on this can be found under https://aka.ms/aks/kubernetesResourceObjectEncryption.", + "x-ms-enum": { + "modelAsString": true, + "name": "InfrastructureEncryption", + "values": [ + { + "description": "Encryption at rest of Kubernetes resource objects using service-managed keys is enabled. More information on this can be found under https://aka.ms/aks/kubernetesResourceObjectEncryption.", + "value": "Enabled" + }, + { + "description": "Encryption at rest of Kubernetes resource objects using service-managed keys is disabled. More information on this can be found under https://aka.ms/aks/kubernetesResourceObjectEncryption.", + "value": "Disabled" + } + ] + } + } + }, + "description": "Encryption at rest of Kubernetes resource objects using service-managed keys. More information on this can be found under https://aka.ms/aks/kubernetesResourceObjectEncryption." + }, + "ManagedClusterIngressProfile": { + "type": "object", + "properties": { + "gatewayAPI": { + "$ref": "#/definitions/ManagedClusterIngressProfileGatewayConfiguration", + "description": "Settings for the managed Gateway API installation" + }, + "webAppRouting": { + "$ref": "#/definitions/ManagedClusterIngressProfileWebAppRouting", + "description": "Web App Routing settings for the ingress profile." + }, + "applicationLoadBalancer": { + "$ref": "#/definitions/ManagedClusterIngressProfileApplicationLoadBalancer", + "description": "Settings for the managed Application Load Balancer installation" + } + }, + "description": "Ingress profile for the container service cluster." + }, + "ManagedClusterIngressProfileGatewayConfiguration": { + "type": "object", + "properties": { + "installation": { + "type": "string", + "description": "Configuration for the managed Gateway API installation. If not specified, the default is 'Disabled'. See https://aka.ms/k8s-gateway-api for more details.", + "enum": [ + "Disabled", + "Standard" + ], + "x-ms-enum": { + "name": "ManagedGatewayType", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Gateway API CRDs will not be reconciled on your cluster." + }, + { + "value": "Standard", + "description": "The latest Gateway CRD bundle from the standard channel that is compatible with your Kubernetes version will be reconciled onto your cluster. See https://gateway-api.sigs.k8s.io/concepts/versioning/ for more details." + } + ] + } + } + } + }, + "ManagedClusterIngressProfileWebAppRouting": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Web App Routing." + }, + "dnsZoneResourceIds": { + "type": "array", + "items": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/dnszones" + }, + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + } + }, + "maxItems": 5, + "description": "Resource IDs of the DNS zones to be associated with the Web App Routing add-on. Used only when Web App Routing is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group." + }, + "nginx": { + "$ref": "#/definitions/ManagedClusterIngressProfileNginx", + "description": "Configuration for the default NginxIngressController. See more at https://learn.microsoft.com/en-us/azure/aks/app-routing-nginx-configuration#the-default-nginx-ingress-controller." + }, + "defaultDomain": { + "$ref": "#/definitions/ManagedClusterIngressDefaultDomainProfile", + "description": "Configuration for the Default Domain. This is a unique, autogenerated domain that comes with a signed TLS Certificate allowing for secure HTTPS. See [the Default Domain documentation](https://aka.ms/aks/defaultdomain) for more instructions." + }, + "identity": { + "readOnly": true, + "type": "object", + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Web Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions." + } + }, + "description": "Web App Routing settings for the ingress profile." + }, + "ManagedClusterIngressProfileApplicationLoadBalancer": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Application Load Balancer." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Managed identity of the Application Load Balancer add-on. This is the identity that should be granted permissions to manage the associated Application Gateway for Containers resource.", + "readOnly": true, + "type": "object" + } + }, + "description": "Application Load Balancer settings for the ingress profile." + }, + "ManagedClusterIngressProfileNginx": { + "type": "object", + "properties": { + "defaultIngressControllerType": { + "type": "string", + "description": "Ingress type for the default NginxIngressController custom resource", + "enum": [ + "AnnotationControlled", + "External", + "Internal", + "None" + ], + "x-ms-enum": { + "name": "NginxIngressControllerType", + "modelAsString": true, + "values": [ + { + "value": "AnnotationControlled", + "description": "The default NginxIngressController will be created. Users can edit the default NginxIngressController Custom Resource to configure load balancer annotations." + }, + { + "value": "External", + "description": "The default NginxIngressController will be created and the operator will provision an external loadbalancer with it. Any annotation to make the default loadbalancer internal will be overwritten." + }, + { + "value": "Internal", + "description": "The default NginxIngressController will be created and the operator will provision an internal loadbalancer with it. Any annotation to make the default loadbalancer external will be overwritten." + }, + { + "value": "None", + "description": "The default Ingress Controller will not be created. It will not be deleted by the system if it exists. Users should delete the default NginxIngressController Custom Resource manually if desired." + } + ] + } + } + } + }, + "ManagedClusterIngressDefaultDomainProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Default Domain." + }, + "domainName": { + "readOnly": true, + "type": "string", + "description": "The unique fully qualified domain name assigned to the cluster. This will not change even if disabled then reenabled." + } + } + }, + "ManagedClusterSecurityProfileWorkloadIdentity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable workload identity." + } + }, + "description": "Workload identity settings for the security profile." + }, + "ManagedClusterSecurityProfileImageCleaner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Image Cleaner on AKS cluster." + }, + "intervalHours": { + "type": "integer", + "format": "int32", + "description": "Image Cleaner scanning interval in hours." + } + }, + "description": "Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile." + }, + "ManagedClusterSecurityProfileImageIntegrity": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable image integrity. The default value is false." + } + }, + "description": "Image integrity related settings for the security profile." + }, + "ManagedClusterSecurityProfileNodeRestriction": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Node Restriction" + } + }, + "description": "Node Restriction settings for the security profile." + }, + "ManagedClusterSecurityProfileCustomCATrustCertificates": { + "type": "array", + "items": { + "type": "string", + "format": "byte" + }, + "minItems": 0, + "maxItems": 10, + "description": "The list of base64 encoded certificate strings that will be added to the node trust store. At most 10 certificates can be provided. Certificates will be added to trust stores of all the nodes in the cluster. If updated, the new list of certificates will be installed in the trust store in place of the old certificates. For node pools of VMSS type, updating the value of this field will result in nodes being reimaged." + }, + "ManagedClusterStorageProfileDiskCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureDisk CSI Driver. The default value is true." + }, + "version": { + "type": "string", + "description": "The version of AzureDisk CSI Driver. The default value is v1." + } + }, + "description": "AzureDisk CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileFileCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureFile CSI Driver. The default value is true." + } + }, + "description": "AzureFile CSI Driver settings for the storage profile." + }, + "ManagedClusterStorageProfileSnapshotController": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable Snapshot Controller. The default value is true." + } + }, + "description": "Snapshot Controller settings for the storage profile." + }, + "ManagedClusterStorageProfileBlobCSIDriver": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AzureBlob CSI Driver. The default value is false." + } + }, + "description": "AzureBlob CSI Driver settings for the storage profile." + }, + "CreationData": { + "description": "Data used when creating a target resource from a source resource.", + "type": "object", + "properties": { + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "This is the ARM ID of the source object to be used to create the target object." + } + } + }, + "SnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "The list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Snapshots operation." + }, + "ManagedClusterSnapshotListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterSnapshot" + }, + "description": "The list of managed cluster snapshots." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster snapshot results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Cluster Snapshots operation." + }, + "Snapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a snapshot.", + "$ref": "#/definitions/SnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A node pool snapshot resource." + }, + "ManagedClusterSnapshot": { + "type": "object", + "properties": { + "properties": { + "description": "Properties of a managed cluster snapshot.", + "$ref": "#/definitions/ManagedClusterSnapshotProperties", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "A managed cluster snapshot resource." + }, + "SnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source agent pool resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "kubernetesVersion": { + "readOnly": true, + "type": "string", + "description": "The version of Kubernetes." + }, + "nodeImageVersion": { + "readOnly": true, + "type": "string", + "description": "The version of node image." + }, + "osType": { + "readOnly": true, + "$ref": "#/definitions/OSType" + }, + "osSku": { + "readOnly": true, + "$ref": "#/definitions/OSSKU" + }, + "vmSize": { + "readOnly": true, + "type": "string", + "description": "The size of the VM." + }, + "enableFIPS": { + "readOnly": true, + "type": "boolean", + "description": "Whether to use a FIPS-enabled OS." + } + }, + "description": "Properties used to configure a node pool snapshot." + }, + "ManagedClusterSnapshotProperties": { + "type": "object", + "properties": { + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "CreationData to be used to specify the source resource ID to create this snapshot." + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType" + }, + "managedClusterPropertiesReadOnly": { + "$ref": "#/definitions/ManagedClusterPropertiesForSnapshot", + "description": "What the properties will be showed when getting managed cluster snapshot. Those properties are read-only." + } + }, + "description": "Properties for a managed cluster snapshot." + }, + "ManagedClusterPropertiesForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The current kubernetes version." + }, + "sku": { + "type": "object", + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The current managed cluster sku." + }, + "enableRbac": { + "type": "boolean", + "description": "Whether the cluster has enabled Kubernetes Role-Based Access Control or not." + }, + "networkProfile": { + "type": "object", + "$ref": "#/definitions/NetworkProfileForSnapshot", + "description": "The current network profile." + } + }, + "description": "managed cluster properties for snapshot, these properties are read only." + }, + "NetworkProfileForSnapshot": { + "type": "object", + "readOnly": true, + "properties": { + "networkPlugin": { + "$ref": "#/definitions/NetworkPlugin", + "description": "networkPlugin for managed cluster snapshot." + }, + "networkPluginMode": { + "$ref": "#/definitions/NetworkPluginMode", + "description": "NetworkPluginMode for managed cluster snapshot." + }, + "networkPolicy": { + "$ref": "#/definitions/NetworkPolicy", + "description": "networkPolicy for managed cluster snapshot." + }, + "networkMode": { + "$ref": "#/definitions/NetworkMode", + "description": "networkMode for managed cluster snapshot." + }, + "loadBalancerSku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "loadBalancerSku for managed cluster snapshot." + } + }, + "description": "network profile for managed cluster snapshot, these properties are read only." + }, + "NetworkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet", + "none" + ], + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use the Azure CNI network plugin. See [Azure CNI (advanced) networking](https://docs.microsoft.com/azure/aks/concepts-network#azure-cni-advanced-networking) for more information." + }, + { + "value": "kubenet", + "description": "Use the Kubenet network plugin. See [Kubenet (basic) networking](https://docs.microsoft.com/azure/aks/concepts-network#kubenet-basic-networking) for more information." + }, + { + "value": "none", + "description": "Do not use a network plugin. A custom CNI will need to be installed after cluster creation for networking functionality." + } + ] + }, + "description": "Network plugin used for building the Kubernetes network." + }, + "NetworkPluginMode": { + "type": "string", + "enum": [ + "overlay" + ], + "x-ms-enum": { + "name": "NetworkPluginMode", + "modelAsString": true, + "values": [ + { + "value": "overlay", + "description": "Pods are given IPs from the PodCIDR address space but use Azure Routing Domains rather than Kubenet reference plugins host-local and bridge." + } + ] + }, + "description": "The mode the network plugin should use." + }, + "NetworkPolicy": { + "type": "string", + "enum": [ + "none", + "calico", + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true, + "values": [ + { + "value": "none", + "description": "Network policies will not be enforced. This is the default value when NetworkPolicy is not specified." + }, + { + "value": "calico", + "description": "Use Calico network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "azure", + "description": "Use Azure network policies. See [differences between Azure and Calico policies](https://docs.microsoft.com/azure/aks/use-network-policies#differences-between-azure-and-calico-policies-and-their-capabilities) for more information." + }, + { + "value": "cilium", + "description": "Use Cilium to enforce network policies. This requires networkDataplane to be 'cilium'." + } + ] + }, + "description": "Network policy used for building the Kubernetes network." + }, + "NetworkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true, + "values": [ + { + "value": "transparent", + "description": "No bridge is created. Intra-VM Pod to Pod communication is through IP routes created by Azure CNI. See [Transparent Mode](https://docs.microsoft.com/azure/aks/faq#transparent-mode) for more information." + }, + { + "value": "bridge", + "description": "This is no longer supported" + } + ] + }, + "description": "The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'." + }, + "NetworkDataplane": { + "type": "string", + "enum": [ + "azure", + "cilium" + ], + "x-ms-enum": { + "name": "networkDataplane", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Use Azure network dataplane." + }, + { + "value": "cilium", + "description": "Use Cilium network dataplane. See [Azure CNI Powered by Cilium](https://learn.microsoft.com/azure/aks/azure-cni-powered-by-cilium) for more information." + } + ] + }, + "description": "Network dataplane used in the Kubernetes cluster." + }, + "AdvancedNetworking": { + "type": "object", + "description": "Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false." + }, + "observability": { + "$ref": "#/definitions/AdvancedNetworkingObservability" + }, + "security": { + "$ref": "#/definitions/AdvancedNetworkingSecurity" + }, + "performance": { + "$ref": "#/definitions/AdvancedNetworkingPerformance" + } + } + }, + "AdvancedNetworkingObservability": { + "type": "object", + "description": "Observability profile to enable advanced network metrics and flow logs with historical contexts.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates the enablement of Advanced Networking observability functionalities on clusters." + } + } + }, + "AdvancedNetworkingSecurity": { + "type": "object", + "description": "Security profile to enable security features on cilium-based cluster.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Configure Advanced Networking Security features on Cilium clusters. See individual fields for their default values." + }, + "advancedNetworkPolicies": { + "type": "string", + "enum": [ + "L7", + "FQDN", + "None" + ], + "x-ms-enum": { + "name": "advancedNetworkPolicies", + "modelAsString": true, + "values": [ + { + "value": "L7", + "description": "Enable Layer7 network policies (FQDN, HTTP/S, Kafka). This option is a superset of the FQDN option." + }, + { + "value": "FQDN", + "description": "Enable FQDN based network policies" + }, + { + "value": "None", + "description": "Disable Layer 7 network policies (FQDN, HTTP/S, Kafka)" + } + ] + }, + "description": "Enable advanced network policies. This allows users to configure Layer 7 network policies (FQDN, HTTP, Kafka). Policies themselves must be configured via the Cilium Network Policy resources, see https://docs.cilium.io/en/latest/security/policy/index.html. This can be enabled only on cilium-based clusters. If not specified, the default value is FQDN if security.enabled is set to true." + }, + "transitEncryption": { + "type": "object", + "description": "Encryption configuration for Cilium-based clusters. Once enabled all traffic between Cilium managed pods will be encrypted when it leaves the node boundary.", + "properties": { + "type": { + "type": "string", + "enum": [ + "None", + "WireGuard" + ], + "x-ms-enum": { + "name": "transitEncryptionType", + "modelAsString": true, + "values": [ + { + "value": "WireGuard", + "description": "Enable WireGuard encryption. Refer to https://docs.cilium.io/en/latest/security/network/encryption-wireguard/ on use cases and implementation details" + }, + { + "value": "None", + "description": "Disable Transit encryption" + } + ] + }, + "description": "Configures pod-to-pod encryption. This can be enabled only on Cilium-based clusters. If not specified, the default value is None." + } + } + } + } + }, + "AdvancedNetworkingPerformance": { + "type": "object", + "description": "Profile to enable performance-enhancing features on clusters that use Azure CNI powered by Cilium.", + "properties": { + "accelerationMode": { + "type": "string", + "enum": [ + "BpfVeth", + "None" + ], + "x-ms-enum": { + "name": "AccelerationMode", + "modelAsString": true, + "values": [ + { + "value": "BpfVeth", + "description": "Enable eBPF host routing with veth device mode." + }, + { + "value": "None", + "description": "Disable acceleration options." + } + ] + }, + "default": "None", + "description": "Enable advanced network acceleration options. This allows users to configure acceleration using BPF host routing. This can be enabled only with Cilium dataplane. If not specified, the default value is None (no acceleration). The acceleration mode can be changed on a pre-existing cluster. See https://aka.ms/acnsperformance for a detailed explanation" + } + } + }, + "LoadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Use a a standard Load Balancer. This is the recommended Load Balancer SKU. For more information about on working with the load balancer in the managed cluster, see the [standard Load Balancer](https://docs.microsoft.com/azure/aks/load-balancer-standard) article." + }, + { + "value": "basic", + "description": "Use a basic Load Balancer with limited functionality." + } + ] + }, + "description": "The load balancer sku for the managed cluster. The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs." + }, + "SnapshotType": { + "type": "string", + "default": "NodePool", + "enum": [ + "NodePool", + "ManagedCluster" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "value": "NodePool", + "description": "The snapshot is a snapshot of a node pool." + }, + { + "value": "ManagedCluster", + "description": "The snapshot is a snapshot of a managed cluster." + } + ] + }, + "description": "The type of a snapshot. The default is NodePool." + }, + "CapacityReservationGroupID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/CapacityReservationGroups" + } + ] + }, + "description": "The fully qualified resource ID of the Capacity Reservation Group to provide virtual machines from a reserved group of Virtual Machines. This is of the form: '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Compute/capacityreservationgroups/{capacityReservationGroupName}'. Customers use it to create an agentpool and to update an existing agentpool with a CapacityReservationGroupID. If customers explicitly specify this CapacityReservationGroupID as an empty string, AKS will disassociate the existing CRG from the nodepool. For more information see [Capacity Reservation](https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview)" + }, + "TrustedAccessRoleRule": { + "type": "object", + "description": "Rule for trusted access role", + "properties": { + "verbs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed verbs" + }, + "apiGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed apiGroups" + }, + "resources": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed resources" + }, + "resourceNames": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed names" + }, + "nonResourceURLs": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of allowed nonResourceURLs" + } + } + }, + "TrustedAccessRole": { + "type": "object", + "description": "Trusted access role definition.", + "properties": { + "sourceResourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type of Azure resource" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Name of role, name is unique under a source resource type" + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRoleRule" + }, + "x-ms-identifiers": [], + "description": "List of rules for the role. This maps to 'rules' property of [Kubernetes Cluster Role](https://kubernetes.io/docs/reference/kubernetes-api/authorization-resources/cluster-role-v1/#ClusterRole)." + } + } + }, + "TrustedAccessRoleListResult": { + "type": "object", + "description": "List of trusted access roles", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TrustedAccessRole" + }, + "x-ms-identifiers": [ + "sourceResourceType", + "name" + ], + "description": "Role list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "TrustedAccessRoleBindingProperties": { + "type": "object", + "description": "Properties for trusted access role binding", + "required": [ + "sourceResourceId", + "roles" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of trusted access role binding.", + "enum": [ + "Canceled", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "TrustedAccessRoleBindingProvisioningState", + "modelAsString": true + } + }, + "sourceResourceId": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource ID of source resource that trusted access is configured for." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of roles to bind, each item is a resource type qualified role name. For example: 'Microsoft.MachineLearningServices/workspaces/reader'." + } + } + }, + "TrustedAccessRoleBinding": { + "type": "object", + "description": "Defines binding between a resource and role", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TrustedAccessRoleBindingProperties", + "x-ms-client-flatten": true + } + } + }, + "TrustedAccessRoleBindingListResult": { + "type": "object", + "description": "List of trusted access role bindings", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedAccessRoleBinding" + }, + "description": "Role binding list" + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedClusterWorkloadAutoScalerProfile": { + "type": "object", + "description": "Workload Auto-scaler profile for the managed cluster.", + "properties": { + "keda": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileKeda" + }, + "verticalPodAutoscaler": { + "$ref": "#/definitions/ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler" + } + } + }, + "ManagedClusterWorkloadAutoScalerProfileKeda": { + "type": "object", + "description": "KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable KEDA." + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscaler": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable VPA add-on in cluster. Default value is false.", + "default": false + }, + "addonAutoscaling": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AddonAutoscaling", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Feature to autoscale AKS-managed add-ons is enabled. The default VPA update mode is Initial mode." + }, + { + "value": "Disabled", + "description": "Feature to autoscale AKS-managed add-ons is disabled." + } + ] + }, + "description": "Whether VPA add-on is enabled and configured to scale AKS-managed add-ons.", + "default": "Disabled" + } + }, + "required": [ + "enabled" + ] + }, + "ManagedClusterAzureMonitorProfile": { + "type": "object", + "description": "Prometheus addon profile for the container service cluster", + "properties": { + "metrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileMetrics" + }, + "containerInsights": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileContainerInsights" + }, + "appMonitoring": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoring" + } + } + }, + "ManagedClusterAzureMonitorProfileKubeStateMetrics": { + "type": "object", + "description": "Kube State Metrics for prometheus addon profile for the container service cluster", + "properties": { + "metricLabelsAllowlist": { + "type": "string", + "description": "Comma-separated list of Kubernetes annotations keys that will be used in the resource's labels metric. " + }, + "metricAnnotationsAllowList": { + "type": "string", + "description": "Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric." + } + } + }, + "ManagedClusterAzureMonitorProfileMetrics": { + "type": "object", + "description": "Metrics profile for the prometheus service addon", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the Prometheus collector" + }, + "kubeStateMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileKubeStateMetrics" + } + }, + "required": [ + "enabled" + ] + }, + "ServiceMeshProfile": { + "type": "object", + "description": "Service mesh profile for a managed cluster.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of the service mesh.", + "enum": [ + "Istio", + "Disabled" + ], + "x-ms-enum": { + "name": "ServiceMeshMode", + "modelAsString": true, + "values": [ + { + "value": "Istio", + "description": "Istio deployed as an AKS addon." + }, + { + "value": "Disabled", + "description": "Mesh is disabled." + } + ] + } + }, + "istio": { + "$ref": "#/definitions/IstioServiceMesh" + } + }, + "required": [ + "mode" + ] + }, + "IstioServiceMesh": { + "type": "object", + "description": "Istio service mesh configuration.", + "properties": { + "components": { + "$ref": "#/definitions/IstioComponents" + }, + "certificateAuthority": { + "$ref": "#/definitions/IstioCertificateAuthority" + }, + "revisions": { + "type": "array", + "description": "The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade", + "items": { + "type": "string" + }, + "uniqueItems": true, + "maxItems": 2 + } + } + }, + "IstioComponents": { + "type": "object", + "description": "Istio components configuration.", + "properties": { + "ingressGateways": { + "type": "array", + "description": "Istio ingress gateways.", + "items": { + "$ref": "#/definitions/IstioIngressGateway" + }, + "x-ms-identifiers": [] + }, + "egressGateways": { + "type": "array", + "description": "Istio egress gateways.", + "items": { + "$ref": "#/definitions/IstioEgressGateway" + }, + "x-ms-identifiers": [] + }, + "proxyRedirectionMechanism": { + "type": "string", + "description": "Mode of traffic redirection.", + "enum": [ + "InitContainers", + "CNIChaining" + ], + "x-ms-enum": { + "name": "ProxyRedirectionMechanism", + "modelAsString": true, + "values": [ + { + "value": "InitContainers", + "description": "Istio will inject an init container into each pod to redirect traffic (requires NET_ADMIN and NET_RAW)." + }, + { + "value": "CNIChaining", + "description": "Istio will install a chained CNI plugin to redirect traffic (recommended)." + } + ] + } + } + } + }, + "IstioIngressGateway": { + "type": "object", + "description": "Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`.", + "properties": { + "mode": { + "type": "string", + "description": "Mode of an ingress gateway.", + "enum": [ + "External", + "Internal" + ], + "x-ms-enum": { + "name": "IstioIngressGatewayMode", + "modelAsString": true, + "values": [ + { + "value": "External", + "description": "The ingress gateway is assigned a public IP address and is publicly accessible." + }, + { + "value": "Internal", + "description": "The ingress gateway is assigned an internal IP address and cannot is accessed publicly." + } + ] + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to enable the ingress gateway." + } + }, + "required": [ + "mode", + "enabled" + ] + }, + "IstioCertificateAuthority": { + "type": "object", + "description": "Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca", + "properties": { + "plugin": { + "$ref": "#/definitions/IstioPluginCertificateAuthority" + } + } + }, + "IstioPluginCertificateAuthority": { + "type": "object", + "description": "Plugin certificates information for Service Mesh.", + "properties": { + "keyVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + }, + "description": "The resource ID of the Key Vault." + }, + "certObjectName": { + "type": "string", + "description": "Intermediate certificate object name in Azure Key Vault." + }, + "keyObjectName": { + "type": "string", + "description": "Intermediate certificate private key object name in Azure Key Vault." + }, + "rootCertObjectName": { + "type": "string", + "description": "Root certificate object name in Azure Key Vault." + }, + "certChainObjectName": { + "type": "string", + "description": "Certificate chain object name in Azure Key Vault." + } + } + }, + "IstioEgressGateway": { + "type": "object", + "description": "Istio egress gateway configuration.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable the egress gateway." + }, + "name": { + "type": "string", + "description": "Name of the Istio add-on egress gateway.", + "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*" + }, + "namespace": { + "type": "string", + "description": "Namespace that the Istio add-on egress gateway should be deployed in. If unspecified, the default is aks-istio-egress." + }, + "gatewayConfigurationName": { + "type": "string", + "description": "Name of the gateway configuration custom resource for the Istio add-on egress gateway. Must be specified when enabling the Istio egress gateway. Must be deployed in the same namespace that the Istio egress gateway will be deployed in." + } + }, + "required": [ + "enabled", + "name" + ] + }, + "MeshRevisionProfileList": { + "type": "object", + "description": "Holds an array of MeshRevisionsProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevisionProfile" + }, + "description": "Array of service mesh add-on revision profiles for all supported mesh modes." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh revision profile.", + "readOnly": true + } + } + }, + "MeshRevisionProfile": { + "type": "object", + "description": "Mesh revision profile for a mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshRevisionProfileProperties" + } + } + }, + "MeshRevisionProfileProperties": { + "type": "object", + "description": "Mesh revision profile properties for a mesh", + "properties": { + "meshRevisions": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshRevision" + } + } + } + }, + "MeshUpgradeProfileList": { + "type": "object", + "description": "Holds an array of MeshUpgradeProfiles", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MeshUpgradeProfile" + }, + "description": "Array of supported service mesh add-on upgrade profiles." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh upgrade profile.", + "readOnly": true + } + } + }, + "MeshUpgradeProfile": { + "type": "object", + "description": "Upgrade profile for given mesh.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MeshUpgradeProfileProperties" + } + } + }, + "MeshUpgradeProfileProperties": { + "type": "object", + "description": "Mesh upgrade profile properties for a major.minor release.", + "allOf": [ + { + "$ref": "#/definitions/MeshRevision" + } + ] + }, + "MeshRevision": { + "type": "object", + "description": "Holds information on upgrades and compatibility for given major.minor mesh release.", + "properties": { + "revision": { + "type": "string", + "description": "The revision of the mesh release." + }, + "upgrades": { + "type": "array", + "description": "List of revisions available for upgrade of a specific mesh revision", + "items": { + "type": "string", + "description": "An upgradeable mesh revision" + } + }, + "compatibleWith": { + "type": "array", + "description": "List of items this revision of service mesh is compatible with, and their associated versions.", + "items": { + "$ref": "#/definitions/CompatibleVersions" + }, + "x-ms-identifiers": [] + } + } + }, + "CompatibleVersions": { + "type": "object", + "description": "Version information about a product/service that is compatible with a service mesh revision.", + "properties": { + "name": { + "type": "string", + "description": "The product/service name." + }, + "versions": { + "type": "array", + "description": "Product/service versions compatible with a service mesh add-on revision.", + "items": { + "type": "string", + "description": "A compatible product/service version." + } + } + } + }, + "KubernetesSupportPlan": { + "type": "string", + "description": "Different support tiers for AKS managed clusters", + "enum": [ + "KubernetesOfficial", + "AKSLongTermSupport" + ], + "x-ms-enum": { + "name": "KubernetesSupportPlan", + "modelAsString": true, + "values": [ + { + "value": "KubernetesOfficial", + "description": "Support for the version is the same as for the open source Kubernetes offering. Official Kubernetes open source community support versions for 1 year after release." + }, + { + "value": "AKSLongTermSupport", + "description": "Support for the version extended past the KubernetesOfficial support of 1 year. AKS continues to patch CVEs for another 1 year, for a total of 2 years of support." + } + ] + } + }, + "KubernetesVersionCapabilities": { + "type": "object", + "description": "Capabilities on this Kubernetes version.", + "properties": { + "supportPlan": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesSupportPlan" + } + } + } + }, + "KubernetesPatchVersion": { + "type": "object", + "description": "Kubernetes patch version profile", + "properties": { + "upgrades": { + "type": "array", + "description": "Possible upgrade path for given patch version", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "KubernetesVersion": { + "type": "object", + "description": "Kubernetes version profile for given major.minor release.", + "properties": { + "version": { + "type": "string", + "description": "major.minor version of Kubernetes release" + }, + "capabilities": { + "$ref": "#/definitions/KubernetesVersionCapabilities", + "description": "Capabilities on this Kubernetes version." + }, + "isDefault": { + "type": "boolean", + "description": "Whether this version is default." + }, + "isPreview": { + "type": "boolean", + "description": "Whether this version is in preview mode." + }, + "patchVersions": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KubernetesPatchVersion" + }, + "description": "Patch versions of Kubernetes release" + } + } + }, + "KubernetesVersionListResult": { + "type": "object", + "description": "Hold values properties, which is array of KubernetesVersion", + "properties": { + "values": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/KubernetesVersion" + }, + "description": "Array of AKS supported Kubernetes versions." + } + } + }, + "ManagedClusterAzureMonitorProfileContainerInsights": { + "type": "object", + "description": "Azure Monitor Container Insights Profile for Kubernetes Events, Inventory and Container stdout & stderr logs etc. See aka.ms/AzureMonitorContainerInsights for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Azure Monitor Container Insights Logs Addon is enabled or not." + }, + "logAnalyticsWorkspaceResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.OperationalInsights/workspaces" + } + ] + }, + "description": "Fully Qualified ARM Resource Id of Azure Log Analytics Workspace for storing Azure Monitor Container Insights Logs." + }, + "syslogPort": { + "type": "integer", + "format": "int64", + "description": "The syslog host port. If not specified, the default port is 28330." + }, + "disableCustomMetrics": { + "type": "boolean", + "description": "Indicates whether custom metrics collection has to be disabled or not. If not specified the default is false. No custom metrics will be emitted if this field is false but the container insights enabled field is false" + }, + "disablePrometheusMetricsScraping": { + "type": "boolean", + "description": "Indicates whether prometheus metrics scraping is disabled or not. If not specified the default is false. No prometheus metrics will be emitted if this field is false but the container insights enabled field is false" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoring": { + "type": "object", + "description": "Application Monitoring Profile for Kubernetes Application Container. Collects application logs, metrics and traces through auto-instrumentation of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "autoInstrumentation": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation" + }, + "openTelemetryMetrics": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics" + }, + "openTelemetryLogs": { + "$ref": "#/definitions/ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs" + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringAutoInstrumentation": { + "type": "object", + "description": "Application Monitoring Auto Instrumentation for Kubernetes Application Container. Deploys web hook to auto-instrument Azure Monitor OpenTelemetry based SDKs to collect OpenTelemetry metrics, logs and traces of the application. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Auto Instrumentation is enabled or not." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryMetrics": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Metrics. Collects OpenTelemetry metrics of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Metrics is enabled or not." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The Open Telemetry host port for Open Telemetry metrics. If not specified, the default port is 28333." + } + } + }, + "ManagedClusterAzureMonitorProfileAppMonitoringOpenTelemetryLogs": { + "type": "object", + "description": "Application Monitoring Open Telemetry Metrics Profile for Kubernetes Application Container Logs and Traces. Collects OpenTelemetry logs and traces of the application using Azure Monitor OpenTelemetry based SDKs. See aka.ms/AzureMonitorApplicationMonitoring for an overview.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if Application Monitoring Open Telemetry Logs and traces is enabled or not." + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The Open Telemetry host port for Open Telemetry logs and traces. If not specified, the default port is 28331." + } + } + }, + "ManagedClusterMetricsProfile": { + "type": "object", + "description": "The metrics profile for the ManagedCluster.", + "properties": { + "costAnalysis": { + "$ref": "#/definitions/ManagedClusterCostAnalysis", + "description": "The configuration for detailed per-Kubernetes resource cost analysis." + } + } + }, + "ManagedClusterCostAnalysis": { + "type": "object", + "description": "The cost analysis configuration for the cluster", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable cost analysis. The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis." + } + } + }, + "ManagedClusterAIToolchainOperatorProfile": { + "type": "object", + "description": "When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable AI toolchain operator to the cluster. Indicates if AI toolchain operator enabled or not." + } + } + }, + "ManagedClusterNodeProvisioningProfile": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "Manual", + "Auto" + ], + "x-ms-enum": { + "name": "NodeProvisioningMode", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Nodes are provisioned manually by the user" + }, + { + "value": "Auto", + "description": "Nodes are provisioned automatically by AKS using Karpenter (See aka.ms/aks/nap for more details). Fixed size Node Pools can still be created, but autoscaling Node Pools cannot be. (See aka.ms/aks/nap for more details)." + } + ] + }, + "description": "The node provisioning mode. If not specified, the default is Manual." + }, + "defaultNodePools": { + "enum": [ + "None", + "Auto" + ], + "description": "The set of default Karpenter NodePools (CRDs) configured for node provisioning. This field has no effect unless mode is 'Auto'. Warning: Changing this from Auto to None on an existing cluster will cause the default Karpenter NodePools to be deleted, which will drain and delete the nodes associated with those pools. It is strongly recommended to not do this unless there are idle nodes ready to take the pods evicted by that action. If not specified, the default is Auto. For more information see aka.ms/aks/nap#node-pools.", + "default": "Auto", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "NodeProvisioningDefaultNodePools", + "values": [ + { + "description": "No Karpenter NodePools are provisioned automatically. Automatic scaling will not happen unless the user creates one or more NodePool CRD instances.", + "value": "None" + }, + { + "description": "A standard set of Karpenter NodePools are provisioned", + "value": "Auto" + } + ] + } + } + } + }, + "ManagedClusterBootstrapProfile": { + "description": "The bootstrap profile.", + "properties": { + "artifactSource": { + "type": "string", + "enum": [ + "Direct", + "Cache" + ], + "x-ms-enum": { + "name": "ArtifactSource", + "modelAsString": true, + "values": [ + { + "value": "Cache", + "description": "pull images from Azure Container Registry with cache" + }, + { + "value": "Direct", + "description": "pull images from Microsoft Artifact Registry" + } + ] + }, + "default": "Direct", + "description": "The artifact source. The source where the artifacts are downloaded from." + }, + "containerRegistryId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ContainerRegistry/registries" + } + ] + }, + "description": "The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy." + } + }, + "type": "object" + }, + "ManagedClusterHostedSystemProfile": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether to enable hosted system addons for the cluster." + } + }, + "description": "Settings for hosted system addons." + }, + "AgentPoolDeleteMachinesParameter": { + "type": "object", + "properties": { + "machineNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The agent pool machine names." + } + }, + "required": [ + "machineNames" + ], + "description": "Specifies a list of machine names from the agent pool to be deleted." + }, + "OperationStatusResultList": { + "description": "The operations list. It contains an URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations", + "readOnly": true + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + } + }, + "LoadBalancerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "The list of Load Balancers." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of load balancer results.", + "readOnly": true + } + }, + "description": "The response from the List Load Balancers operation." + }, + "LoadBalancer": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LoadBalancerProperties", + "description": "The properties of the load balancer.", + "x-ms-client-flatten": true + } + }, + "required": [ + "name" + ], + "description": "The configurations regarding multiple standard load balancers. If not supplied, single load balancer mode will be used. Multiple standard load balancers mode will be used if at lease one configuration is supplied. There has to be a configuration named `kubernetes`. The name field will be the name of the corresponding public load balancer. There will be an internal load balancer created if needed, and the name will be `-internal`. The internal lb shares the same configurations as the external one. The internal lbs are not needed to be included in LoadBalancer list." + }, + "LoadBalancerProperties": { + "type": "object", + "properties": { + "primaryAgentPoolName": { + "type": "string", + "description": "Required field. A string value that must specify the ID of an existing agent pool. All nodes in the given pool will always be added to this load balancer. This agent pool must have at least one node and minCount>=1 for autoscaling operations. An agent pool can only be the primary pool for a single load balancer." + }, + "allowServicePlacement": { + "type": "boolean", + "description": "Whether to automatically place services on the load balancer. If not supplied, the default value is true. If set to false manually, both of the external and the internal load balancer will not be selected for services unless they explicitly target it." + }, + "serviceLabelSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Only services that must match this selector can be placed on this load balancer." + }, + "serviceNamespaceSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Services created in namespaces that match the selector can be placed on this load balancer." + }, + "nodeSelector": { + "$ref": "#/definitions/LabelSelector", + "description": "Nodes that match this selector will be possible members of this load balancer." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current provisioning state." + } + }, + "required": [ + "primaryAgentPoolName" + ] + }, + "LabelSelector": { + "type": "object", + "description": "A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.", + "properties": { + "matchLabels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is `key`, the operator is `In`, and the values array contains only `value`. The requirements are ANDed." + }, + "matchExpressions": { + "type": "array", + "items": { + "$ref": "#/definitions/LabelSelectorRequirement" + }, + "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed." + } + } + }, + "LabelSelectorRequirement": { + "type": "object", + "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "type": "string", + "enum": [ + "In", + "NotIn", + "Exists", + "DoesNotExist" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true, + "values": [ + { + "value": "In", + "description": "The value of the key should be in the given list." + }, + { + "value": "NotIn", + "description": "The value of the key should not be in the given list." + }, + { + "value": "Exists", + "description": "The value of the key should exist." + }, + { + "value": "DoesNotExist", + "description": "The value of the key should not exist." + } + ] + }, + "description": "operator represents a key's relationship to a set of values. Valid operators are In and NotIn" + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "values is an array of string values, the values array must be non-empty." + } + } + }, + "RebalanceLoadBalancersRequestBody": { + "type": "object", + "properties": { + "loadBalancerNames": { + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [], + "description": "The load balancer names list." + } + }, + "description": "The names of the load balancers to rebalance. If set to empty, all load balancers will be rebalanced." + }, + "Component": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Component name." + }, + "version": { + "type": "string", + "description": "Component version." + }, + "hasBreakingChanges": { + "type": "boolean", + "description": "If upgraded component version contains breaking changes from the current version. To see a detailed description of what the breaking changes are, visit https://learn.microsoft.com/azure/aks/supported-kubernetes-versions?tabs=azure-cli#aks-components-breaking-changes-by-version." + } + } + }, + "ComponentsByRelease": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "The Kubernetes version (major.minor)." + }, + "components": { + "type": "array", + "items": { + "$ref": "#/definitions/Component" + }, + "x-ms-identifiers": [], + "description": "components of current or upgraded Kubernetes version in the cluster." + } + }, + "description": "components of given Kubernetes version." + }, + "NodeImageVersionsListResult": { + "description": "Holds an array NodeImageVersions", + "properties": { + "value": { + "description": "Array of AKS Node Image versions.", + "items": { + "$ref": "#/definitions/NodeImageVersion" + }, + "type": "array", + "x-ms-identifiers": [ + "fullName" + ] + }, + "nextLink": { + "description": "The URL to get the next set of machine results.", + "format": "uri", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NodeImageVersion": { + "description": "node image version profile for given major.minor.patch release.", + "properties": { + "os": { + "description": "The operating system of the node image. Example: AKSUbuntu", + "type": "string" + }, + "sku": { + "description": "The SKU or flavor of the node image. Example: 2004gen2containerd", + "type": "string" + }, + "version": { + "description": "major.minor.patch version of the node image version release. Example: 2024.02.02", + "type": "string" + }, + "fullName": { + "description": "The OS + SKU + version of the node image. Example: AKSUbuntu-1804gen2containerd-2024.02.02", + "type": "string" + } + }, + "type": "object" + }, + "SchedulerInstanceProfile": { + "description": "The scheduler profile for a single scheduler instance.", + "type": "object", + "properties": { + "schedulerConfigMode": { + "type": "string", + "description": "The config customization mode for this scheduler instance.", + "enum": [ + "Default", + "ManagedByCRD" + ], + "x-ms-enum": { + "name": "SchedulerConfigMode", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "No config customization. Use default configuration." + }, + { + "value": "ManagedByCRD", + "description": "Enable config customization. Customer can specify scheduler configuration via a CRD. See aka.ms/aks/scheduler-crd for details." + } + ] + } + } + } + }, + "SchedulerProfile": { + "description": "The pod scheduler profile for the cluster.", + "type": "object", + "properties": { + "schedulerInstanceProfiles": { + "description": "Mapping of each scheduler instance to its profile.", + "type": "object", + "properties": { + "upstream": { + "$ref": "#/definitions/SchedulerInstanceProfile", + "description": "The scheduler profile for the upstream scheduler instance." + } + } + } + } + }, + "IdentityBinding": { + "type": "object", + "description": "The IdentityBinding resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IdentityBindingProperties", + "description": "The resource-specific properties for this resource." + }, + "eTag": { + "type": "string", + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "IdentityBindingListResult": { + "type": "object", + "description": "The response of a IdentityBinding list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IdentityBinding items on this page", + "items": { + "$ref": "#/definitions/IdentityBinding" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IdentityBindingManagedIdentityProfile": { + "type": "object", + "description": "Managed identity profile for the identity binding.", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the managed identity.", + "pattern": "^/subscriptions/[a-zA-Z0-9-]+/resourceGroups/[a-zA-Z0-9-]+/providers/Microsoft.ManagedIdentity/userAssignedIdentities/[a-zA-Z0-9-]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "objectId": { + "type": "string", + "description": "The object ID of the managed identity.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "readOnly": true + }, + "clientId": { + "type": "string", + "description": "The client ID of the managed identity.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of the managed identity.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", + "readOnly": true + } + }, + "required": [ + "resourceId" + ] + }, + "IdentityBindingOidcIssuerProfile": { + "type": "object", + "description": "IdentityBinding OIDC issuer profile.", + "properties": { + "oidcIssuerUrl": { + "type": "string", + "format": "uri", + "description": "The OIDC issuer URL of the IdentityBinding.", + "readOnly": true + } + } + }, + "IdentityBindingProperties": { + "type": "object", + "description": "IdentityBinding properties.", + "properties": { + "managedIdentity": { + "$ref": "#/definitions/IdentityBindingManagedIdentityProfile", + "description": "Managed identity profile for the identity binding.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "oidcIssuer": { + "$ref": "#/definitions/IdentityBindingOidcIssuerProfile", + "description": "The OIDC issuer URL of the IdentityBinding.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/IdentityBindingProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "managedIdentity" + ] + }, + "IdentityBindingProvisioningState": { + "type": "string", + "description": "The provisioning state of the last accepted operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "IdentityBindingProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The identity binding is being created." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The identity binding is being updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The identity binding is being deleted." + } + ] + }, + "readOnly": true + }, + "JWTAuthenticator": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JWTAuthenticatorProperties" + } + }, + "description": "Configuration for JWT authenticator in the managed cluster.", + "required": [ + "properties" + ] + }, + "JWTAuthenticatorListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JWTAuthenticator" + }, + "description": "The list of JWT authenticators." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of JWT authenticator results.", + "readOnly": true + } + }, + "description": "The response from the List JWT authenticator operation.", + "required": [ + "value" + ] + }, + "JWTAuthenticatorProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/JWTAuthenticatorProvisioningState", + "readOnly": true, + "description": "The current provisioning state of the JWT authenticator." + }, + "issuer": { + "$ref": "#/definitions/JWTAuthenticatorIssuer", + "description": "The JWT OIDC issuer details." + }, + "claimValidationRules": { + "type": "array", + "items": { + "$ref": "#/definitions/JWTAuthenticatorValidationRule" + }, + "description": "The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed." + }, + "claimMappings": { + "$ref": "#/definitions/JWTAuthenticatorClaimMappings", + "description": "The mappings that define how user attributes are extracted from the token claims." + }, + "userValidationRules": { + "type": "array", + "items": { + "$ref": "#/definitions/JWTAuthenticatorValidationRule" + }, + "description": "The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed." + } + }, + "description": "The properties of JWTAuthenticator. For details on how to configure the properties of a JWT authenticator, please refer to the Kubernetes documentation: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration. Please note that not all fields available in the Kubernetes documentation are supported by AKS. For troubleshooting, please see https://aka.ms/aks-external-issuers-docs.", + "required": [ + "issuer", + "claimMappings" + ] + }, + "JWTAuthenticatorProvisioningState": { + "type": "string", + "description": "The provisioning state of the last accepted operation.", + "enum": [ + "Updating", + "Deleting", + "Creating", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "JWTAuthenticatorProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The JWT authenticator is being created." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The JWT authenticator is being updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The JWT authenticator is being deleted." + } + ] + }, + "readOnly": true + }, + "JWTAuthenticatorIssuer": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the \"iss\" claim in the presented JWT, and the issuer returned from discovery." + }, + "audiences": { + "type": "array", + "minItems": 1, + "items": { + "type": "string" + }, + "description": "The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration." + } + }, + "description": "The OIDC issuer details for JWTAuthenticator.", + "required": [ + "url", + "audiences" + ] + }, + "JWTAuthenticatorClaimMappings": { + "type": "object", + "properties": { + "username": { + "$ref": "#/definitions/JWTAuthenticatorClaimMappingExpression", + "description": "The expression to extract username attribute from the token claims." + }, + "groups": { + "$ref": "#/definitions/JWTAuthenticatorClaimMappingExpression", + "description": "The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims." + }, + "uid": { + "$ref": "#/definitions/JWTAuthenticatorClaimMappingExpression", + "description": "The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims." + }, + "extra": { + "type": "array", + "items": { + "$ref": "#/definitions/JWTAuthenticatorExtraClaimMappingExpression" + }, + "description": "The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims." + } + }, + "description": "The claim mappings for JWTAuthenticator.", + "required": [ + "username" + ] + }, + "JWTAuthenticatorValidationRule": { + "type": "object", + "properties": { + "expression": { + "type": "string", + "description": "The CEL expression used to validate the claim or attribute." + }, + "message": { + "type": "string", + "description": "The validation error message." + } + }, + "description": "The validation rule for JWTAuthenticator.", + "required": [ + "expression" + ] + }, + "JWTAuthenticatorClaimMappingExpression": { + "type": "object", + "properties": { + "expression": { + "type": "string", + "description": "The CEL expression used to access token claims." + } + }, + "description": "The claim mapping expression for JWTAuthenticator.", + "required": [ + "expression" + ] + }, + "JWTAuthenticatorExtraClaimMappingExpression": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The key of the extra attribute." + }, + "valueExpression": { + "type": "string", + "description": "The CEL expression used to extract the value of the extra attribute." + } + }, + "description": "The extra claim mapping expression for JWTAuthenticator.", + "required": [ + "key", + "valueExpression" + ] + }, + "MeshMembership": { + "type": "object", + "description": "Mesh membership of a managed cluster.", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "eTag": { + "description": "Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention.", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/definitions/MeshMembershipProperties" + } + } + }, + "MeshMembershipProperties": { + "type": "object", + "description": "Mesh membership properties of a managed cluster.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/MeshMembershipProvisioningState", + "readOnly": true, + "description": "The current provisioning state of the Mesh Membership." + }, + "managedMeshID": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AppLink/applinks" + } + ] + }, + "description": "The ARM resource id for the managed mesh member. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/applinks/{appLinkName}/appLinkMembers/{appLinkMemberName}'. Visit https://aka.ms/applink for more information." + } + }, + "required": [ + "managedMeshID" + ] + }, + "MeshMembershipProvisioningState": { + "type": "string", + "description": "The provisioning state of the last accepted operation.", + "enum": [ + "Canceled", + "Creating", + "Deleting", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "MeshMembershipProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The Mesh Membership is being created." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The Mesh Membership is being deleted." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The Mesh Membership is being updated." + } + ] + }, + "readOnly": true + }, + "MeshMembershipsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MeshMembership" + }, + "description": "The list of mesh memberships." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of mesh membership results.", + "readOnly": true + } + }, + "description": "The result of a request to list mesh memberships in a managed cluster." + } + }, + "parameters": { + "LoadBalancerNameParameter": { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the load balancer.", + "x-ms-parameter-location": "method" + }, + "ManagedNamespaceNameParameter": { + "name": "managedNamespaceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "[a-z0-9]([-a-z0-9]*[a-z0-9])?", + "description": "The name of the managed namespace.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + }, + "AgentPoolNameParameter": { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,11}$", + "minLength": 1, + "maxLength": 12, + "description": "The name of the agent pool.", + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resource-type", + "in": "query", + "required": false, + "type": "string", + "description": "The resource type for which the OS options needs to be returned", + "x-ms-parameter-location": "method" + }, + "ServerFqdnParameter": { + "name": "server-fqdn", + "in": "query", + "required": false, + "type": "string", + "description": "server fqdn type for credentials to be returned", + "x-ms-parameter-location": "method" + }, + "CredentialFormatParameter": { + "name": "format", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "exec", + "azure" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "azure", + "description": "Return azure auth-provider kubeconfig. This format is deprecated in v1.22 and will be fully removed in v1.26. See: https://aka.ms/k8s/changes-1-26." + }, + { + "value": "exec", + "description": "Return exec format kubeconfig. This format requires kubelogin binary in the path." + } + ] + }, + "description": "Only apply to AAD clusters, specifies the format of returned kubeconfig. Format 'azure' will return azure auth-provider kubeconfig; format 'exec' will return exec format kubeconfig, which requires kubelogin binary in the path.", + "x-ms-parameter-location": "method" + }, + "IgnorePodDisruptionBudgetParameter": { + "name": "ignore-pod-disruption-budget", + "in": "query", + "required": false, + "type": "boolean", + "description": "ignore-pod-disruption-budget=true to delete those pods on a node without considering Pod Disruption Budget", + "x-ms-parameter-location": "method" + }, + "TrustedAccessRoleBindingNameParameter": { + "name": "trustedAccessRoleBindingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of trusted access role binding.", + "pattern": "^([A-Za-z0-9-])+$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + }, + "MeshModeParameter": { + "name": "mode", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The mode of the mesh.", + "x-ms-parameter-location": "method" + }, + "MachineNameParameter": { + "type": "string", + "description": "Host name of the machine.", + "name": "machineName", + "in": "path", + "required": true, + "pattern": "^[a-z][a-z0-9]{0,11}$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,39}$", + "x-ms-parameter-location": "method" + }, + "VersionParameter": { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24, + "description": "Safeguards version", + "x-ms-parameter-location": "method" + }, + "IdentityBindingNameParameter": { + "name": "identityBindingName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]{0,63}$", + "minLength": 1, + "maxLength": 63, + "description": "The name of the identity binding.", + "x-ms-parameter-location": "method" + }, + "JWTAuthenticatorNameParameter": { + "description": "The name of the JWT authenticator.", + "in": "path", + "maxLength": 24, + "minLength": 1, + "name": "jwtAuthenticatorName", + "pattern": "^[a-z][a-z0-9]{0,23}$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MeshMembershipNameParameter": { + "name": "meshMembershipName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,62}$", + "minLength": 1, + "maxLength": 63, + "description": "The name of the mesh membership.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md index 657af6b3d4d4..b940735b0ad6 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.md @@ -46,6 +46,15 @@ input-file: - stable/2025-09-01/managedClusters.json ``` +### Tag: package-preview-2025-09 + +These settings apply only when `--tag=package-preview-2025-09` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2025-09' +input-file: + - preview/2025-09-02-preview/managedClusters.json +``` + ### Tag: package-2025-08 These settings apply only when `--tag=package-2025-08` is specified on the command line. diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/back-compatible.tsp b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/back-compatible.tsp new file mode 100644 index 000000000000..0c32c2c90683 --- /dev/null +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/back-compatible.tsp @@ -0,0 +1,15 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using Microsoft.ContainerStorage; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Pool.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Snapshot.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Volume.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/main.tsp b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/main.tsp index 6c7bdf42e3d0..6f39cf1240f6 100644 --- a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/main.tsp +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/main.tsp @@ -2,10 +2,13 @@ import "@typespec/rest"; import "@typespec/openapi"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + import "./pool.tsp"; import "./volume.tsp"; import "./snapshot.tsp"; import "./assignment.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Versioning; using Azure.ResourceManager; diff --git a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/tspconfig.yaml b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/tspconfig.yaml index 09a2f802286f..9dd5de4904bd 100644 --- a/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/tspconfig.yaml +++ b/specification/containerstorage/resource-manager/Microsoft.ContainerStorage/ContainerStorage/tspconfig.yaml @@ -9,8 +9,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}" output-file: "{version-status}/{version}/containerstorage.json" arm-types-dir: "{project-root}/../../../../common-types/resource-management" diff --git a/specification/databasewatcher/DatabaseWatcher.Management/back-compatible.tsp b/specification/databasewatcher/DatabaseWatcher.Management/back-compatible.tsp new file mode 100644 index 000000000000..67f28d625d6c --- /dev/null +++ b/specification/databasewatcher/DatabaseWatcher.Management/back-compatible.tsp @@ -0,0 +1,20 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Microsoft.DatabaseWatcher; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AlertRuleResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(HealthValidation.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SharedPrivateLinkResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Watcher.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/databasewatcher/DatabaseWatcher.Management/main.tsp b/specification/databasewatcher/DatabaseWatcher.Management/main.tsp index 083c26850272..2d626f4a7b66 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/main.tsp +++ b/specification/databasewatcher/DatabaseWatcher.Management/main.tsp @@ -1 +1,2 @@ import "./watcher.tsp"; +import "./back-compatible.tsp"; diff --git a/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml b/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml index c1c5143879ab..2f831e123c23 100644 --- a/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml +++ b/specification/databasewatcher/DatabaseWatcher.Management/tspconfig.yaml @@ -8,8 +8,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/Watcher.json" use-read-only-status-schema: true "@azure-tools/typespec-csharp": diff --git a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json index 5cb75181e47a..4d2e39761a3d 100644 --- a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json +++ b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2023-09-01-preview/Watcher.json @@ -1481,8 +1481,7 @@ "properties": { "properties": { "$ref": "#/definitions/TargetProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-07-19-preview/Watcher.json b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-07-19-preview/Watcher.json index 0627929916cd..bf4d004ac74a 100644 --- a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-07-19-preview/Watcher.json +++ b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-07-19-preview/Watcher.json @@ -1797,8 +1797,7 @@ "properties": { "properties": { "$ref": "#/definitions/TargetProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json index 53e2b4266bb5..c8aac4ea9826 100644 --- a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json +++ b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/preview/2024-10-01-preview/Watcher.json @@ -2058,8 +2058,7 @@ "properties": { "properties": { "$ref": "#/definitions/TargetProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/stable/2025-01-02/Watcher.json b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/stable/2025-01-02/Watcher.json index b4b8802783c6..3da971cf7ba8 100644 --- a/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/stable/2025-01-02/Watcher.json +++ b/specification/databasewatcher/resource-manager/Microsoft.DatabaseWatcher/stable/2025-01-02/Watcher.json @@ -2021,8 +2021,7 @@ "properties": { "properties": { "$ref": "#/definitions/TargetProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/databox/resource-manager/Microsoft.DataBox/DataBox/tspconfig.yaml b/specification/databox/resource-manager/Microsoft.DataBox/DataBox/tspconfig.yaml index 461c71224d77..6dded3b503c2 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/DataBox/tspconfig.yaml +++ b/specification/databox/resource-manager/Microsoft.DataBox/DataBox/tspconfig.yaml @@ -11,7 +11,7 @@ options: output-file: "{version-status}/{version}/databox.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + emit-lro-options: "all" "@azure-tools/typespec-csharp": flavor: azure diff --git a/specification/datadog/Datadog.Management/DatadogMonitorResource.tsp b/specification/datadog/Datadog.Management/DatadogMonitorResource.tsp new file mode 100644 index 000000000000..339c53688a9f --- /dev/null +++ b/specification/datadog/Datadog.Management/DatadogMonitorResource.tsp @@ -0,0 +1,202 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Datadog; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DatadogMonitorResource + is Azure.ResourceManager.TrackedResource { + ...ResourceNameParameter< + Resource = DatadogMonitorResource, + KeyName = "monitorName", + SegmentName = "monitors", + NamePattern = "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + >; + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + sku?: ResourceSku; + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + identity?: IdentityProperties; +} + +@armResourceOperations +interface DatadogMonitorResources { + /** + * Get the properties of a specific monitor resource. + */ + @summary("Get the properties of a specific monitor resource.") + get is ArmResourceRead; + + /** + * Create a monitor resource. + */ + @summary("Create a monitor resource.") + create is Azure.ResourceManager.Legacy.CreateOrUpdateAsync< + DatadogMonitorResource, + OptionalRequestBody = true + >; + + /** + * Update a monitor resource. + */ + @summary("Update a monitor resource.") + @patch(#{ implicitOptionality: false }) + update is Azure.ResourceManager.Legacy.CreateOrReplaceAsync< + DatadogMonitorResource, + Request = DatadogMonitorResourceUpdateParameters, + Response = ArmResponse | ArmResourceCreatedResponse< + DatadogMonitorResource, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + >, + OptionalRequestBody = true + >; + + /** + * Delete a monitor resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @summary("Delete a monitor resource.") + delete is ArmResourceDeleteWithoutOkAsync< + DatadogMonitorResource, + Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse + >; + + /** + * List all monitors under the specified resource group. + */ + @summary("List all monitors under the specified resource group.") + listByResourceGroup is ArmResourceListByParent< + DatadogMonitorResource, + Response = ArmResponse + >; + + /** + * List all monitors under the specified subscription. + */ + @summary("List all monitors under the specified subscription.") + list is ArmListBySubscription< + DatadogMonitorResource, + Response = ArmResponse + >; + + /** + * List the api keys for a given monitor resource. + */ + @list + @summary("List the api keys for a given monitor resource.") + listApiKeys is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * Get the default api key. + */ + @summary("Get the default api key.") + getDefaultKey is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * Set the default api key. + */ + @summary("Set the default api key.") + setDefaultKey is ArmResourceActionSync< + DatadogMonitorResource, + DatadogApiKey, + OkResponse, + OptionalRequestBody = true + >; + + /** + * List the hosts for a given monitor resource. + */ + @list + @summary("List the hosts for a given monitor resource.") + listHosts is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * List all Azure resources associated to the same Datadog organization as the target resource. + */ + @list + @summary("List all Azure resources associated to the same Datadog organization as the target resource.") + listLinkedResources is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * List the resources currently being monitored by the Datadog monitor resource. + */ + @list + @summary("List the resources currently being monitored by the Datadog monitor resource.") + listMonitoredResources is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * Refresh the set password link and return a latest one. + */ + @summary("Refresh the set password link and return a latest one.") + refreshSetPasswordLink is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * Get marketplace and organization info mapped to the given monitor. + */ + @summary("Get marketplace and organization info mapped to the given monitor.") + @action("getBillingInfo") + billingInfoGet is ArmResourceActionSync< + DatadogMonitorResource, + void, + ArmResponse + >; + + /** + * Reinstate integration with your Datadog organization by choosing one of the available subscription plans. + */ + #suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations" + @summary("Reinstate integration with your Datadog organization by choosing one of the available subscription plans.") + resubscribe is ArmResourceActionAsync< + DatadogMonitorResource, + ResubscribeProperties, + DatadogMonitorResource, + OptionalRequestBody = true + >; +} + +@@maxLength(DatadogMonitorResource.name, 32); +@@minLength(DatadogMonitorResource.name, 2); +@@doc(DatadogMonitorResource.name, "Monitor resource name"); +@@doc(DatadogMonitorResource.properties, + "Properties specific to the monitor resource." +); +@@doc(DatadogMonitorResources.create::parameters.resource, ""); +@@doc(DatadogMonitorResources.update::parameters.resource, ""); +@@doc(DatadogMonitorResources.setDefaultKey::parameters.body, ""); +@@doc(DatadogMonitorResources.resubscribe::parameters.body, + "Resubscribe Properties" +); diff --git a/specification/datadog/Datadog.Management/DatadogSingleSignOnResource.tsp b/specification/datadog/Datadog.Management/DatadogSingleSignOnResource.tsp new file mode 100644 index 000000000000..541457107925 --- /dev/null +++ b/specification/datadog/Datadog.Management/DatadogSingleSignOnResource.tsp @@ -0,0 +1,56 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./DatadogMonitorResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Datadog; + +@parentResource(DatadogMonitorResource) +model DatadogSingleSignOnResource + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = DatadogSingleSignOnResource, + KeyName = "configurationName", + SegmentName = "singleSignOnConfigurations", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface DatadogSingleSignOnResources { + /** + * Gets the datadog single sign-on resource for the given Monitor. + */ + @summary("Gets the datadog single sign-on resource for the given Monitor.") + get is ArmResourceRead; + + /** + * Configures single-sign-on for this resource. + */ + @summary("Configures single-sign-on for this resource.") + create is Azure.ResourceManager.Legacy.CreateOrUpdateAsync< + DatadogSingleSignOnResource, + OptionalRequestBody = true + >; + + /** + * List the single sign-on configurations for a given monitor resource. + */ + @summary("List the single sign-on configurations for a given monitor resource.") + list is ArmResourceListByParent< + DatadogSingleSignOnResource, + Response = ArmResponse + >; +} + +@@doc(DatadogSingleSignOnResource.name, "Configuration name"); +@@doc(DatadogSingleSignOnResource.properties, ""); +@@doc(DatadogSingleSignOnResources.create::parameters.resource, ""); diff --git a/specification/datadog/Datadog.Management/MonitoredSubscriptionProperties.tsp b/specification/datadog/Datadog.Management/MonitoredSubscriptionProperties.tsp new file mode 100644 index 000000000000..f0c1cfcd6c82 --- /dev/null +++ b/specification/datadog/Datadog.Management/MonitoredSubscriptionProperties.tsp @@ -0,0 +1,91 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./DatadogMonitorResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Datadog; +/** + * The request to update subscriptions needed to be monitored by the Datadog monitor resource. + */ +@parentResource(DatadogMonitorResource) +model MonitoredSubscriptionProperties + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = MonitoredSubscriptionProperties, + KeyName = "configurationName", + SegmentName = "monitoredSubscriptions", + NamePattern = "" + >; +} + +@armResourceOperations +interface MonitoredSubscriptions { + /** + * List the subscriptions currently being monitored by the Datadog monitor resource. + */ + @summary("List the subscriptions currently being monitored by the Datadog monitor resource.") + get is ArmResourceRead; + + /** + * Add the subscriptions that should be monitored by the Datadog monitor resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @summary("Add the subscriptions that should be monitored by the Datadog monitor resource.") + createorUpdate is Azure.ResourceManager.Legacy.CreateOrUpdateAsync< + MonitoredSubscriptionProperties, + Response = ArmResourceUpdatedResponse | ArmResourceCreatedResponse< + MonitoredSubscriptionProperties, + ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader + > | ArmAcceptedLroResponse, + OptionalRequestBody = true + >; + + /** + * Updates the subscriptions that are being monitored by the Datadog monitor resource + */ + @summary("Updates the subscriptions that are being monitored by the Datadog monitor resource") + @patch(#{ implicitOptionality: false }) + update is Azure.ResourceManager.Legacy.CreateOrReplaceAsync< + MonitoredSubscriptionProperties, + Request = MonitoredSubscriptionProperties, + Response = ArmResponse | ArmAcceptedLroResponse & + Azure.Core.Foundations.RetryAfterHeader>, + OptionalRequestBody = true + >; + + /** + * Updates the subscriptions that are being monitored by the Datadog monitor resource + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @summary("Updates the subscriptions that are being monitored by the Datadog monitor resource") + delete is ArmResourceDeleteWithoutOkAsync< + MonitoredSubscriptionProperties, + Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse + >; + + /** + * List the subscriptions currently being monitored by the Datadog monitor resource. + */ + @summary("List the subscriptions currently being monitored by the Datadog monitor resource.") + list is ArmResourceListByParent< + MonitoredSubscriptionProperties, + Response = ArmResponse + >; +} + +@@doc(MonitoredSubscriptionProperties.name, + "The configuration name. Only 'default' value is supported." +); +@@doc(MonitoredSubscriptionProperties.properties, + "The request to update subscriptions needed to be monitored by the Datadog monitor resource." +); +@@doc(MonitoredSubscriptions.createorUpdate::parameters.resource, ""); +@@doc(MonitoredSubscriptions.update::parameters.resource, ""); diff --git a/specification/datadog/Datadog.Management/MonitoringTagRules.tsp b/specification/datadog/Datadog.Management/MonitoringTagRules.tsp new file mode 100644 index 000000000000..a600d5657734 --- /dev/null +++ b/specification/datadog/Datadog.Management/MonitoringTagRules.tsp @@ -0,0 +1,61 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./DatadogMonitorResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace Microsoft.Datadog; +/** + * Capture logs and metrics of Azure resources based on ARM tags. + */ +@parentResource(DatadogMonitorResource) +model MonitoringTagRules + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = MonitoringTagRules, + KeyName = "ruleSetName", + SegmentName = "tagRules", + NamePattern = "" + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/no-resource-delete-operation" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@armResourceOperations +interface TagRules { + /** + * Get a tag rule set for a given monitor resource. + */ + @summary("Get a tag rule set for a given monitor resource.") + get is ArmResourceRead; + + /** + * Create or update a tag rule set for a given monitor resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @summary("Create or update a tag rule set for a given monitor resource.") + createOrUpdate is Azure.ResourceManager.Legacy.CreateOrUpdateAsync< + MonitoringTagRules, + Response = ArmResourceUpdatedResponse, + OptionalRequestBody = true + >; + /** + * List the tag rules for a given monitor resource. + */ + @summary("List the tag rules for a given monitor resource.") + list is ArmResourceListByParent< + MonitoringTagRules, + Response = ArmResponse + >; +} + +@@doc(MonitoringTagRules.name, "Rule set name"); +@@doc(MonitoringTagRules.properties, + "Definition of the properties for a TagRules resource." +); +@@doc(TagRules.createOrUpdate::parameters.resource, ""); diff --git a/specification/datadog/Datadog.Management/back-compatible.tsp b/specification/datadog/Datadog.Management/back-compatible.tsp new file mode 100644 index 000000000000..dbc83068e0a5 --- /dev/null +++ b/specification/datadog/Datadog.Management/back-compatible.tsp @@ -0,0 +1,113 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using Microsoft.Datadog; + +// Client decorators for operations (migrated from @operationId) + +// DatadogMonitorResources operations +@@clientLocation(DatadogMonitorResources.get, "Monitors", "!csharp"); +@@clientName(DatadogMonitorResources.get, "Get"); + +@@clientLocation(DatadogMonitorResources.create, "Monitors"); +@@clientName(DatadogMonitorResources.create, "Create"); + +@@clientLocation(DatadogMonitorResources.update, "Monitors"); +@@clientName(DatadogMonitorResources.update, "Update"); + +@@clientLocation(DatadogMonitorResources.delete, "Monitors"); +@@clientName(DatadogMonitorResources.delete, "Delete"); + +@@clientLocation(DatadogMonitorResources.listByResourceGroup, "Monitors"); +@@clientName(DatadogMonitorResources.listByResourceGroup, + "ListByResourceGroup" +); + +@@clientLocation(DatadogMonitorResources.list, "Monitors", "!csharp"); +@@clientName(DatadogMonitorResources.list, "List", "!csharp"); + +@@clientLocation(DatadogMonitorResources.listApiKeys, "Monitors"); +@@clientName(DatadogMonitorResources.listApiKeys, "ListApiKeys"); + +@@clientLocation(DatadogMonitorResources.getDefaultKey, "Monitors"); +@@clientName(DatadogMonitorResources.getDefaultKey, "GetDefaultKey"); + +@@clientLocation(DatadogMonitorResources.setDefaultKey, "Monitors"); +@@clientName(DatadogMonitorResources.setDefaultKey, "SetDefaultKey"); + +@@clientLocation(DatadogMonitorResources.listHosts, "Monitors"); +@@clientName(DatadogMonitorResources.listHosts, "ListHosts"); + +@@clientLocation(DatadogMonitorResources.listLinkedResources, "Monitors"); +@@clientName(DatadogMonitorResources.listLinkedResources, + "ListLinkedResources" +); + +@@clientLocation(DatadogMonitorResources.listMonitoredResources, "Monitors"); +@@clientName(DatadogMonitorResources.listMonitoredResources, + "ListMonitoredResources" +); + +@@clientLocation(DatadogMonitorResources.refreshSetPasswordLink, "Monitors"); +@@clientName(DatadogMonitorResources.refreshSetPasswordLink, + "RefreshSetPasswordLink" +); + +@@clientLocation(DatadogMonitorResources.billingInfoGet, "BillingInfo"); +@@clientName(DatadogMonitorResources.billingInfoGet, "Get"); +@@clientLocation(DatadogMonitorResources.resubscribe, "Organizations"); + +// DatadogSingleSignOnResources operations +@@clientLocation(DatadogSingleSignOnResources.get, + "SingleSignOnConfigurations" +); +@@clientName(DatadogSingleSignOnResources.get, "Get"); + +@@clientLocation(DatadogSingleSignOnResources.create, + "SingleSignOnConfigurations" +); +@@clientName(DatadogSingleSignOnResources.create, "CreateOrUpdate"); + +@@clientLocation(DatadogSingleSignOnResources.list, + "SingleSignOnConfigurations" +); +@@clientName(DatadogSingleSignOnResources.list, "List"); + +// MarketplaceAgreementsOperationGroup operations +@@clientLocation(MarketplaceAgreementsOperationGroup.list, + "MarketplaceAgreements" +); +@@clientName(MarketplaceAgreementsOperationGroup.list, "List"); + +@@clientLocation(MarketplaceAgreementsOperationGroup.createOrUpdate, + "MarketplaceAgreements" +); +@@clientName(MarketplaceAgreementsOperationGroup.createOrUpdate, + "CreateOrUpdate" +); + +// CreationSupportedOperationGroup operations +@@clientLocation(CreationSupportedOperationGroup.list, "CreationSupported"); +@@clientName(CreationSupportedOperationGroup.list, "List"); + +@@clientLocation(CreationSupportedOperationGroup.get, "CreationSupported"); +@@clientName(CreationSupportedOperationGroup.get, "Get"); + +// Existing client decorators for parameters and models +@@clientName(DatadogMonitorResources.create::parameters.resource, "body"); +@@clientName(DatadogMonitorResources.update::parameters.resource, "body"); + +@@clientName(TagRules.createOrUpdate::parameters.resource, "body"); + +@@clientName(DatadogSingleSignOnResources.create::parameters.resource, "body"); + +@@clientName(MonitoredSubscriptions.createorUpdate::parameters.resource, + "body" +); +@@clientName(MonitoredSubscriptions.update::parameters.resource, "body"); +@@summary(Operations.list, + "List all operations provided by Microsoft.Datadog for the 2025-06-11 api version." +); +@@doc(Operations.list, + "List all operations provided by Microsoft.Datadog for the 2025-06-11 api version." +); diff --git a/specification/datadog/Datadog.Management/client.tsp b/specification/datadog/Datadog.Management/client.tsp new file mode 100644 index 000000000000..d0f58308bc5f --- /dev/null +++ b/specification/datadog/Datadog.Management/client.tsp @@ -0,0 +1,11 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./main.tsp"; +using Azure.ClientGenerator.Core; +using Microsoft.Datadog; + +@@clientName(Microsoft.Datadog, "MicrosoftDatadogClient", "javascript"); +@@clientName(BillingInfoResponse, "BillingInfoResult", "csharp"); +@@clientName(CreateResourceSupportedResponse, + "CreateResourceSupportedResult", + "csharp" +); diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_GetDefaultKey.json b/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_GetDefaultKey.json new file mode 100644 index 000000000000..bd520614bdea --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_GetDefaultKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "", + "created": "2019-04-05 09:20:30", + "createdBy": "john@example.com", + "key": "1111111111111111aaaaaaaaaaaaaaaa" + } + } + }, + "operationId": "Monitors_GetDefaultKey", + "title": "Monitors_GetDefaultKey" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_List.json new file mode 100644 index 000000000000..a0a0978af0c2 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "", + "created": "2019-04-05 09:20:30", + "createdBy": "john@example.com", + "key": "1111111111111111aaaaaaaaaaaaaaaa" + }, + { + "name": "", + "created": "2019-04-05 09:19:53", + "createdBy": "jane@example.com", + "key": "2111111111111111aaaaaaaaaaaaaaaa" + } + ] + } + } + }, + "operationId": "Monitors_ListApiKeys", + "title": "Monitors_ListApiKeys" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_SetDefaultKey.json b/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_SetDefaultKey.json new file mode 100644 index 000000000000..99e5a5edbc9f --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/ApiKeys_SetDefaultKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "requestBody": { + "key": "1111111111111111aaaaaaaaaaaaaaaa" + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Monitors_SetDefaultKey", + "title": "Monitors_SetDefaultKey" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/BillingInfo_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/BillingInfo_Get.json new file mode 100644 index 000000000000..a999fdfffe64 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/BillingInfo_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceName": "MP_RESOURCE", + "marketplaceStatus": "Status", + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "subscribed": true + }, + "partnerBillingEntity": { + "name": "datadogOrganizationName", + "id": "1234567890", + "partnerEntityUri": "https://example.com" + } + } + } + }, + "operationId": "BillingInfo_Get", + "title": "BillingInfo_Get" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/CreationSupported_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/CreationSupported_Get.json new file mode 100644 index 000000000000..0a1d5267ecff --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/CreationSupported_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "datadogOrganizationId": "00000000-0000-0000-0000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + } + }, + "operationId": "CreationSupported_Get", + "title": "CreationSupported_Get" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/CreationSupported_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/CreationSupported_List.json new file mode 100644 index 000000000000..898e8257763d --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/CreationSupported_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "datadogOrganizationId": "00000000-0000-0000-0000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + ] + } + } + }, + "operationId": "CreationSupported_List", + "title": "CreationSupported_List" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Hosts_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Hosts_List.json new file mode 100644 index 000000000000..698e8eeb0a7f --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Hosts_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "vm1", + "aliases": [ + "vm1", + "65f2dd83-95ae-4f56-b6aa-a5dafc05f4cd" + ], + "apps": [ + "ntp", + "agent" + ], + "meta": { + "agentVersion": "7.19.2", + "installMethod": { + "installerVersion": "install_script-1.0.0", + "tool": "install_script", + "toolVersion": "install_script" + }, + "logsAgent": { + "transport": "" + } + } + }, + { + "name": "vm2", + "aliases": [ + "vm2", + "df631d9a-8178-4580-bf60-c697a5e8df4d" + ], + "apps": [ + "infra", + "agent" + ], + "meta": { + "agentVersion": "7.18.1", + "installMethod": { + "installerVersion": "install_script-1.0.0", + "tool": "install_script", + "toolVersion": "install_script" + }, + "logsAgent": { + "transport": "HTTP" + } + } + } + ] + } + } + }, + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/LinkedResources_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/LinkedResources_List.json new file mode 100644 index 000000000000..27c57f7379a6 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/LinkedResources_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor", + "location": "West US 2" + } + ] + } + } + }, + "operationId": "Monitors_ListLinkedResources", + "title": "Monitors_ListLinkedResources" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MarketplaceAgreements_Create.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MarketplaceAgreements_Create.json new file mode 100644 index 000000000000..6dafca2fca22 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MarketplaceAgreements_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "accepted": true + } + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/agreements", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/default", + "properties": { + "accepted": true, + "licenseTextLink": "test.licenseLink1", + "plan": "planid1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "product": "offid1", + "publisher": "pubid1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER" + } + } + } + }, + "operationId": "MarketplaceAgreements_CreateOrUpdate", + "title": "MarketplaceAgreements_CreateOrUpdate" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MarketplaceAgreements_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MarketplaceAgreements_List.json new file mode 100644 index 000000000000..b2aee94ed4f6 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MarketplaceAgreements_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "planid1", + "type": "Microsoft.Datadog/agreements", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id1", + "properties": { + "accepted": false, + "licenseTextLink": "test.licenseLink1", + "plan": "planid1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "product": "offid1", + "publisher": "pubid1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER" + } + }, + { + "name": "planid2", + "type": "Microsoft.Datadog/agreements", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id2", + "properties": { + "accepted": false, + "licenseTextLink": "test.licenseLin2k", + "plan": "planid2", + "privacyPolicyLink": "test.privacyPolicyLink2", + "product": "offid2", + "publisher": "pubid2", + "retrieveDatetime": "2017-08-14T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER" + } + } + ] + } + } + }, + "operationId": "MarketplaceAgreements_List", + "title": "MarketplaceAgreements_List" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredResources_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredResources_List.json new file mode 100644 index 000000000000..2633a1d0c880 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredResources_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "reasonForLogsStatus": "CapturedByRules", + "reasonForMetricsStatus": "CapturedByRules", + "sendingLogs": true, + "sendingMetrics": true + } + ] + } + } + }, + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_CreateorUpdate.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..adb223b6ddb9 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ], + "operation": "AddBegin" + } + }, + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + }, + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "title": "Monitors_AddMonitoredSubscriptions" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Delete.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..f723577388f9 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + }, + "operationId": "MonitoredSubscriptions_Delete", + "title": "Monitors_DeleteMonitoredSubscriptions" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..19934f9363aa --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Get.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + } + }, + "operationId": "MonitoredSubscriptions_Get", + "title": "Monitors_GetMonitoredSubscriptions" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..a44da644a864 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_List.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + ] + } + } + }, + "operationId": "MonitoredSubscriptions_List", + "title": "Monitors_GetMonitoredSubscriptions" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Update.json b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..88b0938b26f6 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/MonitoredSubscriptions_Update.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ], + "operation": "AddComplete" + } + }, + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + }, + "operationId": "MonitoredSubscriptions_Update", + "title": "Monitors_UpdateMonitoredSubscriptions" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Create.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Create.json new file mode 100644 index 000000000000..0f6983983b61 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Create.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "cspm": false, + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "id": "myOrg123", + "linkingAuthCode": "someAuthCode", + "linkingClientId": "00000000-0000-0000-0000-000000000000", + "resourceCollection": false + }, + "monitoringStatus": "Enabled", + "userInfo": { + "name": "Alice", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123-456-7890" + } + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "201": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Accepted" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + } + }, + "operationId": "Monitors_Create", + "title": "Monitors_Create" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Delete.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Delete.json new file mode 100644 index 000000000000..8bcb433bd1d5 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + }, + "operationId": "Monitors_Delete", + "title": "Monitors_Delete" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Get.json new file mode 100644 index 000000000000..b62a13d9fff6 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "cspm": false, + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "resourceCollection": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "tags": { + "Environment": "Dev" + } + } + } + }, + "operationId": "Monitors_Get", + "title": "Monitors_Get" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_List.json new file mode 100644 index 000000000000..51cd03bb2bda --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "cspm": false, + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "resourceCollection": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "tags": { + "Environment": "Dev" + } + } + ] + } + } + }, + "operationId": "Monitors_List", + "title": "Monitors_List" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_ListByResourceGroup.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..7f9235a7fa3e --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "tags": { + "Environment": "Dev" + } + } + ] + } + } + }, + "operationId": "Monitors_ListByResourceGroup", + "title": "Monitors_ListByResourceGroup" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Update.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Update.json new file mode 100644 index 000000000000..cce799fc0fb7 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Monitors_Update.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "monitoringStatus": "Enabled" + }, + "tags": { + "Environment": "Dev" + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "201": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Accepted" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + } + }, + "operationId": "Monitors_Update", + "title": "Monitors_Update" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Operations_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Operations_List.json new file mode 100644 index 000000000000..8eec7bc9849a --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-06-11" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "Microsoft.Datadog/monitors/write", + "display": { + "description": "Write monitors resource", + "operation": "write", + "provider": "Microsoft.Datadog", + "resource": "monitors" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "Operations_List" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/Organizations_Resubscribe.json b/specification/datadog/Datadog.Management/examples/2025-06-11/Organizations_Resubscribe.json new file mode 100644 index 000000000000..f0f52ff6d5f2 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/Organizations_Resubscribe.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "azureSubscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup", + "sku": { + "name": "planName" + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Datadog/monitor/monitorname/resubscribe?api-version=2025-06-11" + } + } + }, + "operationId": "Organizations_Resubscribe", + "title": "Organizations_Resubscribe" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/RefreshSetPassword_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/RefreshSetPassword_Get.json new file mode 100644 index 000000000000..27e8ff152b56 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/RefreshSetPassword_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "setPasswordLink": "https://datadoghq.com/reset_password/tokenvalue123" + } + } + }, + "operationId": "Monitors_RefreshSetPasswordLink", + "title": "Monitors_RefreshSetPasswordLink" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_CreateOrUpdate.json b/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..c3b4f7a34a28 --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_CreateOrUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable" + } + }, + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": null + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": null + } + } + } + }, + "operationId": "SingleSignOnConfigurations_CreateOrUpdate", + "title": "SingleSignOnConfigurations_CreateOrUpdate" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_Get.json new file mode 100644 index 000000000000..3691d1da796f --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + } + }, + "operationId": "SingleSignOnConfigurations_Get", + "title": "SingleSignOnConfigurations_Get" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_List.json new file mode 100644 index 000000000000..8d422b7adc7c --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/SingleSignOnConfigurations_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + ] + } + } + }, + "operationId": "SingleSignOnConfigurations_List", + "title": "SingleSignOnConfigurations_List" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_CreateOrUpdate.json b/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..749477e4f95b --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_CreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "ruleSetName": "default", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/tagRules", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "properties": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + } + }, + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_Get.json b/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_Get.json new file mode 100644 index 000000000000..1ad806c132bf --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "ruleSetName": "default", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/tagRules", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "properties": { + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ] + }, + "automuting": true, + "customMetrics": false, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + } + }, + "operationId": "TagRules_Get", + "title": "TagRules_Get" +} diff --git a/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_List.json b/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_List.json new file mode 100644 index 000000000000..58e3b2f3a23a --- /dev/null +++ b/specification/datadog/Datadog.Management/examples/2025-06-11/TagRules_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.Datadog/monitors/tagRules", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "properties": { + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ] + }, + "automuting": true, + "customMetrics": false, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "operationId": "TagRules_List", + "title": "TagRules_List" +} diff --git a/specification/datadog/Datadog.Management/main.tsp b/specification/datadog/Datadog.Management/main.tsp new file mode 100644 index 000000000000..0733970d805d --- /dev/null +++ b/specification/datadog/Datadog.Management/main.tsp @@ -0,0 +1,56 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: true + * guessResourceKey: false + * Version: 0.11.9 + * Date: 2025-09-19T02:46:17.676Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./back-compatible.tsp"; +import "./DatadogMonitorResource.tsp"; +import "./MonitoringTagRules.tsp"; +import "./DatadogSingleSignOnResource.tsp"; +import "./MonitoredSubscriptionProperties.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@armProviderNamespace +@service(#{ title: "Microsoft.Datadog" }) +@versioned(Versions) +// FIXME: Common type version v1 is not supported for now. Set to v3. +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) +namespace Microsoft.Datadog; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2025-06-11 API version. + */ + v2025_06_11: "2025-06-11", +} + +/** + * This is the interface that implements the standard Azure Resource Manager operation that returns + * all supported RP operations. You should have exactly one declaration for each + * Azure Resource Manager service. It implements + * GET "/providers/Microsoft.ContosoProviderHub/operations" + */ +interface Operations + extends Azure.ResourceManager.Legacy.Operations< + ArmResponse, + ErrorResponse + > {} diff --git a/specification/datadog/Datadog.Management/models.tsp b/specification/datadog/Datadog.Management/models.tsp new file mode 100644 index 000000000000..c79c61623477 --- /dev/null +++ b/specification/datadog/Datadog.Management/models.tsp @@ -0,0 +1,955 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +namespace Microsoft.Datadog; +/** + * Represents a paginated list of operation results. + */ +model OperationListResult { + /** + * The list of operations. + */ + @pageItems + value: OperationResult[]; + + /** + * The URL to get the next set of results, if any. + */ + @nextLink + nextLink?: string; +} +/** + * The type of identity that created the resource. + */ +union CreatedByType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + User: "User", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Application: "Application", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + ManagedIdentity: "ManagedIdentity", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Key: "Key", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +union ProvisioningState { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Accepted: "Accepted", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Creating: "Creating", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Updating: "Updating", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Deleting: "Deleting", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Succeeded: "Succeeded", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Failed: "Failed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Canceled: "Canceled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Deleted: "Deleted", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + NotSpecified: "NotSpecified", +} + +/** + * Flag specifying if the resource monitoring is enabled or disabled. + */ +union MonitoringStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Disabled: "Disabled", +} + +/** + * Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. + */ +union MarketplaceSubscriptionStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Provisioning: "Provisioning", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Active: "Active", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Suspended: "Suspended", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Unsubscribed: "Unsubscribed", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +union LiftrResourceCategories { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Unknown: "Unknown", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + MonitorLogs: "MonitorLogs", +} + +/** + * Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'. + */ +union ManagedIdentityTypes { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + SystemAssigned: "SystemAssigned", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + UserAssigned: "UserAssigned", +} + +/** + * Valid actions for a filtering tag. Exclusion takes priority over inclusion. + */ +union TagAction { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Include: "Include", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Exclude: "Exclude", +} + +/** + * Various states of the SSO resource + */ +union SingleSignOnStates { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Initial: "Initial", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Enable: "Enable", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Disable: "Disable", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Existing: "Existing", +} + +/** + * The operation for the patch on the resource. + */ +union Operation { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + AddBegin: "AddBegin", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + AddComplete: "AddComplete", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + DeleteBegin: "DeleteBegin", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + DeleteComplete: "DeleteComplete", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Active: "Active", +} + +/** + * The state of monitoring. + */ +union Status { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + InProgress: "InProgress", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Active: "Active", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Failed: "Failed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + Deleting: "Deleting", +} + +/** + * Response of a list operation. + */ +model DatadogAgreementResourceListResponse + is Azure.Core.Page; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogAgreementResource { + /** + * ARM id of the resource. + */ + @visibility(Lifecycle.Read) + id?: string; + + /** + * Name of the agreement. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * The type of the resource. + */ + @visibility(Lifecycle.Read) + type?: string; + + /** + * Represents the properties of the resource. + */ + properties?: DatadogAgreementProperties; + + /** + * Metadata pertaining to creation and last modification of the resource. + */ + @visibility(Lifecycle.Read) + systemData?: SystemData; +} + +/** + * Terms properties. + */ +model DatadogAgreementProperties { + /** + * Publisher identifier string. + */ + publisher?: string; + + /** + * Product identifier string. + */ + product?: string; + + /** + * Plan identifier string. + */ + plan?: string; + + /** + * Link to HTML with Microsoft and Publisher terms. + */ + licenseTextLink?: string; + + /** + * Link to the privacy policy of the publisher. + */ + privacyPolicyLink?: string; + + /** + * Date and time in UTC of when the terms were accepted. This is empty if Accepted is false. + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + retrieveDatetime?: utcDateTime; + + /** + * Terms signature. + */ + signature?: string; + + /** + * If any version of the terms have been accepted, otherwise false. + */ + accepted?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model CreateResourceSupportedResponseList + is Azure.Core.Page; + +/** + * Datadog resource can be created or not. + */ +model CreateResourceSupportedResponse { + /** + * Represents the properties of the resource. + */ + properties?: CreateResourceSupportedProperties; +} + +/** + * Datadog resource can be created or not properties. + */ +model CreateResourceSupportedProperties { + /** + * The ARM id of the subscription. + */ + @visibility(Lifecycle.Read) + name?: string; + + /** + * Indicates if selected subscription supports Datadog resource creation, if not it is already being monitored for the selected organization via multi subscription feature. + */ + @visibility(Lifecycle.Read) + creationSupported?: boolean; +} + +/** + * Response of a list operation. + */ +model DatadogApiKeyListResponse is Azure.Core.Page; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogApiKey { + /** + * The user that created the API key. + */ + createdBy?: string; + + /** + * The name of the API key. + */ + name?: string; + + /** + * The value of the API key. + */ + key: string; + + /** + * The time of creation of the API key. + */ + created?: string; +} + +/** + * Response of a list operation. + */ +model DatadogHostListResponse is Azure.Core.Page; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogHost { + /** + * The name of the host. + */ + name?: string; + + /** + * The aliases for the host installed via the Datadog agent. + */ + aliases?: string[]; + + /** + * The Datadog integrations reporting metrics for the host. + */ + apps?: string[]; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + meta?: DatadogHostMetadata; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogHostMetadata { + /** + * The agent version. + */ + agentVersion?: string; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + installMethod?: DatadogInstallMethod; + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + logsAgent?: DatadogLogsAgent; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogInstallMethod { + /** + * The tool. + */ + tool?: string; + + /** + * The tool version. + */ + toolVersion?: string; + + /** + * The installer version. + */ + installerVersion?: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogLogsAgent { + /** + * The transport. + */ + transport?: string; +} + +/** + * Response of a list operation. + */ +model LinkedResourceListResponse is Azure.Core.Page; + +/** + * The definition of a linked resource. + */ +model LinkedResource { + /** + * The ARM id of the linked resource. + */ + id?: string; + + /** + * The location of the linked resource. + */ + location?: string; +} + +/** + * Response of a list operation. + */ +model MonitoredResourceListResponse is Azure.Core.Page; + +/** + * The properties of a resource currently being monitored by the Datadog monitor resource. + */ +model MonitoredResource { + /** + * The ARM id of the resource. + */ + id?: string; + + /** + * Flag indicating if resource is sending metrics to Datadog. + */ + sendingMetrics?: boolean; + + /** + * Reason for why the resource is sending metrics (or why it is not sending). + */ + reasonForMetricsStatus?: string; + + /** + * Flag indicating if resource is sending logs to Datadog. + */ + sendingLogs?: boolean; + + /** + * Reason for why the resource is sending logs (or why it is not sending). + */ + reasonForLogsStatus?: string; +} + +/** + * A Microsoft.Datadog REST API operation. + */ +model OperationResult { + /** + * Operation name, i.e., {provider}/{resource}/{operation}. + */ + name?: string; + + /** + * The object that represents the operation. + */ + display?: OperationDisplay; + + /** + * Indicates whether the operation is a data action + */ + isDataAction?: boolean; +} + +/** + * The object that represents the operation. + */ +model OperationDisplay { + /** + * Service provider, i.e., Microsoft.Datadog. + */ + provider?: string; + + /** + * Type on which the operation is performed, e.g., 'monitors'. + */ + resource?: string; + + /** + * Operation type, e.g., read, write, delete, etc. + */ + operation?: string; + + /** + * Description of the operation, e.g., 'Write monitors'. + */ + description?: string; +} + +/** + * Response of a list operation. + */ +model DatadogMonitorResourceListResponse + is Azure.Core.Page; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model ResourceSku { + /** + * Name of the SKU in {PlanId} format. For Terraform, the only allowed value is 'Linked'. + */ + name: string; +} + +/** + * Properties specific to the monitor resource. + */ +model MonitorProperties { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * Flag specifying if the resource monitoring is enabled or disabled. + */ + monitoringStatus?: MonitoringStatus = MonitoringStatus.Enabled; + + /** + * Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. + */ + @visibility(Lifecycle.Read) + marketplaceSubscriptionStatus?: MarketplaceSubscriptionStatus; + + /** + * Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well. + */ + datadogOrganizationProperties?: DatadogOrganizationProperties; + + /** + * Includes name, email and optionally, phone number. User Information can't be null. + */ + userInfo?: UserInfo; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + @visibility(Lifecycle.Read) + liftrResourceCategory?: LiftrResourceCategories; + + /** + * The priority of the resource. + */ + @visibility(Lifecycle.Read) + liftrResourcePreference?: int32; +} + +/** + * Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well. + */ +model DatadogOrganizationProperties { + /** + * Name of the Datadog organization. + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + name?: string; + + /** + * Id of the Datadog organization. + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + id?: string; + + /** + * The auth code used to linking to an existing Datadog organization. + */ + @visibility(Lifecycle.Create) + @secret + linkingAuthCode?: string; + + /** + * The client_id from an existing in exchange for an auth token to link organization. + */ + @visibility(Lifecycle.Create) + @secret + linkingClientId?: string; + + /** + * The redirect URI for linking. + */ + @visibility(Lifecycle.Create) + redirectUri?: string; + + /** + * Api key associated to the Datadog organization. + */ + @visibility(Lifecycle.Create) + @secret + apiKey?: string; + + /** + * Application key associated to the Datadog organization. + */ + @visibility(Lifecycle.Create) + @secret + applicationKey?: string; + + /** + * The Id of the Enterprise App used for Single sign on. + */ + @visibility(Lifecycle.Create) + enterpriseAppId?: string; + + /** + * The configuration which describes the state of cloud security posture management. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks. + */ + cspm?: boolean; + + /** + * The configuration which describes the state of resource collection. This collects configuration information for all resources in a subscription. + */ + resourceCollection?: boolean; +} + +/** + * Includes name, email and optionally, phone number. User Information can't be null. + */ +model UserInfo { + /** + * Name of the user + */ + @maxLength(50) + name?: string; + + /** + * Email of the user used by Datadog for contacting them if needed + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + emailAddress?: string; + + /** + * Phone number of the user used by Datadog for contacting them if needed + */ + @maxLength(40) + phoneNumber?: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model IdentityProperties { + /** + * The identity ID. + */ + @visibility(Lifecycle.Read) + principalId?: string; + + /** + * The tenant ID of resource. + */ + @visibility(Lifecycle.Read) + tenantId?: string; + + /** + * Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'. + */ + type?: ManagedIdentityTypes; +} + +/** + * The parameters for a PATCH request to a monitor resource. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/patch-envelope" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model DatadogMonitorResourceUpdateParameters { + /** + * The set of properties that can be update in a PATCH request to a monitor resource. + */ + properties?: MonitorUpdateProperties; + + /** + * The new tags of the monitor resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "For backward compatibility" + tags?: Record; + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + sku?: ResourceSku; +} + +/** + * The set of properties that can be update in a PATCH request to a monitor resource. + */ +model MonitorUpdateProperties { + /** + * Flag specifying if the resource monitoring is enabled or disabled. + */ + monitoringStatus?: MonitoringStatus = MonitoringStatus.Enabled; + + /** + * The new cloud security posture management value of the monitor resource. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks. + */ + cspm?: boolean; + + /** + * The new resource collection value of the monitor resource. This collects configuration information for all resources in a subscription. + */ + resourceCollection?: boolean; +} + +/** + * Marketplace Subscription and Organization details to which resource gets billed into. + */ +model BillingInfoResponse { + /** + * Marketplace Subscription details + */ + marketplaceSaasInfo?: MarketplaceSaaSInfo; + + /** + * Partner Billing Entity details: Organization Info + */ + partnerBillingEntity?: PartnerBillingEntity; +} + +/** + * Marketplace SAAS Info of the resource. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model MarketplaceSaaSInfo { + /** + * Marketplace Subscription Id. This is a GUID-formatted string. + */ + marketplaceSubscriptionId?: string; + + /** + * Marketplace Subscription Details: SAAS Name + */ + marketplaceName?: string; + + /** + * Marketplace Subscription Details: SaaS Subscription Status + */ + marketplaceStatus?: string; + + /** + * The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. + */ + billedAzureSubscriptionId?: string; + + /** + * Flag specifying if the Marketplace status is subscribed or not. + */ + subscribed?: boolean; +} + +/** + * Partner Billing details associated with the resource. + */ +model PartnerBillingEntity { + /** + * The Datadog Organization Id. + */ + id?: string; + + /** + * The Datadog Organization Name. + */ + name?: string; + + /** + * Link to the datadog organization page + */ + partnerEntityUri?: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogSetPasswordLink { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + setPasswordLink?: string; +} + +/** + * Response of a list operation. + */ +model MonitoringTagRulesListResponse is Azure.Core.Page; + +/** + * Definition of the properties for a TagRules resource. + */ +model MonitoringTagRulesProperties { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * Set of rules for sending logs for the Monitor resource. + */ + logRules?: LogRules; + + /** + * Set of rules for sending metrics for the Monitor resource. + */ + metricRules?: MetricRules; + + /** + * Set of rules for managing agents for the Monitor resource. + */ + agentRules?: AgentRules; + + /** + * Configuration to enable/disable auto-muting flag + */ + automuting?: boolean; + + /** + * Configuration to enable/disable custom metrics. If enabled, custom metrics from app insights will be sent. + */ + customMetrics?: boolean; +} + +/** + * Set of rules for sending logs for the Monitor resource. + */ +model LogRules { + /** + * Flag specifying if AAD logs should be sent for the Monitor resource. + */ + sendAadLogs?: boolean; + + /** + * Flag specifying if Azure subscription logs should be sent for the Monitor resource. + */ + sendSubscriptionLogs?: boolean; + + /** + * Flag specifying if Azure resource logs should be sent for the Monitor resource. + */ + sendResourceLogs?: boolean; + + /** + * List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + */ + filteringTags?: FilteringTag[]; +} + +/** + * The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored. + */ +model FilteringTag { + /** + * The name (also known as the key) of the tag. + */ + name?: string; + + /** + * The value of the tag. + */ + value?: string; + + /** + * Valid actions for a filtering tag. Exclusion takes priority over inclusion. + */ + action?: TagAction; +} + +/** + * Set of rules for sending metrics for the Monitor resource. + */ +model MetricRules { + /** + * List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + */ + filteringTags?: FilteringTag[]; +} + +/** + * Set of rules for managing agents for the Monitor resource. + */ +model AgentRules { + /** + * Flag specifying if agent monitoring should be enabled for the Monitor resource. + */ + enableAgentMonitoring?: boolean; + + /** + * List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + */ + filteringTags?: FilteringTag[]; +} + +/** + * Response of a list operation. + */ +model DatadogSingleSignOnResourceListResponse + is Azure.Core.Page; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model DatadogSingleSignOnProperties { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * Various states of the SSO resource + */ + singleSignOnState?: SingleSignOnStates; + + /** + * The Id of the Enterprise App used for Single sign-on. + */ + enterpriseAppId?: string; + + /** + * The login URL specific to this Datadog Organization. + */ + @visibility(Lifecycle.Read) + singleSignOnUrl?: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" +model MonitoredSubscriptionPropertiesList + is Azure.Core.Page; + +/** + * The request to update subscriptions needed to be monitored by the Datadog monitor resource. + */ +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "For backward compatibility" +model SubscriptionList { + /** + * The operation for the patch on the resource. + */ + @visibility(Lifecycle.Create, Lifecycle.Update) + operation?: Operation; + + /** + * List of subscriptions and the state of the monitoring. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + monitoredSubscriptionList?: MonitoredSubscription[]; +} + +/** + * The list of subscriptions and it's monitoring status by current Datadog monitor. + */ +model MonitoredSubscription { + /** + * The subscriptionId to be monitored. + */ + subscriptionId?: string; + + /** + * The state of monitoring. + */ + status?: Status; + + /** + * The reason of not monitoring the subscription. + */ + error?: string; + + /** + * Definition of the properties for a TagRules resource. + */ + tagRules?: MonitoringTagRulesProperties; +} + +/** + * Resubscribe Properties + */ +model ResubscribeProperties { + #suppress "@azure-tools/typespec-azure-core/documentation-required" "For backward compatibility" + sku?: ResourceSku; + + /** + * Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe + */ + azureSubscriptionId?: string; + + /** + * Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe + */ + resourceGroup?: string; +} diff --git a/specification/datadog/Datadog.Management/routes.tsp b/specification/datadog/Datadog.Management/routes.tsp new file mode 100644 index 000000000000..f71bd6464de8 --- /dev/null +++ b/specification/datadog/Datadog.Management/routes.tsp @@ -0,0 +1,84 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using TypeSpec.OpenAPI; + +namespace Microsoft.Datadog; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface MarketplaceAgreementsOperationGroup { + /** + * List Datadog marketplace agreements in the subscription. + */ + @summary("List Datadog marketplace agreements in the subscription.") + @autoRoute + @get + @list + @action("agreements") + list is ArmProviderActionSync< + Response = DatadogAgreementResourceListResponse, + Scope = SubscriptionActionScope, + Parameters = {} + >; + /** + * Create Datadog marketplace agreement in the subscription. + */ + @summary("Create Datadog marketplace agreement in the subscription.") + @autoRoute + @put + @action("agreements/default") + createOrUpdate is ArmProviderActionSync< + Request = DatadogAgreementResource, + Response = DatadogAgreementResource, + Scope = SubscriptionActionScope, + Parameters = {}, + OptionalRequestBody = true + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface CreationSupportedOperationGroup { + /** + * Informs if the current subscription is being already monitored for selected Datadog organization. + */ + @summary("Informs if the current subscription is being already monitored for selected Datadog organization.") + @autoRoute + @get + @list + @action("subscriptionStatuses") + list is ArmProviderActionSync< + Response = CreateResourceSupportedResponseList, + Scope = SubscriptionActionScope, + Parameters = { + /** + * Datadog Organization Id + */ + @query("datadogOrganizationId") + datadogOrganizationId: string; + } + >; + /** + * Informs if the current subscription is being already monitored for selected Datadog organization. + */ + @summary("Informs if the current subscription is being already monitored for selected Datadog organization.") + @autoRoute + @get + @action("subscriptionStatuses/default") + get is ArmProviderActionSync< + Response = CreateResourceSupportedResponse, + Scope = SubscriptionActionScope, + Parameters = { + /** + * Datadog Organization Id + */ + @query("datadogOrganizationId") + datadogOrganizationId: string; + } + >; +} diff --git a/specification/datadog/Datadog.Management/tspconfig.yaml b/specification/datadog/Datadog.Management/tspconfig.yaml new file mode 100644 index 000000000000..0dee4eca5946 --- /dev/null +++ b/specification/datadog/Datadog.Management/tspconfig.yaml @@ -0,0 +1,45 @@ +parameters: + "service-dir": + default: "sdk/datadog" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/datadog.json" + examples-dir: "{project-root}/examples" + emit-lro-options: "all" + "@azure-tools/typespec-python": + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-datadog" + namespace: "azure.mgmt.datadog" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-datadog" + namespace: "com.azure.resourcemanager.datadog" + service-name: "Microsoft Datadog" + flavor: azure + "@azure-tools/typespec-ts": + service-dir: sdk/datadog + emitter-output-dir: "{output-dir}/{service-dir}/arm-datadog" + is-modular-library: true + flavor: "azure" + experimental-extensible-enums: true + package-details: + name: "@azure/arm-datadog" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/datadog" + emitter-output-dir: "{output-dir}/{service-dir}/armdatadog" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armdatadog" + fix-const-stuttering: true + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/datadog.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/datadog.json new file mode 100644 index 000000000000..53078102065b --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/datadog.json @@ -0,0 +1,2674 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Datadog", + "version": "2024-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements": { + "get": { + "tags": [ + "Agreements" + ], + "summary": "List Datadog marketplace agreements in the subscription.", + "operationId": "MarketplaceAgreements_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogAgreementResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MarketplaceAgreements_List": { + "$ref": "./examples/MarketplaceAgreements_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements/default": { + "put": { + "tags": [ + "Agreements" + ], + "summary": "Create Datadog marketplace agreement in the subscription.", + "operationId": "MarketplaceAgreements_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogAgreementResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogAgreementResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MarketplaceAgreements_CreateOrUpdate": { + "$ref": "./examples/MarketplaceAgreements_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/subscriptionStatuses": { + "get": { + "tags": [ + "CreateResource" + ], + "summary": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "operationId": "CreationSupported_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DatadogOrganizationId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CreateResourceSupportedResponseList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CreationSupported_List": { + "$ref": "./examples/CreationSupported_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/subscriptionStatuses/default": { + "get": { + "tags": [ + "CreateResource" + ], + "summary": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "operationId": "CreationSupported_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DatadogOrganizationId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CreateResourceSupportedResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreationSupported_Get": { + "$ref": "./examples/CreationSupported_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listApiKeys": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "List the api keys for a given monitor resource.", + "operationId": "Monitors_ListApiKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogApiKeyListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListApiKeys": { + "$ref": "./examples/ApiKeys_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getDefaultKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Get the default api key.", + "operationId": "Monitors_GetDefaultKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogApiKey" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetDefaultKey": { + "$ref": "./examples/ApiKeys_GetDefaultKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/setDefaultKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Set the default api key.", + "operationId": "Monitors_SetDefaultKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogApiKey" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_SetDefaultKey": { + "$ref": "./examples/ApiKeys_SetDefaultKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listHosts": { + "post": { + "tags": [ + "Hosts" + ], + "summary": "List the hosts for a given monitor resource.", + "operationId": "Monitors_ListHosts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListHosts": { + "$ref": "./examples/Hosts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listLinkedResources": { + "post": { + "tags": [ + "LinkedResources" + ], + "summary": "List all Azure resources associated to the same Datadog organization as the target resource.", + "operationId": "Monitors_ListLinkedResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LinkedResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Datadog monitor resource.", + "operationId": "Monitors_ListMonitoredResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListMonitoredResources": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/providers/Microsoft.Datadog/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Datadog for the 2024-03-01 api version.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/refreshSetPasswordLink": { + "post": { + "tags": [ + "RefreshSetPasswordLink" + ], + "summary": "Refresh the set password link and return a latest one.", + "operationId": "Monitors_RefreshSetPasswordLink", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSetPasswordLink" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_RefreshSetPasswordLink": { + "$ref": "./examples/RefreshSetPassword_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Rule set name", + "in": "path", + "name": "ruleSetName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Rule set name", + "in": "path", + "name": "ruleSetName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations": { + "get": { + "tags": [ + "SingleSignOn" + ], + "summary": "List the single sign-on configurations for a given monitor resource.", + "operationId": "SingleSignOnConfigurations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SingleSignOnConfigurations_List": { + "$ref": "./examples/SingleSignOnConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}": { + "put": { + "tags": [ + "SingleSignOn" + ], + "summary": "Configures single-sign-on for this resource.", + "operationId": "SingleSignOnConfigurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Configuration name", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SingleSignOnConfigurations_CreateOrUpdate": { + "$ref": "./examples/SingleSignOnConfigurations_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SingleSignOn" + ], + "summary": "Gets the datadog single sign-on resource for the given Monitor.", + "operationId": "SingleSignOnConfigurations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Configuration name", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SingleSignOnConfigurations_Get": { + "$ref": "./examples/SingleSignOnConfigurations_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "operationId": "MonitoredSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "operationId": "MonitoredSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the Datadog monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Configuration name", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + } + }, + "definitions": { + "DatadogAgreementProperties": { + "description": "Terms properties.", + "type": "object", + "properties": { + "publisher": { + "description": "Publisher identifier string.", + "type": "string" + }, + "product": { + "description": "Product identifier string.", + "type": "string" + }, + "plan": { + "description": "Plan identifier string.", + "type": "string" + }, + "licenseTextLink": { + "description": "Link to HTML with Microsoft and Publisher terms.", + "type": "string" + }, + "privacyPolicyLink": { + "description": "Link to the privacy policy of the publisher.", + "type": "string" + }, + "retrieveDatetime": { + "format": "date-time", + "description": "Date and time in UTC of when the terms were accepted. This is empty if Accepted is false.", + "type": "string" + }, + "signature": { + "description": "Terms signature.", + "type": "string" + }, + "accepted": { + "description": "If any version of the terms have been accepted, otherwise false.", + "type": "boolean" + } + } + }, + "DatadogAgreementResource": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the agreement.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatadogAgreementProperties", + "description": "Represents the properties of the resource." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DatadogAgreementResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogAgreementResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "CreateResourceSupportedProperties": { + "description": "Datadog resource can be created or not properties.", + "type": "object", + "properties": { + "name": { + "description": "The ARM id of the subscription.", + "type": "string", + "readOnly": true + }, + "creationSupported": { + "description": "Indicates if selected subscription supports Datadog resource creation, if not it is already being monitored for the selected organization via multi subscription feature. ", + "type": "boolean", + "readOnly": true + } + } + }, + "CreateResourceSupportedResponse": { + "description": "Datadog resource can be created or not.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateResourceSupportedProperties", + "description": "Represents the properties of the resource." + } + } + }, + "CreateResourceSupportedResponseList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CreateResourceSupportedResponse" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "DatadogApiKey": { + "required": [ + "key" + ], + "type": "object", + "properties": { + "createdBy": { + "description": "The user that created the API key.", + "type": "string" + }, + "name": { + "description": "The name of the API key.", + "type": "string" + }, + "key": { + "description": "The value of the API key.", + "type": "string" + }, + "created": { + "description": "The time of creation of the API key.", + "type": "string" + } + } + }, + "DatadogApiKeyListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogApiKey" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "DatadogInstallMethod": { + "type": "object", + "properties": { + "tool": { + "description": "The tool.", + "type": "string" + }, + "toolVersion": { + "description": "The tool version.", + "type": "string" + }, + "installerVersion": { + "description": "The installer version.", + "type": "string" + } + } + }, + "DatadogLogsAgent": { + "type": "object", + "properties": { + "transport": { + "description": "The transport.", + "type": "string" + } + } + }, + "DatadogHostMetadata": { + "type": "object", + "properties": { + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "installMethod": { + "$ref": "#/definitions/DatadogInstallMethod" + }, + "logsAgent": { + "$ref": "#/definitions/DatadogLogsAgent" + } + } + }, + "DatadogHost": { + "type": "object", + "properties": { + "name": { + "description": "The name of the host.", + "type": "string" + }, + "aliases": { + "description": "The aliases for the host installed via the Datadog agent.", + "type": "array", + "items": { + "type": "string" + } + }, + "apps": { + "description": "The Datadog integrations reporting metrics for the host.", + "type": "array", + "items": { + "type": "string" + } + }, + "meta": { + "$ref": "#/definitions/DatadogHostMetadata" + } + } + }, + "DatadogHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogHost" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LinkedResource": { + "description": "The definition of a linked resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the linked resource.", + "type": "string" + }, + "location": { + "description": "The location of the linked resource.", + "type": "string" + } + } + }, + "LinkedResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Datadog monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingMetrics": { + "description": "Flag indicating if resource is sending metrics to Datadog.", + "type": "boolean" + }, + "reasonForMetricsStatus": { + "description": "Reason for why the resource is sending metrics (or why it is not sending).", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating if resource is sending logs to Datadog.", + "type": "boolean" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Datadog Organization Id.", + "type": "string" + }, + "name": { + "description": "The Datadog Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the datadog organization page", + "type": "string" + } + } + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current Datadog monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource.", + "type": "object", + "properties": { + "operation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Operation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + } + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Datadog.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Datadog REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Datadog operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Datadog provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU in {PlanId} format. For Terraform, the only allowed value is 'Linked'.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + }, + "readOnly": true + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "MarketplaceSubscriptionStatus": { + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "enum": [ + "Provisioning", + "Active", + "Suspended", + "Unsubscribed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MarketplaceSubscriptionStatus" + }, + "readOnly": true + }, + "DatadogOrganizationProperties": { + "description": "Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "id": { + "description": "Id of the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "linkingAuthCode": { + "description": "The auth code used to linking to an existing Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "linkingClientId": { + "description": "The client_id from an existing in exchange for an auth token to link organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "redirectUri": { + "description": "The redirect URI for linking.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "apiKey": { + "description": "Api key associated to the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "applicationKey": { + "description": "Application key associated to the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "enterpriseAppId": { + "description": "The Id of the Enterprise App used for Single sign on.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "cspm": { + "description": "The configuration which describes the state of cloud security posture management. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks.", + "type": "boolean" + } + } + }, + "UserInfo": { + "description": "Includes name, email and optionally, phone number. User Information can't be null.", + "type": "object", + "properties": { + "name": { + "description": "Name of the user", + "maxLength": 50, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Datadog for contacting them if needed", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the user used by Datadog for contacting them if needed", + "maxLength": 40, + "type": "string" + } + }, + "x-ms-secret": true + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus" + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus" + }, + "datadogOrganizationProperties": { + "$ref": "#/definitions/DatadogOrganizationProperties" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "description": "Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "DatadogMonitorResource": { + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "$ref": "#/definitions/MonitorProperties" + }, + "identity": { + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DatadogMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitorUpdateProperties": { + "description": "The set of properties that can be update in a PATCH request to a monitor resource.", + "type": "object", + "properties": { + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus" + }, + "cspm": { + "description": "The new cloud security posture management value of the monitor resource. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks.", + "type": "boolean" + } + } + }, + "DatadogMonitorResourceUpdateParameters": { + "description": "The parameters for a PATCH request to a monitor resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorUpdateProperties" + }, + "tags": { + "description": "The new tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + } + } + }, + "DatadogSetPasswordLink": { + "type": "object", + "properties": { + "setPasswordLink": { + "type": "string" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "$ref": "#/definitions/TagAction" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if Azure subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendResourceLogs": { + "description": "Flag specifying if Azure resource logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MetricRules": { + "description": "Set of rules for sending metrics for the Monitor resource.", + "type": "object", + "properties": { + "filteringTags": { + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "AgentRules": { + "description": "Set of rules for managing agents for the Monitor resource.", + "type": "object", + "properties": { + "enableAgentMonitoring": { + "description": "Flag specifying if agent monitoring should be enabled for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "$ref": "#/definitions/LogRules" + }, + "metricRules": { + "$ref": "#/definitions/MetricRules" + }, + "agentRules": { + "$ref": "#/definitions/AgentRules" + }, + "automuting": { + "description": "Configuration to enable/disable auto-muting flag", + "type": "boolean" + }, + "customMetrics": { + "description": "Configuration to enable/disable custom metrics. If enabled, custom metrics from app insights will be sent.", + "type": "boolean" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "SingleSignOnStates": { + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable", + "Existing" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SingleSignOnStates" + } + }, + "DatadogSingleSignOnProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates" + }, + "enterpriseAppId": { + "description": "The Id of the Enterprise App used for Single sign-on.", + "type": "string" + }, + "singleSignOnUrl": { + "description": "The login URL specific to this Datadog Organization.", + "type": "string", + "readOnly": true + } + } + }, + "DatadogSingleSignOnResource": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the configuration.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatadogSingleSignOnProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DatadogSingleSignOnResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$", + "minLength": 2, + "maxLength": 32 + }, + "DatadogOrganizationId": { + "in": "query", + "name": "datadogOrganizationId", + "description": "Datadog Organization Id", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_GetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_GetDefaultKey.json new file mode 100644 index 000000000000..8dc2ddb42e72 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_GetDefaultKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "createdBy": "john@example.com", + "name": "", + "key": "1111111111111111aaaaaaaaaaaaaaaa", + "created": "2019-04-05 09:20:30" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_List.json new file mode 100644 index 000000000000..5541961b1f33 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "createdBy": "john@example.com", + "name": "", + "key": "1111111111111111aaaaaaaaaaaaaaaa", + "created": "2019-04-05 09:20:30" + }, + { + "createdBy": "jane@example.com", + "name": "", + "key": "2111111111111111aaaaaaaaaaaaaaaa", + "created": "2019-04-05 09:19:53" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_SetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_SetDefaultKey.json new file mode 100644 index 000000000000..f82466f11b10 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/ApiKeys_SetDefaultKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "key": "1111111111111111aaaaaaaaaaaaaaaa" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/BillingInfo_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..9dda6a1936b8 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/BillingInfo_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceName": "MP_RESOURCE", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "datadogOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/CreationSupported_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/CreationSupported_Get.json new file mode 100644 index 000000000000..b12ef343052f --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/CreationSupported_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "datadogOrganizationId": "00000000-0000-0000-0000" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/CreationSupported_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/CreationSupported_List.json new file mode 100644 index 000000000000..2d13fa57c195 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/CreationSupported_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "datadogOrganizationId": "00000000-0000-0000-0000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Hosts_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Hosts_List.json new file mode 100644 index 000000000000..7ff87536e891 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Hosts_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vm1", + "aliases": [ + "vm1", + "65f2dd83-95ae-4f56-b6aa-a5dafc05f4cd" + ], + "apps": [ + "ntp", + "agent" + ], + "meta": { + "agentVersion": "7.19.2", + "installMethod": { + "tool": "install_script", + "toolVersion": "install_script", + "installerVersion": "install_script-1.0.0" + }, + "logsAgent": { + "transport": "" + } + } + }, + { + "name": "vm2", + "aliases": [ + "vm2", + "df631d9a-8178-4580-bf60-c697a5e8df4d" + ], + "apps": [ + "infra", + "agent" + ], + "meta": { + "agentVersion": "7.18.1", + "installMethod": { + "tool": "install_script", + "toolVersion": "install_script", + "installerVersion": "install_script-1.0.0" + }, + "logsAgent": { + "transport": "HTTP" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/LinkedResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/LinkedResources_List.json new file mode 100644 index 000000000000..94c4111d500c --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/LinkedResources_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor", + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MarketplaceAgreements_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MarketplaceAgreements_Create.json new file mode 100644 index 000000000000..70d043b7ad0a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MarketplaceAgreements_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "properties": { + "accepted": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/default", + "name": "default", + "type": "Microsoft.Datadog/agreements", + "properties": { + "publisher": "pubid1", + "product": "offid1", + "plan": "planid1", + "licenseTextLink": "test.licenseLink1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": true + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MarketplaceAgreements_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MarketplaceAgreements_List.json new file mode 100644 index 000000000000..70c9cfe9f278 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MarketplaceAgreements_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id1", + "name": "planid1", + "type": "Microsoft.Datadog/agreements", + "properties": { + "publisher": "pubid1", + "product": "offid1", + "plan": "planid1", + "licenseTextLink": "test.licenseLink1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id2", + "name": "planid2", + "type": "Microsoft.Datadog/agreements", + "properties": { + "publisher": "pubid2", + "product": "offid2", + "plan": "planid2", + "licenseTextLink": "test.licenseLin2k", + "privacyPolicyLink": "test.privacyPolicyLink2", + "retrieveDatetime": "2017-08-14T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": false + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..2496b9964fe9 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredResources_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingMetrics": true, + "reasonForMetricsStatus": "CapturedByRules", + "sendingLogs": true, + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..702c808c54a9 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "body": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..342e9f59e2e0 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..662898459c9c --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..fd2c93f12a58 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..07086b281912 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "body": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Create.json new file mode 100644 index 000000000000..fa09b2571892 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Create.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "body": { + "sku": { + "name": "free_Monthly" + }, + "properties": { + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": "someAuthCode", + "linkingClientId": "00000000-0000-0000-0000-000000000000", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "cspm": false + }, + "userInfo": { + "name": "Alice", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123-456-7890" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Delete.json new file mode 100644 index 000000000000..6bbf78c55e6a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Get.json new file mode 100644 index 000000000000..577530b7d2e6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null, + "cspm": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_List.json new file mode 100644 index 000000000000..9b93a78a90e0 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null, + "cspm": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..3efb41fc1335 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Update.json new file mode 100644 index 000000000000..46b21f1666a7 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Monitors_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "body": { + "properties": { + "monitoringStatus": "Enabled" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Operations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Operations_List.json new file mode 100644 index 000000000000..f85ebc25a6c6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Datadog/monitors/write", + "display": { + "provider": "Microsoft.Datadog", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/RefreshSetPassword_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/RefreshSetPassword_Get.json new file mode 100644 index 000000000000..504900674181 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/RefreshSetPassword_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "setPasswordLink": "https://datadoghq.com/reset_password/tokenvalue123" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..8fd91de6fbd9 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_CreateOrUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "body": { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": null + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": null + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_Get.json new file mode 100644 index 000000000000..1dd1cc311da5 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_List.json new file mode 100644 index 000000000000..c512536a84cf --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/SingleSignOnConfigurations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..e029cff33abc --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "body": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_Get.json new file mode 100644 index 000000000000..e1bd22157a37 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "automuting": true, + "customMetrics": false + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_List.json new file mode 100644 index 000000000000..543fc8a9247a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2024-03-01/examples/TagRules_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "automuting": true, + "customMetrics": false + } + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/datadog.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/datadog.json new file mode 100644 index 000000000000..0fe48cbf6afc --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/datadog.json @@ -0,0 +1,2759 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Datadog", + "version": "2025-01-07" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements": { + "get": { + "tags": [ + "Agreements" + ], + "summary": "List Datadog marketplace agreements in the subscription.", + "operationId": "MarketplaceAgreements_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogAgreementResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MarketplaceAgreements_List": { + "$ref": "./examples/MarketplaceAgreements_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements/default": { + "put": { + "tags": [ + "Agreements" + ], + "summary": "Create Datadog marketplace agreement in the subscription.", + "operationId": "MarketplaceAgreements_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogAgreementResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogAgreementResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MarketplaceAgreements_CreateOrUpdate": { + "$ref": "./examples/MarketplaceAgreements_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/subscriptionStatuses": { + "get": { + "tags": [ + "CreateResource" + ], + "summary": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "operationId": "CreationSupported_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DatadogOrganizationId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CreateResourceSupportedResponseList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CreationSupported_List": { + "$ref": "./examples/CreationSupported_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/subscriptionStatuses/default": { + "get": { + "tags": [ + "CreateResource" + ], + "summary": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "operationId": "CreationSupported_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DatadogOrganizationId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/CreateResourceSupportedResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreationSupported_Get": { + "$ref": "./examples/CreationSupported_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listApiKeys": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "List the api keys for a given monitor resource.", + "operationId": "Monitors_ListApiKeys", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogApiKeyListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListApiKeys": { + "$ref": "./examples/ApiKeys_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getDefaultKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Get the default api key.", + "operationId": "Monitors_GetDefaultKey", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogApiKey" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetDefaultKey": { + "$ref": "./examples/ApiKeys_GetDefaultKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/setDefaultKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Set the default api key.", + "operationId": "Monitors_SetDefaultKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogApiKey" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_SetDefaultKey": { + "$ref": "./examples/ApiKeys_SetDefaultKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listHosts": { + "post": { + "tags": [ + "Hosts" + ], + "summary": "List the hosts for a given monitor resource.", + "operationId": "Monitors_ListHosts", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListHosts": { + "$ref": "./examples/Hosts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listLinkedResources": { + "post": { + "tags": [ + "LinkedResources" + ], + "summary": "List all Azure resources associated to the same Datadog organization as the target resource.", + "operationId": "Monitors_ListLinkedResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/LinkedResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Datadog monitor resource.", + "operationId": "Monitors_ListMonitoredResources", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListMonitoredResources": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/providers/Microsoft.Datadog/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Datadog for the 2025-01-07 api version.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/refreshSetPasswordLink": { + "post": { + "tags": [ + "RefreshSetPasswordLink" + ], + "summary": "Refresh the set password link and return a latest one.", + "operationId": "Monitors_RefreshSetPasswordLink", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSetPasswordLink" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_RefreshSetPasswordLink": { + "$ref": "./examples/RefreshSetPassword_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Rule set name", + "in": "path", + "name": "ruleSetName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Rule set name", + "in": "path", + "name": "ruleSetName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations": { + "get": { + "tags": [ + "SingleSignOn" + ], + "summary": "List the single sign-on configurations for a given monitor resource.", + "operationId": "SingleSignOnConfigurations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SingleSignOnConfigurations_List": { + "$ref": "./examples/SingleSignOnConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}": { + "put": { + "tags": [ + "SingleSignOn" + ], + "summary": "Configures single-sign-on for this resource.", + "operationId": "SingleSignOnConfigurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Configuration name", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SingleSignOnConfigurations_CreateOrUpdate": { + "$ref": "./examples/SingleSignOnConfigurations_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "SingleSignOn" + ], + "summary": "Gets the datadog single sign-on resource for the given Monitor.", + "operationId": "SingleSignOnConfigurations_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Configuration name", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SingleSignOnConfigurations_Get": { + "$ref": "./examples/SingleSignOnConfigurations_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "operationId": "MonitoredSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "operationId": "MonitoredSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the Datadog monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "description": "Configuration name", + "in": "path", + "name": "configurationName", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/resubscribe": { + "post": { + "tags": [ + "Resubscribe" + ], + "summary": "Reinstate integration with your Datadog organization by choosing one of the available subscription plans.", + "operationId": "Organizations_Resubscribe", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Resubscribe Properties", + "schema": { + "$ref": "#/definitions/ResubscribeProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Organizations_Resubscribe": { + "$ref": "./examples/Organizations_Resubscribe.json" + } + } + } + } + }, + "definitions": { + "DatadogAgreementProperties": { + "description": "Terms properties.", + "type": "object", + "properties": { + "publisher": { + "description": "Publisher identifier string.", + "type": "string" + }, + "product": { + "description": "Product identifier string.", + "type": "string" + }, + "plan": { + "description": "Plan identifier string.", + "type": "string" + }, + "licenseTextLink": { + "description": "Link to HTML with Microsoft and Publisher terms.", + "type": "string" + }, + "privacyPolicyLink": { + "description": "Link to the privacy policy of the publisher.", + "type": "string" + }, + "retrieveDatetime": { + "format": "date-time", + "description": "Date and time in UTC of when the terms were accepted. This is empty if Accepted is false.", + "type": "string" + }, + "signature": { + "description": "Terms signature.", + "type": "string" + }, + "accepted": { + "description": "If any version of the terms have been accepted, otherwise false.", + "type": "boolean" + } + } + }, + "DatadogAgreementResource": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the agreement.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatadogAgreementProperties", + "description": "Represents the properties of the resource." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DatadogAgreementResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogAgreementResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "CreateResourceSupportedProperties": { + "description": "Datadog resource can be created or not properties.", + "type": "object", + "properties": { + "name": { + "description": "The ARM id of the subscription.", + "type": "string", + "readOnly": true + }, + "creationSupported": { + "description": "Indicates if selected subscription supports Datadog resource creation, if not it is already being monitored for the selected organization via multi subscription feature. ", + "type": "boolean", + "readOnly": true + } + } + }, + "CreateResourceSupportedResponse": { + "description": "Datadog resource can be created or not.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CreateResourceSupportedProperties", + "description": "Represents the properties of the resource." + } + } + }, + "CreateResourceSupportedResponseList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CreateResourceSupportedResponse" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "DatadogApiKey": { + "required": [ + "key" + ], + "type": "object", + "properties": { + "createdBy": { + "description": "The user that created the API key.", + "type": "string" + }, + "name": { + "description": "The name of the API key.", + "type": "string" + }, + "key": { + "description": "The value of the API key.", + "type": "string" + }, + "created": { + "description": "The time of creation of the API key.", + "type": "string" + } + } + }, + "DatadogApiKeyListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogApiKey" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "DatadogInstallMethod": { + "type": "object", + "properties": { + "tool": { + "description": "The tool.", + "type": "string" + }, + "toolVersion": { + "description": "The tool version.", + "type": "string" + }, + "installerVersion": { + "description": "The installer version.", + "type": "string" + } + } + }, + "DatadogLogsAgent": { + "type": "object", + "properties": { + "transport": { + "description": "The transport.", + "type": "string" + } + } + }, + "DatadogHostMetadata": { + "type": "object", + "properties": { + "agentVersion": { + "description": "The agent version.", + "type": "string" + }, + "installMethod": { + "$ref": "#/definitions/DatadogInstallMethod" + }, + "logsAgent": { + "$ref": "#/definitions/DatadogLogsAgent" + } + } + }, + "DatadogHost": { + "type": "object", + "properties": { + "name": { + "description": "The name of the host.", + "type": "string" + }, + "aliases": { + "description": "The aliases for the host installed via the Datadog agent.", + "type": "array", + "items": { + "type": "string" + } + }, + "apps": { + "description": "The Datadog integrations reporting metrics for the host.", + "type": "array", + "items": { + "type": "string" + } + }, + "meta": { + "$ref": "#/definitions/DatadogHostMetadata" + } + } + }, + "DatadogHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogHost" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LinkedResource": { + "description": "The definition of a linked resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the linked resource.", + "type": "string" + }, + "location": { + "description": "The location of the linked resource.", + "type": "string" + } + } + }, + "LinkedResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkedResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Datadog monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingMetrics": { + "description": "Flag indicating if resource is sending metrics to Datadog.", + "type": "boolean" + }, + "reasonForMetricsStatus": { + "description": "Reason for why the resource is sending metrics (or why it is not sending).", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating if resource is sending logs to Datadog.", + "type": "boolean" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscriptionId": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Datadog Organization Id.", + "type": "string" + }, + "name": { + "description": "The Datadog Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the datadog organization page", + "type": "string" + } + } + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current Datadog monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource.", + "type": "object", + "properties": { + "operation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Operation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + } + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Datadog.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Datadog REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Datadog operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Datadog provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU in {PlanId} format. For Terraform, the only allowed value is 'Linked'.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + }, + "readOnly": true + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "MarketplaceSubscriptionStatus": { + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "enum": [ + "Provisioning", + "Active", + "Suspended", + "Unsubscribed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MarketplaceSubscriptionStatus" + }, + "readOnly": true + }, + "DatadogOrganizationProperties": { + "description": "Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "id": { + "description": "Id of the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "linkingAuthCode": { + "description": "The auth code used to linking to an existing Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "linkingClientId": { + "description": "The client_id from an existing in exchange for an auth token to link organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "redirectUri": { + "description": "The redirect URI for linking.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "apiKey": { + "description": "Api key associated to the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "applicationKey": { + "description": "Application key associated to the Datadog organization.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "enterpriseAppId": { + "description": "The Id of the Enterprise App used for Single sign on.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "cspm": { + "description": "The configuration which describes the state of cloud security posture management. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks.", + "type": "boolean" + } + } + }, + "UserInfo": { + "description": "Includes name, email and optionally, phone number. User Information can't be null.", + "type": "object", + "properties": { + "name": { + "description": "Name of the user", + "maxLength": 50, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Datadog for contacting them if needed", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the user used by Datadog for contacting them if needed", + "maxLength": 40, + "type": "string" + } + }, + "x-ms-secret": true + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus" + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus" + }, + "datadogOrganizationProperties": { + "$ref": "#/definitions/DatadogOrganizationProperties" + }, + "userInfo": { + "$ref": "#/definitions/UserInfo" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "description": "Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "DatadogMonitorResource": { + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "$ref": "#/definitions/MonitorProperties" + }, + "identity": { + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DatadogMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitorUpdateProperties": { + "description": "The set of properties that can be update in a PATCH request to a monitor resource.", + "type": "object", + "properties": { + "monitoringStatus": { + "$ref": "#/definitions/MonitoringStatus" + }, + "cspm": { + "description": "The new cloud security posture management value of the monitor resource. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks.", + "type": "boolean" + } + } + }, + "DatadogMonitorResourceUpdateParameters": { + "description": "The parameters for a PATCH request to a monitor resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorUpdateProperties" + }, + "tags": { + "description": "The new tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + } + } + }, + "ResubscribeProperties": { + "description": "Resubscribe Properties", + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "azureSubscriptionId": { + "description": "Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe", + "type": "string" + }, + "resourceGroup": { + "description": "Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe", + "type": "string" + } + } + }, + "DatadogSetPasswordLink": { + "type": "object", + "properties": { + "setPasswordLink": { + "type": "string" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "$ref": "#/definitions/TagAction" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if Azure subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendResourceLogs": { + "description": "Flag specifying if Azure resource logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MetricRules": { + "description": "Set of rules for sending metrics for the Monitor resource.", + "type": "object", + "properties": { + "filteringTags": { + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "AgentRules": { + "description": "Set of rules for managing agents for the Monitor resource.", + "type": "object", + "properties": { + "enableAgentMonitoring": { + "description": "Flag specifying if agent monitoring should be enabled for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "$ref": "#/definitions/LogRules" + }, + "metricRules": { + "$ref": "#/definitions/MetricRules" + }, + "agentRules": { + "$ref": "#/definitions/AgentRules" + }, + "automuting": { + "description": "Configuration to enable/disable auto-muting flag", + "type": "boolean" + }, + "customMetrics": { + "description": "Configuration to enable/disable custom metrics. If enabled, custom metrics from app insights will be sent.", + "type": "boolean" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "SingleSignOnStates": { + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable", + "Existing" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SingleSignOnStates" + } + }, + "DatadogSingleSignOnProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates" + }, + "enterpriseAppId": { + "description": "The Id of the Enterprise App used for Single sign-on.", + "type": "string" + }, + "singleSignOnUrl": { + "description": "The login URL specific to this Datadog Organization.", + "type": "string", + "readOnly": true + } + } + }, + "DatadogSingleSignOnResource": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the configuration.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatadogSingleSignOnProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "DatadogSingleSignOnResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$", + "minLength": 2, + "maxLength": 32 + }, + "DatadogOrganizationId": { + "in": "query", + "name": "datadogOrganizationId", + "description": "Datadog Organization Id", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_GetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_GetDefaultKey.json new file mode 100644 index 000000000000..be4fd8758314 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_GetDefaultKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "createdBy": "john@example.com", + "name": "", + "key": "1111111111111111aaaaaaaaaaaaaaaa", + "created": "2019-04-05 09:20:30" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_List.json new file mode 100644 index 000000000000..c60e56426d7a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "createdBy": "john@example.com", + "name": "", + "key": "1111111111111111aaaaaaaaaaaaaaaa", + "created": "2019-04-05 09:20:30" + }, + { + "createdBy": "jane@example.com", + "name": "", + "key": "2111111111111111aaaaaaaaaaaaaaaa", + "created": "2019-04-05 09:19:53" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_SetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_SetDefaultKey.json new file mode 100644 index 000000000000..557524ffe86f --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/ApiKeys_SetDefaultKey.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "key": "1111111111111111aaaaaaaaaaaaaaaa" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/BillingInfo_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..2859ef0fb158 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/BillingInfo_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceName": "MP_RESOURCE", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "datadogOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/CreationSupported_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/CreationSupported_Get.json new file mode 100644 index 000000000000..41cf624ecf76 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/CreationSupported_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "datadogOrganizationId": "00000000-0000-0000-0000" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/CreationSupported_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/CreationSupported_List.json new file mode 100644 index 000000000000..a73e13c1e228 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/CreationSupported_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "datadogOrganizationId": "00000000-0000-0000-0000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Hosts_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Hosts_List.json new file mode 100644 index 000000000000..7f814e37c82b --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Hosts_List.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vm1", + "aliases": [ + "vm1", + "65f2dd83-95ae-4f56-b6aa-a5dafc05f4cd" + ], + "apps": [ + "ntp", + "agent" + ], + "meta": { + "agentVersion": "7.19.2", + "installMethod": { + "tool": "install_script", + "toolVersion": "install_script", + "installerVersion": "install_script-1.0.0" + }, + "logsAgent": { + "transport": "" + } + } + }, + { + "name": "vm2", + "aliases": [ + "vm2", + "df631d9a-8178-4580-bf60-c697a5e8df4d" + ], + "apps": [ + "infra", + "agent" + ], + "meta": { + "agentVersion": "7.18.1", + "installMethod": { + "tool": "install_script", + "toolVersion": "install_script", + "installerVersion": "install_script-1.0.0" + }, + "logsAgent": { + "transport": "HTTP" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/LinkedResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/LinkedResources_List.json new file mode 100644 index 000000000000..a84d7102015c --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/LinkedResources_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor", + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MarketplaceAgreements_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MarketplaceAgreements_Create.json new file mode 100644 index 000000000000..28ada7101608 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MarketplaceAgreements_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "body": { + "properties": { + "accepted": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/default", + "name": "default", + "type": "Microsoft.Datadog/agreements", + "properties": { + "publisher": "pubid1", + "product": "offid1", + "plan": "planid1", + "licenseTextLink": "test.licenseLink1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": true + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MarketplaceAgreements_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MarketplaceAgreements_List.json new file mode 100644 index 000000000000..a8ef5d71c1e7 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MarketplaceAgreements_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id1", + "name": "planid1", + "type": "Microsoft.Datadog/agreements", + "properties": { + "publisher": "pubid1", + "product": "offid1", + "plan": "planid1", + "licenseTextLink": "test.licenseLink1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id2", + "name": "planid2", + "type": "Microsoft.Datadog/agreements", + "properties": { + "publisher": "pubid2", + "product": "offid2", + "plan": "planid2", + "licenseTextLink": "test.licenseLin2k", + "privacyPolicyLink": "test.privacyPolicyLink2", + "retrieveDatetime": "2017-08-14T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER", + "accepted": false + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..ba8ca3ca22aa --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredResources_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingMetrics": true, + "reasonForMetricsStatus": "CapturedByRules", + "sendingLogs": true, + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..97908faae59b --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "body": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..d1d31abfc8e4 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..a344a418f457 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..d39e467d4cab --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..eebbeae37af6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "body": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Create.json new file mode 100644 index 000000000000..3a203ade15d0 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Create.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "body": { + "sku": { + "name": "free_Monthly" + }, + "properties": { + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": "someAuthCode", + "linkingClientId": "00000000-0000-0000-0000-000000000000", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "cspm": false + }, + "userInfo": { + "name": "Alice", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123-456-7890" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Delete.json new file mode 100644 index 000000000000..54779bf770ab --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Get.json new file mode 100644 index 000000000000..41a119088bbe --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null, + "cspm": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_List.json new file mode 100644 index 000000000000..7e5ea2fd9b48 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null, + "cspm": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_ListByResourceGroup.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..9240593da6ef --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Update.json new file mode 100644 index 000000000000..e315d02c3a2e --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Monitors_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "body": { + "properties": { + "monitoringStatus": "Enabled" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Operations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Operations_List.json new file mode 100644 index 000000000000..836f1ef5d6bd --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-01-07" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Datadog/monitors/write", + "display": { + "provider": "Microsoft.Datadog", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Organizations_Resubscribe.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Organizations_Resubscribe.json new file mode 100644 index 000000000000..20c19dd9924d --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/Organizations_Resubscribe.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "body": { + "sku": { + "name": "planName" + }, + "azureSubscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "marketplaceSubscriptionStatus": "Active", + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "enterpriseAppId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Datadog/monitor/monitorname/resubscribe?api-version=2025-01-07" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/RefreshSetPassword_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/RefreshSetPassword_Get.json new file mode 100644 index 000000000000..a1b0fec3db4a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/RefreshSetPassword_Get.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "setPasswordLink": "https://datadoghq.com/reset_password/tokenvalue123" + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..9516cff00718 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_CreateOrUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "body": { + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": null + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": null + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_Get.json new file mode 100644 index 000000000000..ca43dba1f199 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_List.json new file mode 100644 index 000000000000..32612bf01034 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/SingleSignOnConfigurations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "singleSignOnState": "Enable", + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..e023a7c7e4c4 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "body": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "automuting": true + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_Get.json new file mode 100644 index 000000000000..25b26f86cb0b --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "automuting": true, + "customMetrics": false + } + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_List.json new file mode 100644 index 000000000000..6c51dd66de86 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-01-07/examples/TagRules_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-01-07", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Datadog/monitors/tagRules", + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendResourceLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "metricRules": { + "filteringTags": [] + }, + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + }, + "automuting": true, + "customMetrics": false + } + } + ] + } + } + } +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/datadog.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/datadog.json new file mode 100644 index 000000000000..14675f48f414 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/datadog.json @@ -0,0 +1,3164 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Datadog", + "version": "2025-06-11", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "DatadogMonitorResources" + }, + { + "name": "TagRules" + }, + { + "name": "DatadogSingleSignOnResources" + }, + { + "name": "MonitoredSubscriptions" + } + ], + "paths": { + "/providers/Microsoft.Datadog/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "summary": "List all operations provided by Microsoft.Datadog for the 2025-06-11 api version.", + "description": "List all operations provided by Microsoft.Datadog for the 2025-06-11 api version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements": { + "get": { + "operationId": "MarketplaceAgreements_List", + "summary": "List Datadog marketplace agreements in the subscription.", + "description": "List Datadog marketplace agreements in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatadogAgreementResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MarketplaceAgreements_List": { + "$ref": "./examples/MarketplaceAgreements_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/agreements/default": { + "put": { + "operationId": "MarketplaceAgreements_CreateOrUpdate", + "summary": "Create Datadog marketplace agreement in the subscription.", + "description": "Create Datadog marketplace agreement in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The request body", + "required": false, + "schema": { + "$ref": "#/definitions/DatadogAgreementResource" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DatadogAgreementResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MarketplaceAgreements_CreateOrUpdate": { + "$ref": "./examples/MarketplaceAgreements_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/monitors": { + "get": { + "operationId": "Monitors_List", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "List all monitors under the specified subscription.", + "description": "List all monitors under the specified subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/subscriptionStatuses": { + "get": { + "operationId": "CreationSupported_List", + "summary": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "description": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "datadogOrganizationId", + "in": "query", + "description": "Datadog Organization Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CreateResourceSupportedResponseList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreationSupported_List": { + "$ref": "./examples/CreationSupported_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/subscriptionStatuses/default": { + "get": { + "operationId": "CreationSupported_Get", + "summary": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "description": "Informs if the current subscription is being already monitored for selected Datadog organization.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "datadogOrganizationId", + "in": "query", + "description": "Datadog Organization Id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CreateResourceSupportedResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CreationSupported_Get": { + "$ref": "./examples/CreationSupported_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors": { + "get": { + "operationId": "Monitors_ListByResourceGroup", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "List all monitors under the specified resource group.", + "description": "List all monitors under the specified resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}": { + "get": { + "operationId": "Monitors_Get", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Get the properties of a specific monitor resource.", + "description": "Get the properties of a specific monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "operationId": "Monitors_Create", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Create a monitor resource.", + "description": "Create a monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DatadogMonitorResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "201": { + "description": "Resource 'DatadogMonitorResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/DatadogMonitorResource" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Monitors_Update", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Update a monitor resource.", + "description": "Update a monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/DatadogMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "201": { + "description": "Resource 'DatadogMonitorResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + }, + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/DatadogMonitorResource" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Monitors_Delete", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Delete a monitor resource.", + "description": "Delete a monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getBillingInfo": { + "post": { + "operationId": "BillingInfo_Get", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "description": "Get marketplace and organization info mapped to the given monitor.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/getDefaultKey": { + "post": { + "operationId": "Monitors_GetDefaultKey", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Get the default api key.", + "description": "Get the default api key.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogApiKey" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetDefaultKey": { + "$ref": "./examples/ApiKeys_GetDefaultKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listApiKeys": { + "post": { + "operationId": "Monitors_ListApiKeys", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "List the api keys for a given monitor resource.", + "description": "List the api keys for a given monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogApiKeyListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_ListApiKeys": { + "$ref": "./examples/ApiKeys_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listHosts": { + "post": { + "operationId": "Monitors_ListHosts", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "List the hosts for a given monitor resource.", + "description": "List the hosts for a given monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogHostListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_ListHosts": { + "$ref": "./examples/Hosts_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listLinkedResources": { + "post": { + "operationId": "Monitors_ListLinkedResources", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "List all Azure resources associated to the same Datadog organization as the target resource.", + "description": "List all Azure resources associated to the same Datadog organization as the target resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LinkedResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/listMonitoredResources": { + "post": { + "operationId": "Monitors_ListMonitoredResources", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "List the resources currently being monitored by the Datadog monitor resource.", + "description": "List the resources currently being monitored by the Datadog monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_ListMonitoredResources": { + "$ref": "./examples/MonitoredResources_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "operationId": "MonitoredSubscriptions_List", + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "description": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "operationId": "MonitoredSubscriptions_Get", + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "description": "List the subscriptions currently being monitored by the Datadog monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "configurationName", + "in": "path", + "description": "The configuration name. Only 'default' value is supported.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the Datadog monitor resource.", + "description": "Add the subscriptions that should be monitored by the Datadog monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "configurationName", + "in": "path", + "description": "The configuration name. Only 'default' value is supported.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MonitoredSubscriptionProperties' update operation succeeded", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Resource 'MonitoredSubscriptionProperties' create operation succeeded", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + }, + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/MonitoredSubscriptionProperties" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MonitoredSubscriptions_Update", + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "description": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "configurationName", + "in": "path", + "description": "The configuration name. Only 'default' value is supported.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/MonitoredSubscriptionProperties" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MonitoredSubscriptions_Delete", + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "description": "Updates the subscriptions that are being monitored by the Datadog monitor resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "configurationName", + "in": "path", + "description": "The configuration name. Only 'default' value is supported.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/refreshSetPasswordLink": { + "post": { + "operationId": "Monitors_RefreshSetPasswordLink", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Refresh the set password link and return a latest one.", + "description": "Refresh the set password link and return a latest one.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogSetPasswordLink" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_RefreshSetPasswordLink": { + "$ref": "./examples/RefreshSetPassword_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/resubscribe": { + "post": { + "operationId": "Organizations_Resubscribe", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Reinstate integration with your Datadog organization by choosing one of the available subscription plans.", + "description": "Reinstate integration with your Datadog organization by choosing one of the available subscription plans.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "body", + "in": "body", + "description": "Resubscribe Properties", + "required": false, + "schema": { + "$ref": "#/definitions/ResubscribeProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_Resubscribe": { + "$ref": "./examples/Organizations_Resubscribe.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/DatadogMonitorResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/setDefaultKey": { + "post": { + "operationId": "Monitors_SetDefaultKey", + "tags": [ + "DatadogMonitorResources" + ], + "summary": "Set the default api key.", + "description": "Set the default api key.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/DatadogApiKey" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_SetDefaultKey": { + "$ref": "./examples/ApiKeys_SetDefaultKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations": { + "get": { + "operationId": "SingleSignOnConfigurations_List", + "tags": [ + "DatadogSingleSignOnResources" + ], + "summary": "List the single sign-on configurations for a given monitor resource.", + "description": "List the single sign-on configurations for a given monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResourceListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SingleSignOnConfigurations_List": { + "$ref": "./examples/SingleSignOnConfigurations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/singleSignOnConfigurations/{configurationName}": { + "get": { + "operationId": "SingleSignOnConfigurations_Get", + "tags": [ + "DatadogSingleSignOnResources" + ], + "summary": "Gets the datadog single sign-on resource for the given Monitor.", + "description": "Gets the datadog single sign-on resource for the given Monitor.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "configurationName", + "in": "path", + "description": "Configuration name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SingleSignOnConfigurations_Get": { + "$ref": "./examples/SingleSignOnConfigurations_Get.json" + } + } + }, + "put": { + "operationId": "SingleSignOnConfigurations_CreateOrUpdate", + "tags": [ + "DatadogSingleSignOnResources" + ], + "summary": "Configures single-sign-on for this resource.", + "description": "Configures single-sign-on for this resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "configurationName", + "in": "path", + "description": "Configuration name", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DatadogSingleSignOnResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "201": { + "description": "Resource 'DatadogSingleSignOnResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SingleSignOnConfigurations_CreateOrUpdate": { + "$ref": "./examples/SingleSignOnConfigurations_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/DatadogSingleSignOnResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules": { + "get": { + "operationId": "TagRules_List", + "tags": [ + "TagRules" + ], + "summary": "List the tag rules for a given monitor resource.", + "description": "List the tag rules for a given monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules/{ruleSetName}": { + "get": { + "operationId": "TagRules_Get", + "tags": [ + "TagRules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "description": "Get a tag rule set for a given monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Rule set name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + }, + "put": { + "operationId": "TagRules_CreateOrUpdate", + "tags": [ + "TagRules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "description": "Create or update a tag rule set for a given monitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Monitor resource name", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 32, + "pattern": "^[a-zA-Z0-9_][a-zA-Z0-9_-]+$" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Rule set name", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MonitoringTagRules' update operation succeeded", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + } + } + }, + "definitions": { + "AgentRules": { + "type": "object", + "description": "Set of rules for managing agents for the Monitor resource.", + "properties": { + "enableAgentMonitoring": { + "type": "boolean", + "description": "Flag specifying if agent monitoring should be enabled for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "BillingInfoResponse": { + "type": "object", + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "properties": { + "marketplaceSaasInfo": { + "$ref": "#/definitions/MarketplaceSaaSInfo", + "description": "Marketplace Subscription details" + }, + "partnerBillingEntity": { + "$ref": "#/definitions/PartnerBillingEntity", + "description": "Partner Billing Entity details: Organization Info" + } + } + }, + "CreateResourceSupportedProperties": { + "type": "object", + "description": "Datadog resource can be created or not properties.", + "properties": { + "name": { + "type": "string", + "description": "The ARM id of the subscription.", + "readOnly": true + }, + "creationSupported": { + "type": "boolean", + "description": "Indicates if selected subscription supports Datadog resource creation, if not it is already being monitored for the selected organization via multi subscription feature.", + "readOnly": true + } + } + }, + "CreateResourceSupportedResponse": { + "type": "object", + "description": "Datadog resource can be created or not.", + "properties": { + "properties": { + "$ref": "#/definitions/CreateResourceSupportedProperties", + "description": "Represents the properties of the resource." + } + } + }, + "CreateResourceSupportedResponseList": { + "type": "object", + "description": "Paged collection of CreateResourceSupportedResponse items", + "properties": { + "value": { + "type": "array", + "description": "The CreateResourceSupportedResponse items on this page", + "items": { + "$ref": "#/definitions/CreateResourceSupportedResponse" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatadogAgreementProperties": { + "type": "object", + "description": "Terms properties.", + "properties": { + "publisher": { + "type": "string", + "description": "Publisher identifier string." + }, + "product": { + "type": "string", + "description": "Product identifier string." + }, + "plan": { + "type": "string", + "description": "Plan identifier string." + }, + "licenseTextLink": { + "type": "string", + "description": "Link to HTML with Microsoft and Publisher terms." + }, + "privacyPolicyLink": { + "type": "string", + "description": "Link to the privacy policy of the publisher." + }, + "retrieveDatetime": { + "type": "string", + "format": "date-time", + "description": "Date and time in UTC of when the terms were accepted. This is empty if Accepted is false." + }, + "signature": { + "type": "string", + "description": "Terms signature." + }, + "accepted": { + "type": "boolean", + "description": "If any version of the terms have been accepted, otherwise false." + } + } + }, + "DatadogAgreementResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ARM id of the resource.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the agreement.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/DatadogAgreementProperties", + "description": "Represents the properties of the resource." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + } + }, + "DatadogAgreementResourceListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DatadogAgreementResource items on this page", + "items": { + "$ref": "#/definitions/DatadogAgreementResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatadogApiKey": { + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "The user that created the API key." + }, + "name": { + "type": "string", + "description": "The name of the API key." + }, + "key": { + "type": "string", + "description": "The value of the API key." + }, + "created": { + "type": "string", + "description": "The time of creation of the API key." + } + }, + "required": [ + "key" + ] + }, + "DatadogApiKeyListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DatadogApiKey items on this page", + "items": { + "$ref": "#/definitions/DatadogApiKey" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatadogHost": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the host." + }, + "aliases": { + "type": "array", + "description": "The aliases for the host installed via the Datadog agent.", + "items": { + "type": "string" + } + }, + "apps": { + "type": "array", + "description": "The Datadog integrations reporting metrics for the host.", + "items": { + "type": "string" + } + }, + "meta": { + "$ref": "#/definitions/DatadogHostMetadata" + } + } + }, + "DatadogHostListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DatadogHost items on this page", + "items": { + "$ref": "#/definitions/DatadogHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatadogHostMetadata": { + "type": "object", + "properties": { + "agentVersion": { + "type": "string", + "description": "The agent version." + }, + "installMethod": { + "$ref": "#/definitions/DatadogInstallMethod" + }, + "logsAgent": { + "$ref": "#/definitions/DatadogLogsAgent" + } + } + }, + "DatadogInstallMethod": { + "type": "object", + "properties": { + "tool": { + "type": "string", + "description": "The tool." + }, + "toolVersion": { + "type": "string", + "description": "The tool version." + }, + "installerVersion": { + "type": "string", + "description": "The installer version." + } + } + }, + "DatadogLogsAgent": { + "type": "object", + "properties": { + "transport": { + "type": "string", + "description": "The transport." + } + } + }, + "DatadogMonitorResource": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorProperties", + "description": "Properties specific to the monitor resource." + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "identity": { + "$ref": "#/definitions/IdentityProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "DatadogMonitorResourceListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DatadogMonitorResource items on this page", + "items": { + "$ref": "#/definitions/DatadogMonitorResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatadogMonitorResourceUpdateParameters": { + "type": "object", + "description": "The parameters for a PATCH request to a monitor resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MonitorUpdateProperties", + "description": "The set of properties that can be update in a PATCH request to a monitor resource." + }, + "tags": { + "type": "object", + "description": "The new tags of the monitor resource.", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + } + } + }, + "DatadogOrganizationProperties": { + "type": "object", + "description": "Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.", + "properties": { + "name": { + "type": "string", + "description": "Name of the Datadog organization.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "description": "Id of the Datadog organization.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "linkingAuthCode": { + "type": "string", + "format": "password", + "description": "The auth code used to linking to an existing Datadog organization.", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "linkingClientId": { + "type": "string", + "format": "password", + "description": "The client_id from an existing in exchange for an auth token to link organization.", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "redirectUri": { + "type": "string", + "description": "The redirect URI for linking.", + "x-ms-mutability": [ + "create" + ] + }, + "apiKey": { + "type": "string", + "format": "password", + "description": "Api key associated to the Datadog organization.", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "applicationKey": { + "type": "string", + "format": "password", + "description": "Application key associated to the Datadog organization.", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "enterpriseAppId": { + "type": "string", + "description": "The Id of the Enterprise App used for Single sign on.", + "x-ms-mutability": [ + "create" + ] + }, + "cspm": { + "type": "boolean", + "description": "The configuration which describes the state of cloud security posture management. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks." + }, + "resourceCollection": { + "type": "boolean", + "description": "The configuration which describes the state of resource collection. This collects configuration information for all resources in a subscription." + } + } + }, + "DatadogSetPasswordLink": { + "type": "object", + "properties": { + "setPasswordLink": { + "type": "string" + } + } + }, + "DatadogSingleSignOnProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "singleSignOnState": { + "$ref": "#/definitions/SingleSignOnStates", + "description": "Various states of the SSO resource" + }, + "enterpriseAppId": { + "type": "string", + "description": "The Id of the Enterprise App used for Single sign-on." + }, + "singleSignOnUrl": { + "type": "string", + "description": "The login URL specific to this Datadog Organization.", + "readOnly": true + } + } + }, + "DatadogSingleSignOnResource": { + "type": "object", + "description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/DatadogSingleSignOnProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DatadogSingleSignOnResourceListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DatadogSingleSignOnResource items on this page", + "items": { + "$ref": "#/definitions/DatadogSingleSignOnResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FilteringTag": { + "type": "object", + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "properties": { + "name": { + "type": "string", + "description": "The name (also known as the key) of the tag." + }, + "value": { + "type": "string", + "description": "The value of the tag." + }, + "action": { + "$ref": "#/definitions/TagAction", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion." + } + } + }, + "IdentityProperties": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The identity ID.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of resource.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/ManagedIdentityTypes", + "description": "Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'." + } + } + }, + "LiftrResourceCategories": { + "type": "string", + "enum": [ + "Unknown", + "MonitorLogs" + ], + "x-ms-enum": { + "name": "LiftrResourceCategories", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "MonitorLogs", + "value": "MonitorLogs" + } + ] + } + }, + "LinkedResource": { + "type": "object", + "description": "The definition of a linked resource.", + "properties": { + "id": { + "type": "string", + "description": "The ARM id of the linked resource." + }, + "location": { + "type": "string", + "description": "The location of the linked resource." + } + } + }, + "LinkedResourceListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LinkedResource items on this page", + "items": { + "$ref": "#/definitions/LinkedResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogRules": { + "type": "object", + "description": "Set of rules for sending logs for the Monitor resource.", + "properties": { + "sendAadLogs": { + "type": "boolean", + "description": "Flag specifying if AAD logs should be sent for the Monitor resource." + }, + "sendSubscriptionLogs": { + "type": "boolean", + "description": "Flag specifying if Azure subscription logs should be sent for the Monitor resource." + }, + "sendResourceLogs": { + "type": "boolean", + "description": "Flag specifying if Azure resource logs should be sent for the Monitor resource." + }, + "filteringTags": { + "type": "array", + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "ManagedIdentityTypes": { + "type": "string", + "description": "Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityTypes", + "modelAsString": true, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned" + }, + { + "name": "UserAssigned", + "value": "UserAssigned" + } + ] + } + }, + "MarketplaceSaaSInfo": { + "type": "object", + "description": "Marketplace SAAS Info of the resource.", + "properties": { + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id. This is a GUID-formatted string." + }, + "marketplaceName": { + "type": "string", + "description": "Marketplace Subscription Details: SAAS Name" + }, + "marketplaceStatus": { + "type": "string", + "description": "Marketplace Subscription Details: SaaS Subscription Status" + }, + "billedAzureSubscriptionId": { + "type": "string", + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into." + }, + "subscribed": { + "type": "boolean", + "description": "Flag specifying if the Marketplace status is subscribed or not." + } + } + }, + "MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "enum": [ + "Provisioning", + "Active", + "Suspended", + "Unsubscribed" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "Provisioning", + "value": "Provisioning" + }, + { + "name": "Active", + "value": "Active" + }, + { + "name": "Suspended", + "value": "Suspended" + }, + { + "name": "Unsubscribed", + "value": "Unsubscribed" + } + ] + } + }, + "MetricRules": { + "type": "object", + "description": "Set of rules for sending metrics for the Monitor resource.", + "properties": { + "filteringTags": { + "type": "array", + "description": "List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitorProperties": { + "type": "object", + "description": "Properties specific to the monitor resource.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "monitoringStatus": { + "type": "string", + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] + } + }, + "marketplaceSubscriptionStatus": { + "$ref": "#/definitions/MarketplaceSubscriptionStatus", + "description": "Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.", + "readOnly": true + }, + "datadogOrganizationProperties": { + "$ref": "#/definitions/DatadogOrganizationProperties", + "description": "Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well." + }, + "userInfo": { + "$ref": "#/definitions/UserInfo", + "description": "Includes name, email and optionally, phone number. User Information can't be null." + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories", + "readOnly": true + }, + "liftrResourcePreference": { + "type": "integer", + "format": "int32", + "description": "The priority of the resource.", + "readOnly": true + } + } + }, + "MonitorUpdateProperties": { + "type": "object", + "description": "The set of properties that can be update in a PATCH request to a monitor resource.", + "properties": { + "monitoringStatus": { + "type": "string", + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] + } + }, + "cspm": { + "type": "boolean", + "description": "The new cloud security posture management value of the monitor resource. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks." + }, + "resourceCollection": { + "type": "boolean", + "description": "The new resource collection value of the monitor resource. This collects configuration information for all resources in a subscription." + } + } + }, + "MonitoredResource": { + "type": "object", + "description": "The properties of a resource currently being monitored by the Datadog monitor resource.", + "properties": { + "id": { + "type": "string", + "description": "The ARM id of the resource." + }, + "sendingMetrics": { + "type": "boolean", + "description": "Flag indicating if resource is sending metrics to Datadog." + }, + "reasonForMetricsStatus": { + "type": "string", + "description": "Reason for why the resource is sending metrics (or why it is not sending)." + }, + "sendingLogs": { + "type": "boolean", + "description": "Flag indicating if resource is sending logs to Datadog." + }, + "reasonForLogsStatus": { + "type": "string", + "description": "Reason for why the resource is sending logs (or why it is not sending)." + } + } + }, + "MonitoredResourceListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MonitoredResource items on this page", + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MonitoredSubscription": { + "type": "object", + "description": "The list of subscriptions and it's monitoring status by current Datadog monitor.", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscriptionId to be monitored." + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The state of monitoring." + }, + "error": { + "type": "string", + "description": "The reason of not monitoring the subscription." + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "Definition of the properties for a TagRules resource." + } + } + }, + "MonitoredSubscriptionProperties": { + "type": "object", + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SubscriptionList", + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "description": "Paged collection of MonitoredSubscriptionProperties items", + "properties": { + "value": { + "type": "array", + "description": "The MonitoredSubscriptionProperties items on this page", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MonitoringTagRules": { + "type": "object", + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "properties": { + "properties": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "Definition of the properties for a TagRules resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "MonitoringTagRulesListResponse": { + "type": "object", + "description": "Response of a list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MonitoringTagRules items on this page", + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MonitoringTagRulesProperties": { + "type": "object", + "description": "Definition of the properties for a TagRules resource.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "logRules": { + "$ref": "#/definitions/LogRules", + "description": "Set of rules for sending logs for the Monitor resource." + }, + "metricRules": { + "$ref": "#/definitions/MetricRules", + "description": "Set of rules for sending metrics for the Monitor resource." + }, + "agentRules": { + "$ref": "#/definitions/AgentRules", + "description": "Set of rules for managing agents for the Monitor resource." + }, + "automuting": { + "type": "boolean", + "description": "Configuration to enable/disable auto-muting flag" + }, + "customMetrics": { + "type": "boolean", + "description": "Configuration to enable/disable custom metrics. If enabled, custom metrics from app insights will be sent." + } + } + }, + "Operation": { + "type": "string", + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "x-ms-enum": { + "name": "Operation", + "modelAsString": true, + "values": [ + { + "name": "AddBegin", + "value": "AddBegin" + }, + { + "name": "AddComplete", + "value": "AddComplete" + }, + { + "name": "DeleteBegin", + "value": "DeleteBegin" + }, + { + "name": "DeleteComplete", + "value": "DeleteComplete" + }, + { + "name": "Active", + "value": "Active" + } + ] + } + }, + "OperationDisplay": { + "type": "object", + "description": "The object that represents the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Service provider, i.e., Microsoft.Datadog." + }, + "resource": { + "type": "string", + "description": "Type on which the operation is performed, e.g., 'monitors'." + }, + "operation": { + "type": "string", + "description": "Operation type, e.g., read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation, e.g., 'Write monitors'." + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Represents a paginated list of operation results.", + "properties": { + "value": { + "type": "array", + "description": "The list of operations.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results, if any." + } + }, + "required": [ + "value" + ] + }, + "OperationResult": { + "type": "object", + "description": "A Microsoft.Datadog REST API operation.", + "properties": { + "name": { + "type": "string", + "description": "Operation name, i.e., {provider}/{resource}/{operation}." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that represents the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + } + } + }, + "PartnerBillingEntity": { + "type": "object", + "description": "Partner Billing details associated with the resource.", + "properties": { + "id": { + "type": "string", + "description": "The Datadog Organization Id." + }, + "name": { + "type": "string", + "description": "The Datadog Organization Name." + }, + "partnerEntityUri": { + "type": "string", + "description": "Link to the datadog organization page" + } + } + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted" + }, + { + "name": "Creating", + "value": "Creating" + }, + { + "name": "Updating", + "value": "Updating" + }, + { + "name": "Deleting", + "value": "Deleting" + }, + { + "name": "Succeeded", + "value": "Succeeded" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Canceled", + "value": "Canceled" + }, + { + "name": "Deleted", + "value": "Deleted" + }, + { + "name": "NotSpecified", + "value": "NotSpecified" + } + ] + } + }, + "ResourceSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the SKU in {PlanId} format. For Terraform, the only allowed value is 'Linked'." + } + }, + "required": [ + "name" + ] + }, + "ResubscribeProperties": { + "type": "object", + "description": "Resubscribe Properties", + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "azureSubscriptionId": { + "type": "string", + "description": "Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe" + }, + "resourceGroup": { + "type": "string", + "description": "Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe" + } + } + }, + "SingleSignOnStates": { + "type": "string", + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable", + "Existing" + ], + "x-ms-enum": { + "name": "SingleSignOnStates", + "modelAsString": true, + "values": [ + { + "name": "Initial", + "value": "Initial" + }, + { + "name": "Enable", + "value": "Enable" + }, + { + "name": "Disable", + "value": "Disable" + }, + { + "name": "Existing", + "value": "Existing" + } + ] + } + }, + "Status": { + "type": "string", + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "InProgress", + "value": "InProgress" + }, + { + "name": "Active", + "value": "Active" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Deleting", + "value": "Deleting" + } + ] + } + }, + "SubscriptionList": { + "type": "object", + "description": "The request to update subscriptions needed to be monitored by the Datadog monitor resource.", + "properties": { + "operation": { + "$ref": "#/definitions/Operation", + "description": "The operation for the patch on the resource.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "monitoredSubscriptionList": { + "type": "array", + "description": "List of subscriptions and the state of the monitoring.", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [] + } + } + }, + "TagAction": { + "type": "string", + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "x-ms-enum": { + "name": "TagAction", + "modelAsString": true, + "values": [ + { + "name": "Include", + "value": "Include" + }, + { + "name": "Exclude", + "value": "Exclude" + } + ] + } + }, + "UserInfo": { + "type": "object", + "description": "Includes name, email and optionally, phone number. User Information can't be null.", + "properties": { + "name": { + "type": "string", + "description": "Name of the user", + "maxLength": 50 + }, + "emailAddress": { + "type": "string", + "description": "Email of the user used by Datadog for contacting them if needed", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + }, + "phoneNumber": { + "type": "string", + "description": "Phone number of the user used by Datadog for contacting them if needed", + "maxLength": 40 + } + } + } + }, + "parameters": {} +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_GetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_GetDefaultKey.json new file mode 100644 index 000000000000..bd520614bdea --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_GetDefaultKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "", + "created": "2019-04-05 09:20:30", + "createdBy": "john@example.com", + "key": "1111111111111111aaaaaaaaaaaaaaaa" + } + } + }, + "operationId": "Monitors_GetDefaultKey", + "title": "Monitors_GetDefaultKey" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_List.json new file mode 100644 index 000000000000..a0a0978af0c2 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "", + "created": "2019-04-05 09:20:30", + "createdBy": "john@example.com", + "key": "1111111111111111aaaaaaaaaaaaaaaa" + }, + { + "name": "", + "created": "2019-04-05 09:19:53", + "createdBy": "jane@example.com", + "key": "2111111111111111aaaaaaaaaaaaaaaa" + } + ] + } + } + }, + "operationId": "Monitors_ListApiKeys", + "title": "Monitors_ListApiKeys" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_SetDefaultKey.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_SetDefaultKey.json new file mode 100644 index 000000000000..99e5a5edbc9f --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/ApiKeys_SetDefaultKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "requestBody": { + "key": "1111111111111111aaaaaaaaaaaaaaaa" + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + }, + "operationId": "Monitors_SetDefaultKey", + "title": "Monitors_SetDefaultKey" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/BillingInfo_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..a999fdfffe64 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/BillingInfo_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceName": "MP_RESOURCE", + "marketplaceStatus": "Status", + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "subscribed": true + }, + "partnerBillingEntity": { + "name": "datadogOrganizationName", + "id": "1234567890", + "partnerEntityUri": "https://example.com" + } + } + } + }, + "operationId": "BillingInfo_Get", + "title": "BillingInfo_Get" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/CreationSupported_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/CreationSupported_Get.json new file mode 100644 index 000000000000..0a1d5267ecff --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/CreationSupported_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "datadogOrganizationId": "00000000-0000-0000-0000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + } + }, + "operationId": "CreationSupported_Get", + "title": "CreationSupported_Get" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/CreationSupported_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/CreationSupported_List.json new file mode 100644 index 000000000000..898e8257763d --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/CreationSupported_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "datadogOrganizationId": "00000000-0000-0000-0000", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "properties": { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000", + "creationSupported": true + } + } + ] + } + } + }, + "operationId": "CreationSupported_List", + "title": "CreationSupported_List" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Hosts_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Hosts_List.json new file mode 100644 index 000000000000..698e8eeb0a7f --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Hosts_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "vm1", + "aliases": [ + "vm1", + "65f2dd83-95ae-4f56-b6aa-a5dafc05f4cd" + ], + "apps": [ + "ntp", + "agent" + ], + "meta": { + "agentVersion": "7.19.2", + "installMethod": { + "installerVersion": "install_script-1.0.0", + "tool": "install_script", + "toolVersion": "install_script" + }, + "logsAgent": { + "transport": "" + } + } + }, + { + "name": "vm2", + "aliases": [ + "vm2", + "df631d9a-8178-4580-bf60-c697a5e8df4d" + ], + "apps": [ + "infra", + "agent" + ], + "meta": { + "agentVersion": "7.18.1", + "installMethod": { + "installerVersion": "install_script-1.0.0", + "tool": "install_script", + "toolVersion": "install_script" + }, + "logsAgent": { + "transport": "HTTP" + } + } + } + ] + } + } + }, + "operationId": "Monitors_ListHosts", + "title": "Monitors_ListHosts" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/LinkedResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/LinkedResources_List.json new file mode 100644 index 000000000000..27c57f7379a6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/LinkedResources_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor", + "location": "West US 2" + } + ] + } + } + }, + "operationId": "Monitors_ListLinkedResources", + "title": "Monitors_ListLinkedResources" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MarketplaceAgreements_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MarketplaceAgreements_Create.json new file mode 100644 index 000000000000..6dafca2fca22 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MarketplaceAgreements_Create.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "accepted": true + } + }, + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/agreements", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/default", + "properties": { + "accepted": true, + "licenseTextLink": "test.licenseLink1", + "plan": "planid1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "product": "offid1", + "publisher": "pubid1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER" + } + } + } + }, + "operationId": "MarketplaceAgreements_CreateOrUpdate", + "title": "MarketplaceAgreements_CreateOrUpdate" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MarketplaceAgreements_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MarketplaceAgreements_List.json new file mode 100644 index 000000000000..b2aee94ed4f6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MarketplaceAgreements_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "planid1", + "type": "Microsoft.Datadog/agreements", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id1", + "properties": { + "accepted": false, + "licenseTextLink": "test.licenseLink1", + "plan": "planid1", + "privacyPolicyLink": "test.privacyPolicyLink1", + "product": "offid1", + "publisher": "pubid1", + "retrieveDatetime": "2017-08-15T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER" + } + }, + { + "name": "planid2", + "type": "Microsoft.Datadog/agreements", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/agreements/id2", + "properties": { + "accepted": false, + "licenseTextLink": "test.licenseLin2k", + "plan": "planid2", + "privacyPolicyLink": "test.privacyPolicyLink2", + "product": "offid2", + "publisher": "pubid2", + "retrieveDatetime": "2017-08-14T11:33:07.12132Z", + "signature": "ASDFSDAFWEFASDGWERLWER" + } + } + ] + } + } + }, + "operationId": "MarketplaceAgreements_List", + "title": "MarketplaceAgreements_List" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredResources_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..2633a1d0c880 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredResources_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "reasonForLogsStatus": "CapturedByRules", + "reasonForMetricsStatus": "CapturedByRules", + "sendingLogs": true, + "sendingMetrics": true + } + ] + } + } + }, + "operationId": "Monitors_ListMonitoredResources", + "title": "Monitors_ListMonitoredResources" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..adb223b6ddb9 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ], + "operation": "AddBegin" + } + }, + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + }, + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "title": "Monitors_AddMonitoredSubscriptions" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..f723577388f9 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + }, + "operationId": "MonitoredSubscriptions_Delete", + "title": "Monitors_DeleteMonitoredSubscriptions" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..19934f9363aa --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + } + }, + "operationId": "MonitoredSubscriptions_Get", + "title": "Monitors_GetMonitoredSubscriptions" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..a44da644a864 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + ] + } + } + }, + "operationId": "MonitoredSubscriptions_List", + "title": "Monitors_GetMonitoredSubscriptions" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..88b0938b26f6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ], + "operation": "AddComplete" + } + }, + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + } + }, + "operationId": "MonitoredSubscriptions_Update", + "title": "Monitors_UpdateMonitoredSubscriptions" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Create.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Create.json new file mode 100644 index 000000000000..0f6983983b61 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Create.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "cspm": false, + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "id": "myOrg123", + "linkingAuthCode": "someAuthCode", + "linkingClientId": "00000000-0000-0000-0000-000000000000", + "resourceCollection": false + }, + "monitoringStatus": "Enabled", + "userInfo": { + "name": "Alice", + "emailAddress": "alice@microsoft.com", + "phoneNumber": "123-456-7890" + } + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "201": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Accepted" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + } + }, + "operationId": "Monitors_Create", + "title": "Monitors_Create" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Delete.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Delete.json new file mode 100644 index 000000000000..8bcb433bd1d5 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Datadog/monitors/test?api-version=2022-09-01" + } + }, + "204": {} + }, + "operationId": "Monitors_Delete", + "title": "Monitors_Delete" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Get.json new file mode 100644 index 000000000000..b62a13d9fff6 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "cspm": false, + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "resourceCollection": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "tags": { + "Environment": "Dev" + } + } + } + }, + "operationId": "Monitors_Get", + "title": "Monitors_Get" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_List.json new file mode 100644 index 000000000000..51cd03bb2bda --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "cspm": false, + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null, + "resourceCollection": false + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "tags": { + "Environment": "Dev" + } + } + ] + } + } + }, + "operationId": "Monitors_List", + "title": "Monitors_List" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_ListByResourceGroup.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..7f9235a7fa3e --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "tags": { + "Environment": "Dev" + } + } + ] + } + } + }, + "operationId": "Monitors_ListByResourceGroup", + "title": "Monitors_ListByResourceGroup" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Update.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Update.json new file mode 100644 index 000000000000..cce799fc0fb7 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Monitors_Update.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "monitoringStatus": "Enabled" + }, + "tags": { + "Environment": "Dev" + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "201": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "id": "myOrg123" + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "monitoringStatus": "Enabled", + "provisioningState": "Accepted" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + } + }, + "operationId": "Monitors_Update", + "title": "Monitors_Update" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Operations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Operations_List.json new file mode 100644 index 000000000000..8eec7bc9849a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-06-11" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "Microsoft.Datadog/monitors/write", + "display": { + "description": "Write monitors resource", + "operation": "write", + "provider": "Microsoft.Datadog", + "resource": "monitors" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "Operations_List" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Organizations_Resubscribe.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Organizations_Resubscribe.json new file mode 100644 index 000000000000..f0f52ff6d5f2 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/Organizations_Resubscribe.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "azureSubscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup", + "sku": { + "name": "planName" + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myMonitor", + "type": "Microsoft.Datadog/monitors", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US", + "properties": { + "datadogOrganizationProperties": { + "name": "myOrg", + "enterpriseAppId": null, + "id": "myOrg123", + "linkingAuthCode": null, + "linkingClientId": null + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 1, + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "provisioningState": "Succeeded" + }, + "sku": { + "name": "free_Monthly" + }, + "tags": { + "Environment": "Dev" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Datadog/monitor/monitorname/resubscribe?api-version=2025-06-11" + } + } + }, + "operationId": "Organizations_Resubscribe", + "title": "Organizations_Resubscribe" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/RefreshSetPassword_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/RefreshSetPassword_Get.json new file mode 100644 index 000000000000..27e8ff152b56 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/RefreshSetPassword_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "setPasswordLink": "https://datadoghq.com/reset_password/tokenvalue123" + } + } + }, + "operationId": "Monitors_RefreshSetPasswordLink", + "title": "Monitors_RefreshSetPasswordLink" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..c3b4f7a34a28 --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_CreateOrUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable" + } + }, + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": null + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": null + } + } + } + }, + "operationId": "SingleSignOnConfigurations_CreateOrUpdate", + "title": "SingleSignOnConfigurations_CreateOrUpdate" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_Get.json new file mode 100644 index 000000000000..3691d1da796f --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + } + }, + "operationId": "SingleSignOnConfigurations_Get", + "title": "SingleSignOnConfigurations_Get" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_List.json new file mode 100644 index 000000000000..8d422b7adc7c --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/SingleSignOnConfigurations_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/singleSignOnConfigurations/default", + "properties": { + "enterpriseAppId": "00000000-0000-0000-0000-000000000000", + "singleSignOnState": "Enable", + "singleSignOnUrl": "https://www.datadoghq.com/IAmSomeHash" + } + } + ] + } + } + }, + "operationId": "SingleSignOnConfigurations_List", + "title": "SingleSignOnConfigurations_List" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_CreateOrUpdate.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..749477e4f95b --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "body": { + "properties": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "ruleSetName": "default", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/tagRules", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "properties": { + "automuting": true, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + } + }, + "operationId": "TagRules_CreateOrUpdate", + "title": "TagRules_CreateOrUpdate" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_Get.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_Get.json new file mode 100644 index 000000000000..1ad806c132bf --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "ruleSetName": "default", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.Datadog/monitors/tagRules", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "properties": { + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ] + }, + "automuting": true, + "customMetrics": false, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + } + }, + "operationId": "TagRules_Get", + "title": "TagRules_Get" +} diff --git a/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_List.json b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_List.json new file mode 100644 index 000000000000..58e3b2f3a23a --- /dev/null +++ b/specification/datadog/resource-manager/Microsoft.Datadog/stable/2025-06-11/examples/TagRules_List.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-06-11", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.Datadog/monitors/tagRules", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor/tagRules/default", + "properties": { + "agentRules": { + "enableAgentMonitoring": true, + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ] + }, + "automuting": true, + "customMetrics": false, + "logRules": { + "filteringTags": [ + { + "name": "Environment", + "action": "Include", + "value": "Prod" + }, + { + "name": "Environment", + "action": "Exclude", + "value": "Dev" + } + ], + "sendAadLogs": false, + "sendResourceLogs": true, + "sendSubscriptionLogs": true + }, + "metricRules": { + "filteringTags": [] + } + } + } + ] + } + } + }, + "operationId": "TagRules_List", + "title": "TagRules_List" +} diff --git a/specification/datadog/resource-manager/readme.go.md b/specification/datadog/resource-manager/readme.go.md index 2e31c6d6726e..344d8c43e1f3 100644 --- a/specification/datadog/resource-manager/readme.go.md +++ b/specification/datadog/resource-manager/readme.go.md @@ -8,4 +8,6 @@ module-name: sdk/resourcemanager/datadog/armdatadog module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) azure-arm: true +modelerfour: + lenient-model-deduplication: true # !!temporary!! to solve the duplicate schema issue of ErrorResponse in common-type ``` diff --git a/specification/datadog/resource-manager/readme.java.md b/specification/datadog/resource-manager/readme.java.md index afc9f244c1d9..cf652d42ae8f 100644 --- a/specification/datadog/resource-manager/readme.java.md +++ b/specification/datadog/resource-manager/readme.java.md @@ -16,6 +16,9 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datadog ``` yaml $(java) && $(multiapi) batch: + - tag: package-2025-06 + - tag: package-2025-01 + - tag: package-2024-03 - tag: package-2023-01 - tag: packag-2022-08 - tag: package-2022-06 @@ -23,7 +26,72 @@ batch: - tag: package-2020-02-preview ``` -### Tag: ppackage-2023-01 and java +### Tag: package-2025-06 and java + +These settings apply only when `--tag=package-2025-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2025-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datadog.v2025_06_11 + output-folder: $(azure-libraries-for-java-folder)/sdk/datadog/mgmt-v2025_06_11 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2025-01 and java + +These settings apply only when `--tag=package-2025-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2025-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datadog.v2025_01_07 + output-folder: $(azure-libraries-for-java-folder)/sdk/datadog/mgmt-v2025_01_07 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2024-03 and java + +These settings apply only when `--tag=package-2024-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2024-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datadog.v2024_03_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/datadog/mgmt-v2024-03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2023-10 and java + +These settings apply only when `--tag=package-2023-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2023-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datadog.v2023_10_20 + output-folder: $(azure-libraries-for-java-folder)/sdk/datadog/mgmt-v2023_10_20 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2023-07 and java + +These settings apply only when `--tag=package-2023-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2023-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datadog.v2023_07_07 + output-folder: $(azure-libraries-for-java-folder)/sdk/datadog/mgmt-v2023_07_07 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2023-01 and java These settings apply only when `--tag=package-2023-01 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. @@ -36,7 +104,7 @@ regenerate-manager: true generate-interface: true ``` -### Tag: ppackage-2022-08 and java +### Tag: package-2022-08 and java These settings apply only when `--tag=package-2022-08 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. @@ -49,7 +117,7 @@ regenerate-manager: true generate-interface: true ``` -### Tag: ppackage-2022-06 and java +### Tag: package-2022-06 and java These settings apply only when `--tag=package-2022-06 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. @@ -62,7 +130,7 @@ regenerate-manager: true generate-interface: true ``` -### Tag: ppackage-2021-03 and java +### Tag: package-2021-03 and java These settings apply only when `--tag=package-2021-03 --java` is specified on the command line. Please also specify `--azure-libraries-for-java=`. diff --git a/specification/datadog/resource-manager/readme.md b/specification/datadog/resource-manager/readme.md index e987a543bebc..8e69f94d1154 100644 --- a/specification/datadog/resource-manager/readme.md +++ b/specification/datadog/resource-manager/readme.md @@ -26,8 +26,36 @@ These are the global settings for the Datadog API. title: Microsoft Datadog Client openapi-type: arm openapi-subtype: rpaas -tag: package-2023-10 +tag: package-2025-06 ``` + +### Tag: package-2025-06 + +These settings apply only when `--tag=package-2025-06` is specified on the command line. + +``` yaml $(tag) == 'package-2025-06' +input-file: +- Microsoft.Datadog/stable/2025-06-11/datadog.json +``` + +### Tag: package-2025-01 + +These settings apply only when `--tag=package-2025-01` is specified on the command line. + +``` yaml $(tag) == 'package-2025-01' +input-file: +- Microsoft.Datadog/stable/2025-01-07/datadog.json +``` + +### Tag: package-2024-03 + +These settings apply only when `--tag=package-2024-03` is specified on the command line. + +``` yaml $(tag) == 'package-2024-03' +input-file: +- Microsoft.Datadog/stable/2024-03-01/datadog.json +``` + ### Tag: package-2023-10 These settings apply only when `--tag=package-2023-10` is specified on the command line. diff --git a/specification/datadog/resource-manager/readme.python.md b/specification/datadog/resource-manager/readme.python.md index 07bd8db9d119..adfbbe53a8bc 100644 --- a/specification/datadog/resource-manager/readme.python.md +++ b/specification/datadog/resource-manager/readme.python.md @@ -12,6 +12,8 @@ package-name: azure-mgmt-datadog namespace: azure.mgmt.datadog package-version: 1.0.0b1 clear-output-folder: true +modelerfour: + lenient-model-deduplication: true # !!temporary!! to solve the duplicate schema issue of ErrorResponse in common-type ``` ``` yaml $(python) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 8652c8368767..1d08d66139ae 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -3094,7 +3094,27 @@ "typeProperties": { "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true, - "$ref": "#/definitions/GenericDatasetTypeProperties" + "$ref": "#/definitions/JiraTableDatasetTypeProperties" + } + } + }, + "JiraTableDatasetTypeProperties": { + "description": "Jira dataset properties.", + "properties": { + "tableName": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "This property is only supported in Jira V1 Dataset, please consider upgrading to V2 dataset." + }, + "schema": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The schema name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string)." + }, + "table": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The table name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string)." } } }, diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/back-compat.tsp b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/back-compat.tsp index b9c97075e68e..5ef750e7034f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/back-compat.tsp +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/back-compat.tsp @@ -64,3 +64,52 @@ using Microsoft.DesktopVirtualization; ); @@clientName(MSIXImages, "MsixImages", "autorest"); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ActiveSessionHostConfiguration.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApplicationGroup.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AppAttachPackage.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Application.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Desktop.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(HostPool.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MSIXPackage.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Workspace.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateEndpointConnectionWithSystemData.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScalingPlanPersonalSchedule.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScalingPlan.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScalingPlanPooledSchedule.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SessionHost.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SessionHostConfiguration.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SessionHostManagement.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(UserSession.properties, + "autorest" +); diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..dc9b5d895d24 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "ActiveSessionHostConfigurations_Get", + "title": "ActiveSessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..06beea9b4e8e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "title": "ActiveSessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackageInfo_Import.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackageInfo_Import.json new file mode 100644 index 000000000000..2f23eea68a4a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackageInfo_Import.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "importPackageInfoRequest": { + "path": "https://url.com/imagePath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + }, + "operationId": "AppAttachPackageInfo_Import", + "title": "AppAttachPackageInfo_Import" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Create.json new file mode 100644 index 000000000000..d448c18a128c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Create.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + }, + "201": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Create", + "title": "AppAttachPackage_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_CreateOrUpdate.json new file mode 100644 index 000000000000..cbdde4e1a715 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_CreateOrUpdate.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2025-08-01-preview", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + } + }, + "appAttachPackageName": "msixpackagefullname", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "AppAttachPackage_CreateOrUpdate", + "title": "AppAttachPackage_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..07e5b911996e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Delete.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + "204": {} + }, + "operationId": "AppAttachPackage_Delete", + "title": "AppAttachPackage_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Get.json new file mode 100644 index 000000000000..cd1027fbef86 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Get", + "title": "AppAttachPackage_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..427d64f1a9f4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListByResourceGroup", + "title": "AppAttachPackage_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..22c7799378d1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListBySubscription", + "title": "AppAttachPackage_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Update.json new file mode 100644 index 000000000000..6bbe58727949 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/AppAttachPackage_Update.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackagePatch": { + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp1", + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": "DoNotFail" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Update", + "title": "AppAttachPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..65ef37526bee --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-08-01-preview", + "applicationGroup": { + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "showInFeed": true, + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "applicationGroupName": "applicationGroup1", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "ApplicationGroups_CreateOrUpdate", + "title": "ApplicationGroup_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Delete.json new file mode 100644 index 000000000000..934dc813f1c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + }, + "operationId": "ApplicationGroups_Delete", + "title": "ApplicationGroups_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Get.json new file mode 100644 index 000000000000..b3ca7f13557c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Get", + "title": "ApplicationGroup_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..36f6fd2078f6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_ListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListByResourceGroup", + "title": "ApplicationGroup_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_ListBySubscription.json new file mode 100644 index 000000000000..469c6073306c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_ListBySubscription.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListBySubscription", + "title": "ApplicationGroup_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Update.json new file mode 100644 index 000000000000..213e49b58051 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ApplicationGroups_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Update", + "title": "ApplicationGroup_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_CreateOrUpdate.json new file mode 100644 index 000000000000..b0863c2b9c70 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_CreateOrUpdate", + "title": "Applications_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Delete.json new file mode 100644 index 000000000000..c57d3043b417 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Delete.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + }, + "operationId": "Applications_Delete", + "title": "Applications_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Get.json new file mode 100644 index 000000000000..66d4ab382ebf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Get", + "title": "Applications_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_List.json new file mode 100644 index 000000000000..9ca1298c58e0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + }, + "operationId": "Applications_List", + "title": "Applications_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Update.json new file mode 100644 index 000000000000..196bd0021a4a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Applications_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Update", + "title": "Applications_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_Get.json new file mode 100644 index 000000000000..69f969f030d4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Get", + "title": "Desktops_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_List.json new file mode 100644 index 000000000000..ca773a0c5208 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + }, + "operationId": "Desktops_List", + "title": "Desktops_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_Update.json new file mode 100644 index 000000000000..c62f793f529a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Desktops_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-08-01-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Update", + "title": "Desktops_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPool_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPool_CreateOrUpdate.json new file mode 100644 index 000000000000..fea42d21d6cd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPool_CreateOrUpdate.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995", + "deploymentScope": "Geographical" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + } + }, + "operationId": "HostPools_CreateOrUpdate", + "title": "HostPools_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPool_Lists.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPool_Lists.json new file mode 100644 index 000000000000..8eb7b9344dac --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPool_Lists.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + } + ] + } + } + }, + "operationId": "HostPools_List", + "title": "HostPool_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Delete.json new file mode 100644 index 000000000000..baff8f3b8e0d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Delete.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "deploymentScope": "Geographical" + } + }, + "204": {} + }, + "operationId": "HostPools_Delete", + "title": "HostPools_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Get.json new file mode 100644 index 000000000000..f5d1490ca907 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + }, + "operationId": "HostPools_Get", + "title": "HostPools_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_ListByResourceGroup.json new file mode 100644 index 000000000000..75774d68c38e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_ListByResourceGroup.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + } + ] + } + } + }, + "operationId": "HostPools_ListByResourceGroup", + "title": "HostPools_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_ListRegistrationTokens.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_ListRegistrationTokens.json new file mode 100644 index 000000000000..261e0785603a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_ListRegistrationTokens.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token" + } + ] + } + } + }, + "operationId": "HostPools_ListRegistrationTokens", + "title": "HostPools_ListRegistrationTokens" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_RetrieveRegistrationToken.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_RetrieveRegistrationToken.json new file mode 100644 index 000000000000..e04fa6122d75 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_RetrieveRegistrationToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + }, + "operationId": "HostPools_RetrieveRegistrationToken", + "title": "HostPools_RetrieveRegistrationToken" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Update.json new file mode 100644 index 000000000000..db12a4bfb7e4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/HostPools_Update.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + }, + "operationId": "HostPools_Update", + "title": "HostPools_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_CreateOrUpdate.json new file mode 100644 index 000000000000..96a9620a8305 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_CreateOrUpdate.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_CreateOrUpdate", + "title": "MSIXPackages_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Delete.json new file mode 100644 index 000000000000..c0abc9c1d8a0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Delete.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + }, + "operationId": "MSIXPackages_Delete", + "title": "MSIXPackages_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Get.json new file mode 100644 index 000000000000..3205c628cc6f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Get", + "title": "MSIXPackages_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_List.json new file mode 100644 index 000000000000..4804b17c7625 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_List.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MSIXPackages_List", + "title": "MSIXPackages_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Update.json new file mode 100644 index 000000000000..c3057452782a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MSIXPackages_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Update", + "title": "MSIXPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MsixImages_Expand.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MsixImages_Expand.json new file mode 100644 index 000000000000..519f732acf4e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/MsixImages_Expand.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixImageURI": { + "uri": "https://url.com/imagePath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/imagepath", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/msixImageURI", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MsixImages_Expand", + "title": "MsixImages_Expand" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/OperationDescription_List.json new file mode 100644 index 000000000000..709b5732a3cb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/OperationDescription_List.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/hostpools/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Read hostpool", + "description": "Read hostpool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.DesktopVirtualization/hostpools/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Write hostpool", + "description": "Write hostpool" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + } + ] + } + }, + "isDataAction": false + } + ] + } + } + }, + "operationId": "OperationDescription_List", + "title": "OperationDescription_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Operations_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Operations_List.json new file mode 100644 index 000000000000..05bb825d830a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_DeleteByHostPool.json new file mode 100644 index 000000000000..4891ce882219 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_DeleteByHostPool.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "title": "PrivateEndpointConnections_DeleteByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_DeleteByWorkspace.json new file mode 100644 index 000000000000..7000a7f1a0ad --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_DeleteByWorkspace.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "title": "PrivateEndpointConnections_DeleteByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_GetByHostPool.json new file mode 100644 index 000000000000..d1fa7fe2c1ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_GetByHostPool.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByHostPool", + "title": "PrivateEndpointConnections_GetByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_GetByWorkspace.json new file mode 100644 index 000000000000..afb5f278655d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_GetByWorkspace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "title": "PrivateEndpointConnections_GetByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_ListByHostPool.json new file mode 100644 index 000000000000..d7ed60617d29 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_ListByHostPool.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByHostPool", + "title": "PrivateEndpointConnections_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_ListByWorkspace.json new file mode 100644 index 000000000000..80f911d510e8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_ListByWorkspace.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "title": "PrivateEndpointConnections_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_UpdateByHostPool.json new file mode 100644 index 000000000000..d9534d5b74ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_UpdateByHostPool.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "title": "PrivateEndpointConnections_UpdateByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_UpdateByWorkspace.json new file mode 100644 index 000000000000..c84f801e7483 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateEndpointConnections_UpdateByWorkspace.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "title": "PrivateEndpointConnections_UpdateByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..8c2896b235b4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByHostPool", + "title": "PrivateLinkResources_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..187a5f2a4324 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByWorkspace", + "title": "PrivateLinkResources_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Create.json new file mode 100644 index 000000000000..325f82274d43 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Create.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Create", + "title": "ScalingPlanPersonalSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Delete.json new file mode 100644 index 000000000000..1305d6799b33 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPersonalSchedules_Delete", + "title": "ScalingPlanPersonalSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Get.json new file mode 100644 index 000000000000..d02deed33347 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Get", + "title": "ScalingPlanPersonalSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_List.json new file mode 100644 index 000000000000..6c933470a6be --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_List.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_List", + "title": "ScalingPlanPersonalSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Update.json new file mode 100644 index 000000000000..b8b64b731914 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPersonalSchedules_Update.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Update", + "title": "ScalingPlanPersonalSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Create.json new file mode 100644 index 000000000000..cbd454dcf57c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Create.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json new file mode 100644 index 000000000000..ec9e93adc882 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_CreateUsingCreateDelete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Delete.json new file mode 100644 index 000000000000..3d68bbd90ecd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPooledSchedules_Delete", + "title": "ScalingPlanPooledSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Get.json new file mode 100644 index 000000000000..ad1870d49465 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Get", + "title": "ScalingPlanPooledSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_List.json new file mode 100644 index 000000000000..b5735a0eefbe --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_List.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + }, + "operationId": "ScalingPlanPooledSchedules_List", + "title": "ScalingPlanPooledSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Update.json new file mode 100644 index 000000000000..591416bfd7c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlanPooledSchedules_Update.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Update", + "title": "ScalingPlanPooledSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Create.json new file mode 100644 index 000000000000..9c525c39006d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Create.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Create", + "title": "ScalingPlans_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Delete.json new file mode 100644 index 000000000000..5d781a8b230d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Delete.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + }, + "operationId": "ScalingPlans_Delete", + "title": "ScalingPlans_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Get.json new file mode 100644 index 000000000000..ec60170e3a94 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Get.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Get", + "title": "ScalingPlans_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListByHostPool.json new file mode 100644 index 000000000000..221fbf34cb81 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByHostPool", + "title": "ScalingPlans_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListByResourceGroup.json new file mode 100644 index 000000000000..6ffb3648878f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListByResourceGroup.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByResourceGroup", + "title": "ScalingPlans_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListBySubscription.json new file mode 100644 index 000000000000..d5e83842ded2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_ListBySubscription.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListBySubscription", + "title": "ScalingPlans_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Update.json new file mode 100644 index 000000000000..b81dba7493ee --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/ScalingPlans_Update.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview", + "scalingPlan": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Update", + "title": "ScalingPlans_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..d15b8e6bfaea --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_CreateOrUpdate.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "title": "SessionHostConfigurations_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..6357610c61c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_Get.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_Get", + "title": "SessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..fc75fca37b5e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "SessionHostConfigurations_ListByHostPool", + "title": "SessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..456944a23d18 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostConfigurations_Update.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "SessionHostConfigurations_Update", + "title": "SessionHostConfigurations_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagementsUpdateStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagementsUpdateStatus_Get.json new file mode 100644 index 000000000000..b9afd5033a62 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagementsUpdateStatus_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostUpdateStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostManagementsUpdateStatus_Get", + "title": "SessionHostManagementsUpdateStatus_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ControlSessionHostProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ControlSessionHostProvisioning_Post.json new file mode 100644 index 000000000000..2eecfbcc3181 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ControlSessionHostProvisioning_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPoolProvisioningControlParameter": { + "action": "Cancel", + "cancelMessage": "Cancel host pool provisioning" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostProvisioning_Post", + "title": "SessionHostManagements_ControlSessionHostProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..b3b99ed813bf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPoolUpdateControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostUpdate_Post", + "title": "SessionHostManagements_ControlSessionHostUpdate_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Create.json new file mode 100644 index 000000000000..25d8550bc0c1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_CreateOrUpdate", + "title": "SessionHostManagements_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Get.json new file mode 100644 index 000000000000..c592a5b21dad --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Get", + "title": "SessionHostManagements_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..29d2282a7613 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + }, + "operationId": "SessionHostManagements_ListByHostPool", + "title": "SessionHostManagements_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_SessionHostProvisioningStatuses_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_SessionHostProvisioningStatuses_Get.json new file mode 100644 index 000000000000..839bfc1e8dfe --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_SessionHostProvisioningStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostProvisioningStatuses_Get", + "title": "SessionHostManagements_SessionHostProvisioningStatuses_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Update.json new file mode 100644 index 000000000000..180913c963bd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Update", + "title": "SessionHostManagements_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..680750cbb90a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "204": { + "description": "Operation completed successfully." + } + }, + "operationId": "InitiateSessionHostUpdate_Post", + "title": "SessionHostManagements_UpdateSessionHosts_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..84005e7c9568 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "description": "Operation completed successfully." + } + }, + "operationId": "SessionHosts_RetryProvisioning", + "title": "SessionHosts_RetryProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Delete.json new file mode 100644 index 000000000000..0fd7143d7cd5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + }, + "operationId": "SessionHosts_Delete", + "title": "SessionHost_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Get.json new file mode 100644 index 000000000000..d2e7c9b3fde6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Get", + "title": "SessionHost_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_List.json new file mode 100644 index 000000000000..32c2ad56e249 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_List.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + }, + "operationId": "SessionHosts_List", + "title": "SessionHost_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Update.json new file mode 100644 index 000000000000..6a411d019053 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/SessionHosts_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Update", + "title": "SessionHost_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/StartMenuItems_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/StartMenuItems_List.json new file mode 100644 index 000000000000..baa3a8f63c6f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/StartMenuItems_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + }, + "operationId": "StartMenuItems_List", + "title": "StartMenuItems_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSession_Get.json new file mode 100644 index 000000000000..be3852f0619b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSession_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + }, + "operationId": "UserSessions_Get", + "title": "UserSessions_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_Delete.json new file mode 100644 index 000000000000..36c339f228b0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + }, + "operationId": "UserSessions_Delete", + "title": "UserSession_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_Disconnect.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_Disconnect.json new file mode 100644 index 000000000000..0270d422c25a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_Disconnect.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {} + }, + "operationId": "UserSessions_Disconnect", + "title": "UserSession_Disconnect_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_List.json new file mode 100644 index 000000000000..51508fe35683 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_List", + "title": "UserSession_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_ListByHostPool.json new file mode 100644 index 000000000000..8aed92f14df1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_ListByHostPool.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_ListByHostPool", + "title": "UserSession_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_SendMessage.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_SendMessage.json new file mode 100644 index 000000000000..6053954e5eba --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/UserSessions_SendMessage.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": { + "description": "The request has succeeded." + } + }, + "operationId": "UserSessions_SendMessage", + "title": "UserSession_SendMessage_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..7e3ecf6dc57a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_CreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspace_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Delete.json new file mode 100644 index 000000000000..7a3ffeffce5d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + }, + "operationId": "Workspaces_Delete", + "title": "Workspace_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Get.json new file mode 100644 index 000000000000..35c7018f71f5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Get", + "title": "Workspace_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_ListByResourceGroup.json new file mode 100644 index 000000000000..1e67a88dce13 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListByResourceGroup", + "title": "Workspace_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_ListBySubscription.json new file mode 100644 index 000000000000..351a8d64c8ce --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListBySubscription", + "title": "Workspaces_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Update.json new file mode 100644 index 000000000000..890be300bd5f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-08-01-preview/Workspaces_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Update", + "title": "Workspace_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..b2987cca9f4e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "ActiveSessionHostConfigurations_Get", + "title": "ActiveSessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..07d8e3be9a94 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "title": "ActiveSessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackageInfo_Import.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackageInfo_Import.json new file mode 100644 index 000000000000..643a6ef64da2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackageInfo_Import.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "importPackageInfoRequest": { + "path": "https://url.com/imagePath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + }, + "operationId": "AppAttachPackageInfo_Import", + "title": "AppAttachPackageInfo_Import" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Create.json new file mode 100644 index 000000000000..5226cc945aa4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Create.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + }, + "201": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Create", + "title": "AppAttachPackage_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_CreateOrUpdate.json new file mode 100644 index 000000000000..3aa2f925236f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_CreateOrUpdate.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2025-09-01-preview", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + } + }, + "appAttachPackageName": "msixpackagefullname", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "AppAttachPackage_CreateOrUpdate", + "title": "AppAttachPackage_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..32ec4e8e4d12 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Delete.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + "204": {} + }, + "operationId": "AppAttachPackage_Delete", + "title": "AppAttachPackage_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Get.json new file mode 100644 index 000000000000..dedd797843ef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Get", + "title": "AppAttachPackage_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..2713d750c96c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListByResourceGroup", + "title": "AppAttachPackage_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..66b3e7132b37 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListBySubscription", + "title": "AppAttachPackage_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Update.json new file mode 100644 index 000000000000..43d58ea9ecb9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/AppAttachPackage_Update.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackagePatch": { + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp1", + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": "DoNotFail" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Update", + "title": "AppAttachPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..1eea56e5a62f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-09-01-preview", + "applicationGroup": { + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "showInFeed": true, + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "applicationGroupName": "applicationGroup1", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "ApplicationGroups_CreateOrUpdate", + "title": "ApplicationGroup_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Delete.json new file mode 100644 index 000000000000..0b429c22c3cc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + }, + "operationId": "ApplicationGroups_Delete", + "title": "ApplicationGroups_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Get.json new file mode 100644 index 000000000000..58b6c774e4f2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Get", + "title": "ApplicationGroup_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..06ead236ae6b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_ListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListByResourceGroup", + "title": "ApplicationGroup_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_ListBySubscription.json new file mode 100644 index 000000000000..db141adb5291 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_ListBySubscription.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListBySubscription", + "title": "ApplicationGroup_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Update.json new file mode 100644 index 000000000000..a581685cafa9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ApplicationGroups_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Update", + "title": "ApplicationGroup_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_CreateOrUpdate.json new file mode 100644 index 000000000000..b993b5e5ded9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_CreateOrUpdate", + "title": "Applications_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Delete.json new file mode 100644 index 000000000000..38ee2fe4562c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Delete.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + }, + "operationId": "Applications_Delete", + "title": "Applications_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Get.json new file mode 100644 index 000000000000..23b78736f079 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Get", + "title": "Applications_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_List.json new file mode 100644 index 000000000000..4f0ab23909ce --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + }, + "operationId": "Applications_List", + "title": "Applications_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Update.json new file mode 100644 index 000000000000..ccbdd744fcbf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Applications_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Update", + "title": "Applications_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_Get.json new file mode 100644 index 000000000000..decaa3e0ff68 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Get", + "title": "Desktops_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_List.json new file mode 100644 index 000000000000..08b998c37b37 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + }, + "operationId": "Desktops_List", + "title": "Desktops_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_Update.json new file mode 100644 index 000000000000..b70e20668355 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Desktops_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-09-01-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Update", + "title": "Desktops_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPool_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPool_CreateOrUpdate.json new file mode 100644 index 000000000000..1ff9c494a17f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPool_CreateOrUpdate.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + } + }, + "operationId": "HostPools_CreateOrUpdate", + "title": "HostPools_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPool_Lists.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPool_Lists.json new file mode 100644 index 000000000000..37b9349dae3d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPool_Lists.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + ] + } + } + }, + "operationId": "HostPools_List", + "title": "HostPool_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Delete.json new file mode 100644 index 000000000000..e408380eab20 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Delete.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "deploymentScope": "Geographical" + } + }, + "204": {} + }, + "operationId": "HostPools_Delete", + "title": "HostPools_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Get.json new file mode 100644 index 000000000000..68c08ef1647a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Get.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + }, + "operationId": "HostPools_Get", + "title": "HostPools_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_ListByResourceGroup.json new file mode 100644 index 000000000000..f2303122bce1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_ListByResourceGroup.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + ] + } + } + }, + "operationId": "HostPools_ListByResourceGroup", + "title": "HostPools_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_ListRegistrationTokens.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_ListRegistrationTokens.json new file mode 100644 index 000000000000..f336002cb839 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_ListRegistrationTokens.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token" + } + ] + } + } + }, + "operationId": "HostPools_ListRegistrationTokens", + "title": "HostPools_ListRegistrationTokens" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_RetrieveRegistrationToken.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_RetrieveRegistrationToken.json new file mode 100644 index 000000000000..f1f6423347ed --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_RetrieveRegistrationToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + }, + "operationId": "HostPools_RetrieveRegistrationToken", + "title": "HostPools_RetrieveRegistrationToken" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Update.json new file mode 100644 index 000000000000..a6b0923df7e9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/HostPools_Update.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + }, + "operationId": "HostPools_Update", + "title": "HostPools_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_CreateOrUpdate.json new file mode 100644 index 000000000000..11cd1ee64f41 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_CreateOrUpdate.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_CreateOrUpdate", + "title": "MSIXPackages_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Delete.json new file mode 100644 index 000000000000..3e5de29b9aef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Delete.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + }, + "operationId": "MSIXPackages_Delete", + "title": "MSIXPackages_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Get.json new file mode 100644 index 000000000000..22187846db61 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Get", + "title": "MSIXPackages_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_List.json new file mode 100644 index 000000000000..f64ba9aff56e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_List.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MSIXPackages_List", + "title": "MSIXPackages_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Update.json new file mode 100644 index 000000000000..1e04a29ff5dc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MSIXPackages_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Update", + "title": "MSIXPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MsixImages_Expand.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MsixImages_Expand.json new file mode 100644 index 000000000000..eedda85243aa --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/MsixImages_Expand.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixImageURI": { + "uri": "https://url.com/imagePath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/imagepath", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/msixImageURI", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MsixImages_Expand", + "title": "MsixImages_Expand" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/OperationDescription_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/OperationDescription_List.json new file mode 100644 index 000000000000..2d1db962282a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/OperationDescription_List.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/hostpools/read", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Read hostpool", + "description": "Read hostpool" + }, + "isDataAction": false + }, + { + "name": "Microsoft.DesktopVirtualization/hostpools/write", + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "hostpools", + "operation": "Write hostpool", + "description": "Write hostpool" + }, + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + }, + { + "name": "", + "displayName": "" + } + ] + } + }, + "isDataAction": false + } + ] + } + } + }, + "operationId": "OperationDescription_List", + "title": "OperationDescription_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Operations_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Operations_List.json new file mode 100644 index 000000000000..54b8546cfa04 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_DeleteByHostPool.json new file mode 100644 index 000000000000..d1a5a35cb0b8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_DeleteByHostPool.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "title": "PrivateEndpointConnections_DeleteByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_DeleteByWorkspace.json new file mode 100644 index 000000000000..9d8858e9246e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_DeleteByWorkspace.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "title": "PrivateEndpointConnections_DeleteByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_GetByHostPool.json new file mode 100644 index 000000000000..2aa766ce6d97 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_GetByHostPool.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByHostPool", + "title": "PrivateEndpointConnections_GetByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_GetByWorkspace.json new file mode 100644 index 000000000000..db7f8c4ec953 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_GetByWorkspace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "title": "PrivateEndpointConnections_GetByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_ListByHostPool.json new file mode 100644 index 000000000000..78aa4e75924d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_ListByHostPool.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByHostPool", + "title": "PrivateEndpointConnections_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_ListByWorkspace.json new file mode 100644 index 000000000000..d7bd501ea918 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_ListByWorkspace.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "title": "PrivateEndpointConnections_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_UpdateByHostPool.json new file mode 100644 index 000000000000..d71025f5abc4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_UpdateByHostPool.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "title": "PrivateEndpointConnections_UpdateByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_UpdateByWorkspace.json new file mode 100644 index 000000000000..73cac14c1aea --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateEndpointConnections_UpdateByWorkspace.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "title": "PrivateEndpointConnections_UpdateByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..d7632a8367d0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByHostPool", + "title": "PrivateLinkResources_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..f46df5f8863d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByWorkspace", + "title": "PrivateLinkResources_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Create.json new file mode 100644 index 000000000000..23d03226f5af --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Create.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Create", + "title": "ScalingPlanPersonalSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Delete.json new file mode 100644 index 000000000000..68511bc119d1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPersonalSchedules_Delete", + "title": "ScalingPlanPersonalSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Get.json new file mode 100644 index 000000000000..d90a310ff6f9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Get", + "title": "ScalingPlanPersonalSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_List.json new file mode 100644 index 000000000000..2e970e810178 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_List.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_List", + "title": "ScalingPlanPersonalSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Update.json new file mode 100644 index 000000000000..265b957ea621 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPersonalSchedules_Update.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Update", + "title": "ScalingPlanPersonalSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Create.json new file mode 100644 index 000000000000..568a36c74de9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Create.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json new file mode 100644 index 000000000000..79982489429c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_CreateUsingCreateDelete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Delete.json new file mode 100644 index 000000000000..68d69652f209 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPooledSchedules_Delete", + "title": "ScalingPlanPooledSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Get.json new file mode 100644 index 000000000000..de9eff9b47c2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Get", + "title": "ScalingPlanPooledSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_List.json new file mode 100644 index 000000000000..78dbec34e08c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_List.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + }, + "operationId": "ScalingPlanPooledSchedules_List", + "title": "ScalingPlanPooledSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Update.json new file mode 100644 index 000000000000..3569cb19ebac --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlanPooledSchedules_Update.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Update", + "title": "ScalingPlanPooledSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Create.json new file mode 100644 index 000000000000..f380112e7f5f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Create.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Create", + "title": "ScalingPlans_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Delete.json new file mode 100644 index 000000000000..0e87a5572aaa --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Delete.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + }, + "operationId": "ScalingPlans_Delete", + "title": "ScalingPlans_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Get.json new file mode 100644 index 000000000000..c4b69662f1a9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Get.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Get", + "title": "ScalingPlans_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListByHostPool.json new file mode 100644 index 000000000000..079dd644c19f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByHostPool", + "title": "ScalingPlans_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListByResourceGroup.json new file mode 100644 index 000000000000..d09afc777730 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListByResourceGroup.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByResourceGroup", + "title": "ScalingPlans_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListBySubscription.json new file mode 100644 index 000000000000..592bcc978c9c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_ListBySubscription.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListBySubscription", + "title": "ScalingPlans_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Update.json new file mode 100644 index 000000000000..7ebfd3caf5b5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/ScalingPlans_Update.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview", + "scalingPlan": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Update", + "title": "ScalingPlans_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..e7c86a031c04 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_CreateOrUpdate.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "title": "SessionHostConfigurations_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..c4bf960585b9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_Get.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_Get", + "title": "SessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..84566d6e9d1c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "SessionHostConfigurations_ListByHostPool", + "title": "SessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..749c3dc9416a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostConfigurations_Update.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "SessionHostConfigurations_Update", + "title": "SessionHostConfigurations_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagementsUpdateStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagementsUpdateStatus_Get.json new file mode 100644 index 000000000000..0bc7e025d085 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagementsUpdateStatus_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostUpdateStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostManagementsUpdateStatus_Get", + "title": "SessionHostManagementsUpdateStatus_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ControlSessionHostProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ControlSessionHostProvisioning_Post.json new file mode 100644 index 000000000000..0c4392607d76 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ControlSessionHostProvisioning_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPoolProvisioningControlParameter": { + "action": "Cancel", + "cancelMessage": "Cancel host pool provisioning" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostProvisioning_Post", + "title": "SessionHostManagements_ControlSessionHostProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..2b96f4057d25 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPoolUpdateControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostUpdate_Post", + "title": "SessionHostManagements_ControlSessionHostUpdate_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Create.json new file mode 100644 index 000000000000..a0d1c807032e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_CreateOrUpdate", + "title": "SessionHostManagements_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Get.json new file mode 100644 index 000000000000..b5869586df2e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Get", + "title": "SessionHostManagements_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..471973d2a147 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + }, + "operationId": "SessionHostManagements_ListByHostPool", + "title": "SessionHostManagements_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_SessionHostProvisioningStatuses_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_SessionHostProvisioningStatuses_Get.json new file mode 100644 index 000000000000..5203170f3109 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_SessionHostProvisioningStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostProvisioningStatuses_Get", + "title": "SessionHostManagements_SessionHostProvisioningStatuses_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Update.json new file mode 100644 index 000000000000..4854cbc0c044 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Update", + "title": "SessionHostManagements_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..4e7582225f50 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "204": { + "description": "Operation completed successfully." + } + }, + "operationId": "InitiateSessionHostUpdate_Post", + "title": "SessionHostManagements_UpdateSessionHosts_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..fa0d793517cb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "description": "Operation completed successfully." + } + }, + "operationId": "SessionHosts_RetryProvisioning", + "title": "SessionHosts_RetryProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Delete.json new file mode 100644 index 000000000000..7d530543c65e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + }, + "operationId": "SessionHosts_Delete", + "title": "SessionHost_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Get.json new file mode 100644 index 000000000000..103fb6a4455c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Get", + "title": "SessionHost_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_List.json new file mode 100644 index 000000000000..de994d043b25 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_List.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + }, + "operationId": "SessionHosts_List", + "title": "SessionHost_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Update.json new file mode 100644 index 000000000000..104a6b29a982 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/SessionHosts_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Update", + "title": "SessionHost_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/StartMenuItems_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/StartMenuItems_List.json new file mode 100644 index 000000000000..2cb157362d81 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/StartMenuItems_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + }, + "operationId": "StartMenuItems_List", + "title": "StartMenuItems_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSession_Get.json new file mode 100644 index 000000000000..05c73e251cf9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSession_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + }, + "operationId": "UserSessions_Get", + "title": "UserSessions_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_Delete.json new file mode 100644 index 000000000000..f96d8cbd149e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + }, + "operationId": "UserSessions_Delete", + "title": "UserSession_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_Disconnect.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_Disconnect.json new file mode 100644 index 000000000000..08d820afcaf7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_Disconnect.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {} + }, + "operationId": "UserSessions_Disconnect", + "title": "UserSession_Disconnect_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_List.json new file mode 100644 index 000000000000..948c83dbd897 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_List", + "title": "UserSession_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_ListByHostPool.json new file mode 100644 index 000000000000..59d9cc05ba74 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_ListByHostPool.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_ListByHostPool", + "title": "UserSession_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_SendMessage.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_SendMessage.json new file mode 100644 index 000000000000..ee95901eb019 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/UserSessions_SendMessage.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": { + "description": "The request has succeeded." + } + }, + "operationId": "UserSessions_SendMessage", + "title": "UserSession_SendMessage_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..24a6f39e9b52 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_CreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspace_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Delete.json new file mode 100644 index 000000000000..49d7585f287b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + }, + "operationId": "Workspaces_Delete", + "title": "Workspace_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Get.json new file mode 100644 index 000000000000..61b13abe55e9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Get", + "title": "Workspace_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_ListByResourceGroup.json new file mode 100644 index 000000000000..79b8faf9cb62 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListByResourceGroup", + "title": "Workspace_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_ListBySubscription.json new file mode 100644 index 000000000000..4bdc93d564bf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListBySubscription", + "title": "Workspaces_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Update.json new file mode 100644 index 000000000000..2f348ba7f919 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/examples/2025-09-01-preview/Workspaces_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Update", + "title": "Workspace_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/main.tsp b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/main.tsp index b749f9a728f1..6fa6e91da251 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/main.tsp +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/main.tsp @@ -79,4 +79,14 @@ enum Versions { * The 2025-04-01-preview API version. */ v2025_04_01_preview: "2025-04-01-preview", + + /** + * The 2025-08-01-preview API version. + */ + v2025_08_01_preview: "2025-08-01-preview", + + /** + * The 2025-09-01-preview API version. + */ + v2025_09_01_preview: "2025-09-01-preview", } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/models.tsp b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/models.tsp index 4be41b6d07c0..605bb0af5c5a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/models.tsp +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/models.tsp @@ -73,6 +73,23 @@ union HostPoolProvisioningAction { Cancel: "Cancel", } +/** + * Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes. + */ +union AllowRDPShortPathWithPrivateLink { + string, + + /** + * Blocks the use of RDPShortPath if the hostpool PublicNetworkAccess setting is configured to require private link. + */ + Disabled: "Disabled", + + /** + * Allows the use of RDPShortPath even if the hostpool PublicNetworkAccess is configured to require the use of private link. + */ + Enabled: "Enabled", +} + /** * Provisioning state of the Session Host Configuration. */ @@ -1241,6 +1258,23 @@ union DiffDiskPlacement { ResourceDisk: "ResourceDisk", } +/** + * DeploymentScope type for HostPool. + */ +union DeploymentScope { + string, + + /** + * For geographical Broker and ArmProvider talking to Geographical SQL DB + */ + Geographical: "Geographical", + + /** + * For regional Broker and ArmProvider talking to regional SQL DB + */ + Regional: "Regional", +} + /** * Day of the week. Modeled as string */ @@ -2246,6 +2280,12 @@ model ApplicationGroupProperties { * Boolean representing whether the applicationGroup is show in the feed. */ showInFeed?: boolean; + + /** + * Tenant that the resource is being requested on behalf of. + */ + @added(Versions.v2025_08_01_preview) + oboTenantId?: string; } /** @@ -2556,6 +2596,25 @@ model HostPoolProperties { * The type of management for this hostpool, Automated or Standard. The default value is Automated. */ managementType?: ManagementType; + + /** + * DeploymentScope type for HostPool. + */ + @added(Versions.v2025_08_01_preview) + deploymentScope?: DeploymentScope; + + /** + * Tenant that the resource is being requested on behalf of. + */ + @added(Versions.v2025_08_01_preview) + oboTenantId?: string; + + /** + * Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "RDP is a valid acronym" + @added(Versions.v2025_09_01_preview) + allowRDPShortPathWithPrivateLink?: AllowRDPShortPathWithPrivateLink; } /** @@ -2977,6 +3036,12 @@ model WorkspaceProperties { */ @visibility(Lifecycle.Read) privateEndpointConnections?: PrivateEndpointConnection[]; + + /** + * Tenant that the resource is being requested on behalf of. + */ + @added(Versions.v2025_08_01_preview) + oboTenantId?: string; } /** @@ -3566,6 +3631,13 @@ model HostPoolPatchProperties { */ #suppress "@azure-tools/typespec-azure-core/casing-style" "UDP is a valid acronym" relayUDP?: RelayUDP; + + /** + * Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "RDP is a valid acronym" + @added(Versions.v2025_09_01_preview) + allowRDPShortPathWithPrivateLink?: AllowRDPShortPathWithPrivateLink; } /** diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/desktopvirtualization.json new file mode 100644 index 000000000000..f2889596925f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/desktopvirtualization.json @@ -0,0 +1,12251 @@ +{ + "swagger": "2.0", + "info": { + "title": "Desktop Virtualization API Client", + "version": "2025-08-01-preview", + "description": "This Typespec represents the Desktop Virtualization API interfaces.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AppAttachPackages" + }, + { + "name": "StartMenuItems" + }, + { + "name": "ApplicationGroups" + }, + { + "name": "AppAttachPackageInfo" + }, + { + "name": "MSIXImages" + }, + { + "name": "PrivateLinkResources" + }, + { + "name": "HostPools" + }, + { + "name": "ScalingPlans" + }, + { + "name": "Workspaces" + }, + { + "name": "Applications" + }, + { + "name": "Desktops" + }, + { + "name": "CustomPrivateEndpointConnection" + }, + { + "name": "SessionHosts" + }, + { + "name": "UserSessions" + }, + { + "name": "ScalingPlanPersonalSchedules" + }, + { + "name": "ScalingPlanPooledSchedules" + }, + { + "name": "MSIXPackages" + }, + { + "name": "ActiveSessionHostConfigurations" + }, + { + "name": "InitiateSessionHostUpdate" + }, + { + "name": "ControlSessionHostUpdate" + }, + { + "name": "SessionHostManagement" + }, + { + "name": "SessionHostManagements" + }, + { + "name": "SessionHostConfigurations" + }, + { + "name": "SessionHostManagementUpdateStatuses" + } + ], + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Provider Operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "operationId": "AppAttachPackage_ListBySubscription", + "tags": [ + "AppAttachPackages" + ], + "description": "List App Attach packages in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are package name, host pool, and resource group.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_ListBySubscription": { + "$ref": "./examples/AppAttachPackage_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "operationId": "ApplicationGroups_ListBySubscription", + "tags": [ + "ApplicationGroups" + ], + "description": "List applicationGroups in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "operationId": "HostPools_List", + "tags": [ + "HostPools" + ], + "description": "List hostPools in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_Lists.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "operationId": "ScalingPlans_ListBySubscription", + "tags": [ + "ScalingPlans" + ], + "description": "List scaling plans in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_ListBySubscription": { + "$ref": "./examples/ScalingPlans_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "operationId": "Workspaces_ListBySubscription", + "tags": [ + "Workspaces" + ], + "description": "List workspaces in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_ListBySubscription": { + "$ref": "./examples/Workspaces_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "operationId": "AppAttachPackage_ListByResourceGroup", + "tags": [ + "AppAttachPackages" + ], + "description": "List App Attach packages in resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are package name and host pool.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_ListByResourceGroup": { + "$ref": "./examples/AppAttachPackage_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}": { + "get": { + "operationId": "AppAttachPackage_Get", + "tags": [ + "AppAttachPackages" + ], + "description": "Get an app attach package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Get": { + "$ref": "./examples/AppAttachPackage_Get.json" + } + } + }, + "put": { + "operationId": "AppAttachPackage_CreateOrUpdate", + "tags": [ + "AppAttachPackages" + ], + "description": "Create or update an App Attach package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + }, + { + "name": "appAttachPackage", + "in": "body", + "description": "Object containing App Attach Package definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AppAttachPackage' update operation succeeded", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "201": { + "description": "Resource 'AppAttachPackage' create operation succeeded", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Create": { + "$ref": "./examples/AppAttachPackage_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "AppAttachPackage_Update", + "tags": [ + "AppAttachPackages" + ], + "description": "Update an App Attach Package", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + }, + { + "name": "appAttachPackagePatch", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/AppAttachPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Update": { + "$ref": "./examples/AppAttachPackage_Update.json" + } + } + }, + "delete": { + "operationId": "AppAttachPackage_Delete", + "tags": [ + "AppAttachPackages" + ], + "description": "Remove an App Attach Package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + }, + { + "name": "force", + "in": "query", + "description": "Allows force delete", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Delete": { + "$ref": "./examples/AppAttachPackage_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "operationId": "ApplicationGroups_ListByResourceGroup", + "tags": [ + "ApplicationGroups" + ], + "description": "List applicationGroups.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "operationId": "ApplicationGroups_Get", + "tags": [ + "ApplicationGroups" + ], + "description": "Get an application group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroups_Get.json" + } + } + }, + "put": { + "operationId": "ApplicationGroups_CreateOrUpdate", + "tags": [ + "ApplicationGroups" + ], + "description": "Create or update an applicationGroup.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationGroup", + "in": "body", + "description": "Object containing ApplicationGroup definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApplicationGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Resource 'ApplicationGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroups_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "ApplicationGroups_Update", + "tags": [ + "ApplicationGroups" + ], + "description": "Update an applicationGroup.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationGroup", + "in": "body", + "description": "The AppGroup properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_Update": { + "$ref": "./examples/ApplicationGroups_Update.json" + } + } + }, + "delete": { + "operationId": "ApplicationGroups_Delete", + "tags": [ + "ApplicationGroups" + ], + "description": "Remove an applicationGroup.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroups_Delete": { + "$ref": "./examples/ApplicationGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "operationId": "Applications_List", + "tags": [ + "Applications" + ], + "description": "List applications.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Applications_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "operationId": "Applications_Get", + "tags": [ + "Applications" + ], + "description": "Get an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_Get": { + "$ref": "./examples/Applications_Get.json" + } + } + }, + "put": { + "operationId": "Applications_CreateOrUpdate", + "tags": [ + "Applications" + ], + "description": "Create or update an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "application", + "in": "body", + "description": "Object containing Application definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Application' update operation succeeded", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Resource 'Application' create operation succeeded", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_CreateOrUpdate": { + "$ref": "./examples/Applications_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Applications_Update", + "tags": [ + "Applications" + ], + "description": "Update an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "application", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_Update": { + "$ref": "./examples/Applications_Update.json" + } + } + }, + "delete": { + "operationId": "Applications_Delete", + "tags": [ + "Applications" + ], + "description": "Remove an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_Delete": { + "$ref": "./examples/Applications_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "operationId": "Desktops_List", + "tags": [ + "Desktops" + ], + "description": "List desktops.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Desktops_List": { + "$ref": "./examples/Desktops_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "operationId": "Desktops_Get", + "tags": [ + "Desktops" + ], + "description": "Get a desktop.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "desktopName", + "in": "path", + "description": "The name of the desktop within the specified desktop group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Desktops_Get": { + "$ref": "./examples/Desktops_Get.json" + } + } + }, + "patch": { + "operationId": "Desktops_Update", + "tags": [ + "Desktops" + ], + "description": "Update a desktop.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "desktopName", + "in": "path", + "description": "The name of the desktop within the specified desktop group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "desktop", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Desktops_Update": { + "$ref": "./examples/Desktops_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "operationId": "StartMenuItems_List", + "tags": [ + "StartMenuItems" + ], + "description": "List start menu items in the given application group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StartMenuItems_List": { + "$ref": "./examples/StartMenuItems_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "operationId": "HostPools_ListByResourceGroup", + "tags": [ + "HostPools" + ], + "description": "List hostPools.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_ListByResourceGroup": { + "$ref": "./examples/HostPools_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "operationId": "HostPools_Get", + "tags": [ + "HostPools" + ], + "description": "Get a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_Get": { + "$ref": "./examples/HostPools_Get.json" + } + } + }, + "put": { + "operationId": "HostPools_CreateOrUpdate", + "tags": [ + "HostPools" + ], + "description": "Create or update a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPool", + "in": "body", + "description": "Object containing HostPool definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HostPool' update operation succeeded", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Resource 'HostPool' create operation succeeded", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_CreateOrUpdate": { + "$ref": "./examples/HostPool_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "HostPools_Update", + "tags": [ + "HostPools" + ], + "description": "Update a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPool", + "in": "body", + "description": "The properties to be updated.", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_Update": { + "$ref": "./examples/HostPools_Update.json" + } + } + }, + "delete": { + "operationId": "HostPools_Delete", + "tags": [ + "HostPools" + ], + "description": "Remove a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "force", + "in": "query", + "description": "Force flag to delete sessionHost.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_Delete": { + "$ref": "./examples/HostPools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations": { + "get": { + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "tags": [ + "ActiveSessionHostConfigurations" + ], + "description": "Operation to list the ActiveSessionHostConfigurations associated with the HostPool", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfigurationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActiveSessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/ActiveSessionHostConfigurations_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default": { + "get": { + "operationId": "ActiveSessionHostConfigurations_Get", + "tags": [ + "ActiveSessionHostConfigurations" + ], + "description": "Get a ActiveSessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActiveSessionHostConfigurations_Get": { + "$ref": "./examples/ActiveSessionHostConfigurations_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage": { + "post": { + "operationId": "MsixImages_Expand", + "tags": [ + "MSIXImages" + ], + "description": "Expands and Lists MSIX packages in an Image, given the Image Path.\nThis action uses incorrect Msix casing intentionally to match the previous APIs.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixImageURI", + "in": "body", + "description": "Represents URI referring to MSIX Image", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXImageURI" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExpandMsixImageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MsixImages_Expand": { + "$ref": "./examples/MsixImages_Expand.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo": { + "post": { + "operationId": "AppAttachPackageInfo_Import", + "tags": [ + "AppAttachPackageInfo" + ], + "description": "Gets information from a package given the path to the package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "importPackageInfoRequest", + "in": "body", + "description": "Information to import app attach package", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPackageInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackageInfo_Import": { + "$ref": "./examples/AppAttachPackageInfo_Import.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens": { + "post": { + "operationId": "HostPools_ListRegistrationTokens", + "tags": [ + "HostPools" + ], + "description": "Operation to list the RegistrationTokens associated with the HostPool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RegistrationTokenList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_ListRegistrationTokens": { + "$ref": "./examples/HostPools_ListRegistrationTokens.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages": { + "get": { + "operationId": "MSIXPackages_List", + "tags": [ + "MSIXPackages" + ], + "description": "List MSIX packages in hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/MSIXPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_List": { + "$ref": "./examples/MSIXPackages_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}": { + "get": { + "operationId": "MSIXPackages_Get", + "tags": [ + "MSIXPackages" + ], + "description": "Get a msixpackage.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_Get": { + "$ref": "./examples/MSIXPackages_Get.json" + } + } + }, + "put": { + "operationId": "MSIXPackages_CreateOrUpdate", + "tags": [ + "MSIXPackages" + ], + "description": "Create or update a MSIX package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackage", + "in": "body", + "description": "Object containing MSIX Package definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MSIXPackage' update operation succeeded", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "201": { + "description": "Resource 'MSIXPackage' create operation succeeded", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_Create": { + "$ref": "./examples/MSIXPackages_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "MSIXPackages_Update", + "tags": [ + "MSIXPackages" + ], + "description": "Update an MSIX Package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackage", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackage_Update": { + "$ref": "./examples/MSIXPackages_Update.json" + } + } + }, + "delete": { + "operationId": "MSIXPackages_Delete", + "tags": [ + "MSIXPackages" + ], + "description": "Remove an MSIX Package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_Delete": { + "$ref": "./examples/MSIXPackages_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "List private endpoint connections associated with hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_GetByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Get a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_GetByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_GetByHostPool.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Approve or reject a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + }, + { + "name": "connection", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionWithSystemData' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_UpdateByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_UpdateByHostPool.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Delete a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_DeleteByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_DeleteByHostPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResources_ListByHostPool", + "tags": [ + "PrivateLinkResources" + ], + "description": "List the private link resources available for this hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByHostPool": { + "$ref": "./examples/PrivateLinkResources_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken": { + "post": { + "operationId": "HostPools_RetrieveRegistrationToken", + "tags": [ + "HostPools" + ], + "description": "Registration token of the host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RegistrationInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_RetrieveRegistrationToken": { + "$ref": "./examples/HostPools_RetrieveRegistrationToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans": { + "get": { + "operationId": "ScalingPlans_ListByHostPool", + "tags": [ + "ScalingPlans" + ], + "description": "List scaling plan associated with hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_ListByHostPool": { + "$ref": "./examples/ScalingPlans_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations": { + "get": { + "operationId": "SessionHostConfigurations_ListByHostPool", + "tags": [ + "SessionHostConfigurations" + ], + "description": "List SessionHostConfigurations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostConfigurations_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default": { + "get": { + "operationId": "SessionHostConfigurations_Get", + "tags": [ + "SessionHostConfigurations" + ], + "description": "Get a SessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/SessionHostConfigurations_Get.json" + } + } + }, + "put": { + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "tags": [ + "SessionHostConfigurations" + ], + "description": "Create or update a SessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostConfiguration", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SessionHostConfiguration' update operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "201": { + "description": "Resource 'SessionHostConfiguration' create operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_Create": { + "$ref": "./examples/SessionHostConfigurations_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SessionHostConfigurations_Update", + "tags": [ + "SessionHostConfigurations" + ], + "description": "Update a SessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostConfiguration", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostConfigurationPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_Update": { + "$ref": "./examples/SessionHostConfigurations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements": { + "get": { + "operationId": "SessionHostManagements_ListByHostPool", + "tags": [ + "SessionHostManagements" + ], + "description": "List SessionHostManagements.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostManagementList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_ListByHostPool": { + "$ref": "./examples/SessionHostManagements_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default": { + "get": { + "operationId": "SessionHostManagements_Get", + "tags": [ + "SessionHostManagements" + ], + "description": "Get a SessionHostManagement.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_Get": { + "$ref": "./examples/SessionHostManagements_Get.json" + } + } + }, + "put": { + "operationId": "SessionHostManagements_CreateOrUpdate", + "tags": [ + "SessionHostManagements" + ], + "description": "Create or update a SessionHostManagement.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostManagement", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SessionHostManagement' update operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "201": { + "description": "Resource 'SessionHostManagement' create operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_Create": { + "$ref": "./examples/SessionHostManagements_Create.json" + } + } + }, + "patch": { + "operationId": "SessionHostManagements_Update", + "tags": [ + "SessionHostManagements" + ], + "description": "Update a SessionHostManagement.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostManagement", + "in": "body", + "description": "The properties to be updated.", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostManagementPatch" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_Update": { + "$ref": "./examples/SessionHostManagements_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostProvisioning": { + "post": { + "operationId": "ControlSessionHostProvisioning_Post", + "tags": [ + "SessionHostManagement" + ], + "description": "Control provisioning of a hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPoolProvisioningControlParameter", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolProvisioningControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_ControlSessionHostProvisioning_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate": { + "post": { + "operationId": "ControlSessionHostUpdate_Post", + "tags": [ + "ControlSessionHostUpdate" + ], + "description": "Control actions on a session host update.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPoolUpdateControlParameter", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolUpdateControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_ControlSessionHostUpdate_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostUpdate_Post.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate": { + "post": { + "operationId": "InitiateSessionHostUpdate_Post", + "tags": [ + "InitiateSessionHostUpdate" + ], + "description": "Initiates a hostpool update or schedule an update for the future.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "updateSessionHostsRequestBody", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateSessionHostsRequestBody" + } + } + ], + "responses": { + "204": { + "description": "Azure operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_UpdateSessionHosts_Post": { + "$ref": "./examples/SessionHostManagements_UpdateSessionHosts_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostProvisioningStatuses/default": { + "get": { + "operationId": "SessionHostProvisioningStatuses_Get", + "tags": [ + "SessionHostManagement" + ], + "description": "Get the session host provisioning status for a given hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostManagementProvisioningStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_SessionHostProvisioningStatuses_Get": { + "$ref": "./examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default": { + "get": { + "operationId": "SessionHostManagementsUpdateStatus_Get", + "tags": [ + "SessionHostManagementUpdateStatuses" + ], + "description": "Get a SessionHostManagementUpdateStatus.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostManagementUpdateStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagementsUpdateStatus_Get": { + "$ref": "./examples/SessionHostManagementsUpdateStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "operationId": "SessionHosts_List", + "tags": [ + "SessionHosts" + ], + "description": "List sessionHosts.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "vmPath", + "in": "query", + "description": "The path to the VM.", + "required": false, + "type": "string", + "minLength": 3, + "maxLength": 1092, + "pattern": "^[A-Z][a-z][0-9][@./-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHosts_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "operationId": "SessionHosts_Get", + "tags": [ + "SessionHosts" + ], + "description": "Get a session host.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHosts_Get.json" + } + } + }, + "patch": { + "operationId": "SessionHosts_Update", + "tags": [ + "SessionHosts" + ], + "description": "Update a session host.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "force", + "in": "query", + "description": "Force flag to update assign, unassign or reassign personal desktop.", + "required": false, + "type": "boolean" + }, + { + "name": "sessionHost", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHosts_Update.json" + } + } + }, + "delete": { + "operationId": "SessionHosts_Delete", + "tags": [ + "SessionHosts" + ], + "description": "Remove a SessionHost.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "force", + "in": "query", + "description": "Force flag to force sessionHost deletion even when userSession exists.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHosts_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning": { + "post": { + "operationId": "SessionHosts_RetryProvisioning", + "tags": [ + "SessionHosts" + ], + "description": "Retry provisioning on a SessionHost.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHosts_RetryProvisioning_Post": { + "$ref": "./examples/SessionHost_RetryProvisioning_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "operationId": "UserSessions_List", + "tags": [ + "UserSessions" + ], + "description": "List userSessions.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSessions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "operationId": "UserSessions_Get", + "tags": [ + "UserSessions" + ], + "description": "Get a userSession.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSessions_Get": { + "$ref": "./examples/UserSession_Get.json" + } + } + }, + "delete": { + "operationId": "UserSessions_Delete", + "tags": [ + "UserSessions" + ], + "description": "Remove a userSession.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + }, + { + "name": "force", + "in": "query", + "description": "Force flag to login off userSession.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSessions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "operationId": "UserSessions_Disconnect", + "tags": [ + "UserSessions" + ], + "description": "Disconnect a userSession.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSessions_Disconnect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "operationId": "UserSessions_SendMessage", + "tags": [ + "UserSessions" + ], + "description": "Send a message to a user.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + }, + { + "name": "sendMessage", + "in": "body", + "description": "Represents message sent to a UserSession.", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSessions_SendMessage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "operationId": "UserSessions_ListByHostPool", + "tags": [ + "UserSessions" + ], + "description": "A synchronous resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSessions_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "operationId": "ScalingPlans_ListByResourceGroup", + "tags": [ + "ScalingPlans" + ], + "description": "List scaling plans.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_ListByResourceGroup": { + "$ref": "./examples/ScalingPlans_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}": { + "get": { + "operationId": "ScalingPlans_Get", + "tags": [ + "ScalingPlans" + ], + "description": "Get a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Get": { + "$ref": "./examples/ScalingPlans_Get.json" + } + } + }, + "put": { + "operationId": "ScalingPlans_Create", + "tags": [ + "ScalingPlans" + ], + "description": "Create or update a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlan", + "in": "body", + "description": "Object containing scaling plan definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ScalingPlan' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "201": { + "description": "Resource 'ScalingPlan' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Create": { + "$ref": "./examples/ScalingPlans_Create.json" + } + } + }, + "patch": { + "operationId": "ScalingPlans_Update", + "tags": [ + "ScalingPlans" + ], + "description": "Update a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlan", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Update": { + "$ref": "./examples/ScalingPlans_Update.json" + } + } + }, + "delete": { + "operationId": "ScalingPlans_Delete", + "tags": [ + "ScalingPlans" + ], + "description": "Remove a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Delete": { + "$ref": "./examples/ScalingPlans_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules": { + "get": { + "operationId": "ScalingPlanPersonalSchedules_List", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "List ScalingPlanPersonalSchedules.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_List": { + "$ref": "./examples/ScalingPlanPersonalSchedules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}": { + "get": { + "operationId": "ScalingPlanPersonalSchedules_Get", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Get a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Get": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Get.json" + } + } + }, + "put": { + "operationId": "ScalingPlanPersonalSchedules_Create", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Create or update a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ScalingPlanPersonalSchedule' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "201": { + "description": "Resource 'ScalingPlanPersonalSchedule' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Create": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Create.json" + } + } + }, + "patch": { + "operationId": "ScalingPlanPersonalSchedules_Update", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Update a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Update": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Update.json" + } + } + }, + "delete": { + "operationId": "ScalingPlanPersonalSchedules_Delete", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Remove a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Delete": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules": { + "get": { + "operationId": "ScalingPlanPooledSchedules_List", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "List ScalingPlanPooledSchedules.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledScheduleList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_List": { + "$ref": "./examples/ScalingPlanPooledSchedules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}": { + "get": { + "operationId": "ScalingPlanPooledSchedules_Get", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Get a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Get": { + "$ref": "./examples/ScalingPlanPooledSchedules_Get.json" + } + } + }, + "put": { + "operationId": "ScalingPlanPooledSchedules_Create", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Create or update a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ScalingPlanPooledSchedule' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "201": { + "description": "Resource 'ScalingPlanPooledSchedule' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Create": { + "$ref": "./examples/ScalingPlanPooledSchedules_Create.json" + }, + "ScalingPlanPooledSchedules_CreateUsingCreateDelete": { + "$ref": "./examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json" + } + } + }, + "patch": { + "operationId": "ScalingPlanPooledSchedules_Update", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Update a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Update": { + "$ref": "./examples/ScalingPlanPooledSchedules_Update.json" + } + } + }, + "delete": { + "operationId": "ScalingPlanPooledSchedules_Delete", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Remove a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Delete": { + "$ref": "./examples/ScalingPlanPooledSchedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "operationId": "Workspaces_ListByResourceGroup", + "tags": [ + "Workspaces" + ], + "description": "List workspaces.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "operationId": "Workspaces_Get", + "tags": [ + "Workspaces" + ], + "description": "Get a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspaces_Get.json" + } + } + }, + "put": { + "operationId": "Workspaces_CreateOrUpdate", + "tags": [ + "Workspaces" + ], + "description": "Create or update a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "workspace", + "in": "body", + "description": "Object containing Workspace definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Workspace' update operation succeeded", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Resource 'Workspace' create operation succeeded", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspaces_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Workspaces_Update", + "tags": [ + "Workspaces" + ], + "description": "Update a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "workspace", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspaces_Update.json" + } + } + }, + "delete": { + "operationId": "Workspaces_Delete", + "tags": [ + "Workspaces" + ], + "description": "Remove a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspaces_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "List private endpoint connections associated with Workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_ListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Get a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_GetByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_GetByWorkspace.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Approve or reject a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + }, + { + "name": "connection", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionWithSystemData' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_UpdateByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_UpdateByWorkspace.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Delete a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_DeleteByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_DeleteByWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResources_ListByWorkspace", + "tags": [ + "PrivateLinkResources" + ], + "description": "List the private link resources available for this workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByWorkspace": { + "$ref": "./examples/PrivateLinkResources_ListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ActiveDirectoryInfoPatchProperties": { + "type": "object", + "description": "Active directory info. Only one should be populated based on the join type", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Credentials needed to create the virtual machine." + } + } + }, + "ActiveDirectoryInfoProperties": { + "type": "object", + "description": "Active directory info. Only one should be populated based on the join type.", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Credentials needed to create the virtual machine." + }, + "ouPath": { + "type": "string", + "description": "The organizational unit(OU) path." + }, + "domainName": { + "type": "string", + "description": "The domain a virtual machine connected to a hostpool will join." + } + }, + "required": [ + "domainCredentials", + "ouPath" + ] + }, + "ActiveSessionHostConfiguration": { + "type": "object", + "description": "Schema for ActiveSessionHostConfiguration properties.", + "properties": { + "properties": { + "$ref": "#/definitions/ActiveSessionHostConfigurationProperties", + "description": "Detailed properties for ActiveSessionHostConfiguration", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ActiveSessionHostConfigurationList": { + "type": "object", + "description": "List of ActiveSessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ActiveSessionHostConfiguration items on this page", + "items": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ActiveSessionHostConfigurationProperties": { + "type": "object", + "description": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState", + "properties": { + "version": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "description": "Hashtable that lists key/value pair tags to apply to the VMs", + "additionalProperties": { + "type": "string" + } + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3].", + "items": { + "type": "integer", + "format": "int32" + } + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of the HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + }, + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ] + }, + "AgentUpdatePatchProperties": { + "type": "object", + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "properties": { + "type": { + "$ref": "#/definitions/SessionHostComponentUpdateType", + "description": "The type of maintenance for session host components." + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "AgentUpdateProperties": { + "type": "object", + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "properties": { + "type": { + "$ref": "#/definitions/SessionHostComponentUpdateType", + "description": "The type of maintenance for session host components." + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "AppAttachPackage": { + "type": "object", + "description": "Schema for App Attach Package properties.", + "properties": { + "properties": { + "$ref": "#/definitions/AppAttachPackageProperties", + "description": "Detailed properties for App Attach Package", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "AppAttachPackageArchitectures": { + "type": "string", + "description": "Possible device architectures that an app attach package can be configured for", + "enum": [ + "ARM", + "ARM64", + "x86", + "x64", + "Neutral", + "x86a64", + "ALL" + ], + "x-ms-enum": { + "name": "AppAttachPackageArchitectures", + "modelAsString": true, + "values": [ + { + "name": "ARM", + "value": "ARM", + "description": "ARM 32-bit" + }, + { + "name": "ARM64", + "value": "ARM64", + "description": "ARM 64-bit" + }, + { + "name": "x86", + "value": "x86", + "description": "32-bit x86" + }, + { + "name": "x64", + "value": "x64", + "description": "64-bit" + }, + { + "name": "Neutral", + "value": "Neutral", + "description": "Any architecture can be used" + }, + { + "name": "x86a64", + "value": "x86a64", + "description": "X86 Compiled Hybrid Portable Executable for ARM64" + }, + { + "name": "ALL", + "value": "ALL", + "description": "Select all listed applications, no filters" + } + ] + } + }, + "AppAttachPackageInfoProperties": { + "type": "object", + "description": "Schema for Import Package Information properties.", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of App Attach Package. Assigned at import time" + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share." + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml." + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name." + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml." + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal." + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed." + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool." + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies.", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [] + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Date Package was last updated, found in the appxmanifest.xml." + }, + "packageApplications": { + "type": "array", + "description": "List of package applications.", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [] + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml." + }, + "certificateExpiry": { + "type": "string", + "format": "date-time", + "description": "Date certificate expires, found in the appxmanifest.xml." + }, + "isPackageTimestamped": { + "$ref": "#/definitions/packageTimestamped", + "description": "Is package timestamped so it can ignore the certificate expiry date" + } + } + }, + "AppAttachPackageList": { + "type": "object", + "description": "List of App Attach Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "The AppAttachPackage items on this page", + "items": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AppAttachPackagePatch": { + "type": "object", + "description": "Schema for updatable App Attach Package properties.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AppAttachPackagePatchProperties", + "description": "Detailed properties for App Attach Package" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "AppAttachPackagePatchProperties": { + "type": "object", + "description": "Schema for patchable fields on an App Attach Package.", + "properties": { + "image": { + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "description": "Detailed properties for App Attach Package" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL path to certificate name located in keyVault" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/failHealthCheckOnStagingFailure", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "packageLookbackUrl": { + "type": "string", + "format": "uri", + "description": "Lookback url to third party control plane, is null for native app attach packages" + }, + "customData": { + "type": "string", + "description": "Field that can be populated with custom data and filtered on in list GET calls" + } + } + }, + "AppAttachPackageProperties": { + "type": "object", + "description": "Schema for App Attach Package properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the App Attach Package.", + "readOnly": true + }, + "image": { + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "description": "Detailed properties for App Attach Package" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL path to certificate name located in keyVault" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/failHealthCheckOnStagingFailure", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "packageOwnerName": { + "type": "string", + "description": "Specific name of package owner, is \"AppAttach\" for native app attach packages" + }, + "packageLookbackUrl": { + "type": "string", + "format": "uri", + "description": "Lookback url to third party control plane, is null for native app attach packages" + }, + "customData": { + "type": "string", + "description": "Field that can be populated with custom data and filtered on in list GET calls" + } + } + }, + "Application": { + "type": "object", + "description": "Schema for Application properties.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationProperties", + "description": "Detailed properties for Application", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationGroupProperties", + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "ApplicationGroupList": { + "type": "object", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ApplicationGroup items on this page", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ApplicationGroupPatchProperties", + "description": "ApplicationGroup properties that can be patched." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "ApplicationGroupPatchProperties": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupProperties": { + "type": "object", + "description": "Schema for ApplicationGroup properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of ApplicationGroup. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup." + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "$ref": "#/definitions/ApplicationGroupType", + "description": "Resource Type of ApplicationGroup." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + }, + "oboTenantId": { + "type": "string", + "description": "Tenant that the resource is being requested on behalf of." + } + }, + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ] + }, + "ApplicationGroupType": { + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true, + "values": [ + { + "name": "RemoteApp", + "value": "RemoteApp", + "description": "Application group is Remote and can launch individual applications without a Desktop." + }, + { + "name": "Desktop", + "value": "Desktop", + "description": "Application Group delivers a full expected Desktop experience" + } + ] + } + }, + "ApplicationList": { + "type": "object", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "The Application items on this page", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationPatchProperties", + "description": "Detailed properties for Application" + } + } + }, + "ApplicationPatchProperties": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "$ref": "#/definitions/CommandLineSetting", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications" + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications" + }, + "applicationType": { + "$ref": "#/definitions/RemoteApplicationType", + "description": "Resource Type of Application." + } + } + }, + "ApplicationProperties": { + "type": "object", + "description": "Schema for Application properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Application. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "applicationType": { + "$ref": "#/definitions/RemoteApplicationType", + "description": "Resource Type of Application.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "commandLineSetting": { + "$ref": "#/definitions/CommandLineSetting", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "iconHash": { + "type": "string", + "description": "Hash of the icon.", + "readOnly": true + }, + "iconContent": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array.", + "readOnly": true + } + }, + "required": [ + "commandLineSetting" + ] + }, + "ApplicationType": { + "type": "string", + "description": "Application type of application.", + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true, + "values": [ + { + "name": "RemoteApp", + "value": "RemoteApp", + "description": "Remote Applications (non-desktop)" + }, + { + "name": "Desktop", + "value": "Desktop", + "description": "Desktop Applications" + } + ] + } + }, + "AzureActiveDirectoryInfoProperties": { + "type": "object", + "description": "Azure Active directory info. Only one should be populated based on the join type", + "properties": { + "mdmProviderGuid": { + "type": "string", + "description": "The Mobile Device Management(MDM) guid." + } + }, + "required": [ + "mdmProviderGuid" + ] + }, + "BootDiagnosticsInfoPatchProperties": { + "type": "object", + "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", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and screenshot.

      If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + } + }, + "BootDiagnosticsInfoProperties": { + "type": "object", + "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", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and screenshot.

      If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + } + }, + "CanaryPolicy": { + "type": "string", + "description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation.", + "enum": [ + "Auto", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "CanaryPolicy", + "modelAsString": true, + "values": [ + { + "name": "Auto", + "value": "Auto", + "description": "Decided by service whether to provision Canary VM." + }, + { + "name": "Never", + "value": "Never", + "description": "Never provision Canary VM." + }, + { + "name": "Always", + "value": "Always", + "description": "Always provision Canary VM." + } + ] + } + }, + "CommandLineSetting": { + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true, + "values": [ + { + "name": "DoNotAllow", + "value": "DoNotAllow", + "description": "Cannot be launched with command line arguments." + }, + { + "name": "Allow", + "value": "Allow", + "description": "Can optionally be launched with command line arguments." + }, + { + "name": "Require", + "value": "Require", + "description": "Required to be launched with command line arguments." + } + ] + } + }, + "CreateDeleteProperties": { + "type": "object", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts.", + "properties": { + "rampUpMaximumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "x-nullable": true + }, + "rampUpMinimumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "maximum": 59, + "x-nullable": true + }, + "rampDownMaximumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "x-nullable": true + }, + "rampDownMinimumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "maximum": 59, + "x-nullable": true + } + }, + "x-nullable": true + }, + "CustomInfoPatchProperties": { + "type": "object", + "description": "Custom image information.", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the image." + } + } + }, + "CustomInfoProperties": { + "type": "object", + "description": "Custom image information.", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the image." + } + }, + "required": [ + "resourceId" + ] + }, + "DayOfWeek": { + "type": "string", + "description": "Day of the week. Modeled as string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "DeploymentScope": { + "type": "string", + "description": "DeploymentScope type for HostPool.", + "enum": [ + "Geographical", + "Regional" + ], + "x-ms-enum": { + "name": "DeploymentScope", + "modelAsString": true, + "values": [ + { + "name": "Geographical", + "value": "Geographical", + "description": "For geographical Broker and ArmProvider talking to Geographical SQL DB" + }, + { + "name": "Regional", + "value": "Regional", + "description": "For regional Broker and ArmProvider talking to regional SQL DB" + } + ] + } + }, + "Desktop": { + "type": "object", + "description": "Schema for Desktop properties.", + "properties": { + "properties": { + "$ref": "#/definitions/DesktopProperties", + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "DesktopList": { + "type": "object", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "The Desktop items on this page", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/DesktopPatchProperties", + "description": "Detailed properties for Desktop" + } + } + }, + "DesktopPatchProperties": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "DesktopProperties": { + "type": "object", + "description": "Schema for Desktop properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Desktop. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "type": "string", + "description": "Hash of the icon.", + "readOnly": true + }, + "iconContent": { + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array.", + "readOnly": true + } + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk settings for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOption", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local", + "description": "Operating system disk local setting." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Gets or sets specifies the ephemeral disk placement for operating system disk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'CacheDisk', 'ResourceDisk'.", + "enum": [ + "CacheDisk", + "ResourceDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "Cache disk placement" + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "Resource disk placement" + } + ] + } + }, + "DiffDiskProperties": { + "type": "object", + "description": "Specifies the ephemeral disk settings for the operating system disk used by the virtual machine.", + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Gets or sets specifies the ephemeral disk placement for operating system disk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'CacheDisk', 'ResourceDisk'." + } + } + }, + "DirectUDP": { + "type": "string", + "description": "Direct UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DirectUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "DiskInfoProperties": { + "type": "object", + "description": "Disk information.", + "properties": { + "managedDisk": { + "$ref": "#/definitions/ManagedDiskProperties", + "description": "The managed disk parameters." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskProperties", + "description": "Specifies the ephemeral disk settings for the operating system disk used by the virtual machine." + } + } + }, + "DomainInfoPatchProperties": { + "type": "object", + "description": "Domain configurations of session hosts.", + "properties": { + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoPatchProperties", + "description": "Active directory info. Only one should be populated based on the join type." + } + } + }, + "DomainInfoProperties": { + "type": "object", + "description": "Domain configurations of session hosts.", + "properties": { + "joinType": { + "$ref": "#/definitions/DomainJoinType", + "description": "The type of domain join done by the virtual machine." + }, + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoProperties", + "description": "Active directory info. Only one should be populated based on the join type." + }, + "azureActiveDirectoryInfo": { + "$ref": "#/definitions/AzureActiveDirectoryInfoProperties", + "description": "Azure active directory info. Only one should be populated based on the join type." + } + }, + "required": [ + "joinType" + ] + }, + "DomainJoinType": { + "type": "string", + "description": "The type of domain join done by the virtual machine.", + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true, + "values": [ + { + "name": "ActiveDirectory", + "value": "ActiveDirectory", + "description": "Using microsoft active directory." + }, + { + "name": "AzureActiveDirectory", + "value": "AzureActiveDirectory", + "description": "Using microsoft azure active directory." + } + ] + } + }, + "ExpandMsixImage": { + "type": "object", + "description": "Represents the definition of contents retrieved after expanding the MSIX Image.", + "properties": { + "properties": { + "$ref": "#/definitions/ExpandMsixImageProperties", + "description": "Detailed properties for ExpandMsixImage" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "ExpandMsixImageList": { + "type": "object", + "description": "List of MSIX package properties retrieved from MSIX Image expansion.", + "properties": { + "value": { + "type": "array", + "description": "The ExpandMsixImage items on this page", + "items": { + "$ref": "#/definitions/ExpandMsixImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ExpandMsixImageProperties": { + "type": "object", + "description": "Schema for Expand MSIX Image properties.", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of MSIX Package." + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share." + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml." + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name." + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml." + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal." + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed." + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool." + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies.", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [ + "dependencyName" + ] + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Date Package was last updated, found in the appxmanifest.xml." + }, + "packageApplications": { + "type": "array", + "description": "List of package applications.", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [ + "appId" + ] + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml." + }, + "certificateExpiry": { + "type": "string", + "format": "date-time", + "description": "Date certificate expires, found in the appxmanifest.xml." + } + } + }, + "FailedSessionHostCleanupPolicySHC": { + "type": "string", + "description": "The policy that should be applied when the Session Host provisioning operation fails.", + "enum": [ + "KeepAll", + "KeepOne", + "KeepNone" + ], + "x-ms-enum": { + "name": "FailedSessionHostCleanupPolicySHC", + "modelAsString": true, + "values": [ + { + "name": "KeepAll", + "value": "KeepAll", + "description": "Keep All." + }, + { + "name": "KeepOne", + "value": "KeepOne", + "description": "Keep One." + }, + { + "name": "KeepNone", + "value": "KeepNone", + "description": "Keep None." + } + ] + } + }, + "HealthCheckName": { + "type": "string", + "description": "Represents the name of the health check operation performed.", + "enum": [ + "DomainJoinedCheck", + "DomainTrustCheck", + "FSLogixHealthCheck", + "SxSStackListenerCheck", + "UrlsAccessibleCheck", + "MonitoringAgentCheck", + "DomainReachable", + "WebRTCRedirectorCheck", + "SupportedEncryptionCheck", + "MetaDataServiceCheck", + "AppAttachHealthCheck" + ], + "x-ms-enum": { + "name": "HealthCheckName", + "modelAsString": true, + "values": [ + { + "name": "DomainJoinedCheck", + "value": "DomainJoinedCheck", + "description": "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)" + }, + { + "name": "DomainTrustCheck", + "value": "DomainTrustCheck", + "description": "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)" + }, + { + "name": "FSLogixHealthCheck", + "value": "FSLogixHealthCheck", + "description": "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)" + }, + { + "name": "SxSStackListenerCheck", + "value": "SxSStackListenerCheck", + "description": "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)" + }, + { + "name": "UrlsAccessibleCheck", + "value": "UrlsAccessibleCheck", + "description": "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)" + }, + { + "name": "MonitoringAgentCheck", + "value": "MonitoringAgentCheck", + "description": "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)" + }, + { + "name": "DomainReachable", + "value": "DomainReachable", + "description": "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)" + }, + { + "name": "WebRTCRedirectorCheck", + "value": "WebRTCRedirectorCheck", + "description": "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)" + }, + { + "name": "SupportedEncryptionCheck", + "value": "SupportedEncryptionCheck", + "description": "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)" + }, + { + "name": "MetaDataServiceCheck", + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)" + }, + { + "name": "AppAttachHealthCheck", + "value": "AppAttachHealthCheck", + "description": "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual de-registration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)" + } + ] + } + }, + "HealthCheckResult": { + "type": "string", + "description": "Represents the Health state of the health check we performed.", + "enum": [ + "Unknown", + "HealthCheckSucceeded", + "HealthCheckFailed", + "SessionHostShutdown" + ], + "x-ms-enum": { + "name": "HealthCheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Health check result is not currently known." + }, + { + "name": "HealthCheckSucceeded", + "value": "HealthCheckSucceeded", + "description": "Health check passed." + }, + { + "name": "HealthCheckFailed", + "value": "HealthCheckFailed", + "description": "Health check failed." + }, + { + "name": "SessionHostShutdown", + "value": "SessionHostShutdown", + "description": "We received a Shutdown notification." + } + ] + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "properties": { + "properties": { + "$ref": "#/definitions/HostPoolProperties", + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "HostPoolList": { + "type": "object", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "The HostPool items on this page", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/HostPoolPatchProperties", + "description": "HostPool properties that can be patched." + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource.", + "x-nullable": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "HostPoolPatchProperties": { + "type": "object", + "description": "Properties of HostPool.", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "$ref": "#/definitions/PersonalDesktopAssignmentType", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "$ref": "#/definitions/LoadBalancerType", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "$ref": "#/definitions/SSOSecretType", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "$ref": "#/definitions/PreferredAppGroupType", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "publicNetworkAccess": { + "$ref": "#/definitions/HostpoolPublicNetworkAccess", + "description": "Enabled to allow this resource to be access from the public network" + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdatePatchProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "managedPrivateUDP": { + "$ref": "#/definitions/ManagedPrivateUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "directUDP": { + "$ref": "#/definitions/DirectUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "publicUDP": { + "$ref": "#/definitions/PublicUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "relayUDP": { + "$ref": "#/definitions/RelayUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + } + } + }, + "HostPoolProperties": { + "type": "object", + "description": "Properties of HostPool.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of HostPool. (internal use)", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "$ref": "#/definitions/HostPoolType", + "description": "HostPool type for desktop." + }, + "personalDesktopAssignmentType": { + "$ref": "#/definitions/PersonalDesktopAssignmentType", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "$ref": "#/definitions/LoadBalancerType", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "appAttachPackageReferences": { + "type": "array", + "description": "List of App Attach Package links.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "$ref": "#/definitions/SSOSecretType", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "$ref": "#/definitions/PreferredAppGroupType", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/HostpoolPublicNetworkAccess", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints" + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdateProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connection associated with the specified resource", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "managedPrivateUDP": { + "$ref": "#/definitions/ManagedPrivateUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "directUDP": { + "$ref": "#/definitions/DirectUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "publicUDP": { + "$ref": "#/definitions/PublicUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "relayUDP": { + "$ref": "#/definitions/RelayUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "managementType": { + "$ref": "#/definitions/ManagementType", + "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated." + }, + "deploymentScope": { + "$ref": "#/definitions/DeploymentScope", + "description": "DeploymentScope type for HostPool." + }, + "oboTenantId": { + "type": "string", + "description": "Tenant that the resource is being requested on behalf of." + } + }, + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ] + }, + "HostPoolProvisioningAction": { + "type": "string", + "description": "Action types for controlling hostpool provisioning.", + "enum": [ + "Cancel" + ], + "x-ms-enum": { + "name": "HostPoolProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "Cancel", + "value": "Cancel", + "description": "Cancel the hostpool provisioning." + } + ] + } + }, + "HostPoolProvisioningControlParameter": { + "type": "object", + "description": "Object containing control action for hostpool provisioning.", + "properties": { + "action": { + "$ref": "#/definitions/HostPoolProvisioningAction", + "description": "Action types for controlling hostpool update." + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host.", + "maxLength": 260 + } + }, + "required": [ + "action" + ] + }, + "HostPoolType": { + "type": "string", + "description": "HostPool type for desktop.", + "enum": [ + "Personal", + "Pooled", + "BYODesktop" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true, + "values": [ + { + "name": "Personal", + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + }, + { + "name": "Pooled", + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "name": "BYODesktop", + "value": "BYODesktop", + "description": "Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct." + } + ] + } + }, + "HostPoolUpdateAction": { + "type": "string", + "description": "Action types for controlling hostpool update.", + "enum": [ + "Start", + "Pause", + "Cancel", + "Retry", + "Resume" + ], + "x-ms-enum": { + "name": "HostPoolUpdateAction", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start the hostpool update." + }, + { + "name": "Pause", + "value": "Pause", + "description": "Pause the hostpool update." + }, + { + "name": "Cancel", + "value": "Cancel", + "description": "Cancel the hostpool update." + }, + { + "name": "Retry", + "value": "Retry", + "description": "Retry the hostpool update." + }, + { + "name": "Resume", + "value": "Resume", + "description": "Resume the hostpool update" + } + ] + } + }, + "HostPoolUpdateConfigurationPatchProperties": { + "type": "object", + "description": "The configurations of a hostpool update.", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "maxLength": 260 + } + } + }, + "HostPoolUpdateConfigurationProperties": { + "type": "object", + "description": "The configurations of a hostpool update.", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "default": "", + "maxLength": 260 + } + }, + "required": [ + "maxVmsRemoved", + "logOffDelayMinutes" + ] + }, + "HostPoolUpdateControlParameter": { + "type": "object", + "description": "Object containing control action for hostpool update.", + "properties": { + "action": { + "$ref": "#/definitions/HostPoolUpdateAction", + "description": "Action types for controlling hostpool update." + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'.", + "maxLength": 260 + } + }, + "required": [ + "action" + ] + }, + "HostpoolPublicNetworkAccess": { + "type": "string", + "description": "Enabled to allow this resource to be access from the public network", + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Allows this resource to be accessed from the public network" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Prevents this resource from being accessed from the public network" + }, + { + "name": "EnabledForSessionHostsOnly", + "value": "EnabledForSessionHostsOnly", + "description": "Allows SessionHosts to be accessed from the public network" + }, + { + "name": "EnabledForClientsOnly", + "value": "EnabledForClientsOnly", + "description": "Allows Clients to be accessed from the public network" + } + ] + } + }, + "ImageInfoPatchProperties": { + "type": "object", + "description": "Image configurations of session host in a HostPool", + "properties": { + "type": { + "$ref": "#/definitions/type", + "description": "The type of image session hosts use in the hostpool.", + "x-ms-client-name": "imageType" + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoPatchProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoPatchProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "ImageInfoProperties": { + "type": "object", + "description": "Image configurations of session host in a HostPool", + "properties": { + "type": { + "$ref": "#/definitions/type", + "description": "The type of image session hosts use in the hostpool.", + "x-ms-client-name": "imageType" + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + }, + "required": [ + "type" + ] + }, + "ImportPackageInfoRequest": { + "type": "object", + "description": "Information to import app attach package", + "properties": { + "path": { + "type": "string", + "description": "URI to Image" + }, + "packageArchitecture": { + "$ref": "#/definitions/AppAttachPackageArchitectures", + "description": "Possible device architectures that an app attach package can be configured for" + } + } + }, + "KeyVaultCredentialsPatchProperties": { + "type": "object", + "description": "Credentials kept in the keyvault.", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "KeyVaultCredentialsProperties": { + "type": "object", + "description": "Credentials kept in the keyvault.", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the password is stored in." + } + }, + "required": [ + "usernameKeyVaultSecretUri", + "passwordKeyVaultSecretUri" + ] + }, + "LoadBalancerType": { + "type": "string", + "description": "The type of the load balancer.", + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent", + "MultiplePersistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true, + "values": [ + { + "name": "BreadthFirst", + "value": "BreadthFirst", + "description": "Uses BreadthFirst algorithm for load balancing." + }, + { + "name": "DepthFirst", + "value": "DepthFirst", + "description": "Uses DepthFirst algorithm for load balancing." + }, + { + "name": "Persistent", + "value": "Persistent", + "description": "Maintains persistent connections." + }, + { + "name": "MultiplePersistent", + "value": "MultiplePersistent", + "description": "Maintains multiple persistents connections." + } + ] + } + }, + "LogSpecification": { + "type": "object", + "description": "Specifications of the Log for Azure Monitoring", + "properties": { + "name": { + "type": "string", + "description": "Name of the log" + }, + "displayName": { + "type": "string", + "description": "Localized friendly display name of the log" + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of the log" + } + } + }, + "MSIXImageURI": { + "type": "object", + "description": "Represents URI referring to MSIX Image", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "URI to Image" + } + } + }, + "MSIXPackage": { + "type": "object", + "description": "Schema for MSIX Package properties.", + "properties": { + "properties": { + "$ref": "#/definitions/MSIXPackageProperties", + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "MSIXPackageList": { + "type": "object", + "description": "List of MSIX Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "The MSIXPackage items on this page", + "items": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MSIXPackagePatch": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/MSIXPackagePatchProperties", + "description": "Detailed properties for MSIX Package" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "MSIXPackagePatchProperties": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "properties": { + "isActive": { + "type": "boolean", + "description": "Set a version of the package to be active across hostpool." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Set Registration mode. Regular or Delayed." + }, + "displayName": { + "type": "string", + "description": "Display name for MSIX Package." + } + } + }, + "MSIXPackageProperties": { + "type": "object", + "description": "Schema for MSIX Package properties.", + "properties": { + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share." + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml." + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name." + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal." + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed." + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool." + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies.", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [ + "dependencyName" + ] + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Date Package was last updated, found in the appxmanifest.xml." + }, + "packageApplications": { + "type": "array", + "description": "List of package applications.", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [ + "appId" + ] + } + } + }, + "MaintenanceWindowPatchProperties": { + "type": "object", + "description": "Maintenance window starting hour and day of week.", + "properties": { + "hour": { + "type": "integer", + "format": "int32", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of the week." + } + } + }, + "MaintenanceWindowProperties": { + "type": "object", + "description": "Maintenance window starting hour and day of week.", + "properties": { + "hour": { + "type": "integer", + "format": "int32", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of the week." + } + } + }, + "ManagedDiskProperties": { + "type": "object", + "description": "Managed Disk information.", + "properties": { + "type": { + "$ref": "#/definitions/VirtualMachineDiskType", + "description": "Managed Disk information." + } + } + }, + "ManagedPrivateUDP": { + "type": "string", + "description": "Managed Private UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedPrivateUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "ManagementType": { + "type": "string", + "description": "The type of management for the hostpool", + "enum": [ + "Automated", + "Standard" + ], + "x-ms-enum": { + "name": "ManagementType", + "modelAsString": true, + "values": [ + { + "name": "Automated", + "value": "Automated", + "description": "Automated management of the hostpool" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard management of the hostpool" + } + ] + } + }, + "MarketplaceInfoPatchProperties": { + "type": "object", + "description": "Marketplace image information.", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The SKU of the image." + }, + "exactVersion": { + "type": "string", + "description": "The version of the image." + } + } + }, + "MarketplaceInfoProperties": { + "type": "object", + "description": "Marketplace image information.", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The SKU of the image." + }, + "exactVersion": { + "type": "string", + "description": "The version of the image." + } + }, + "required": [ + "offer", + "publisher", + "sku", + "exactVersion" + ] + }, + "MsixPackageApplications": { + "type": "object", + "description": "Schema for MSIX Package Application properties.", + "properties": { + "appId": { + "type": "string", + "description": "Package Application Id, found in appxmanifest.xml." + }, + "description": { + "type": "string", + "description": "Description of Package Application." + }, + "appUserModelID": { + "type": "string", + "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name." + }, + "iconImageName": { + "type": "string", + "description": "User friendly name." + }, + "rawIcon": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + }, + "rawPng": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "MsixPackageDependencies": { + "type": "object", + "description": "Schema for MSIX Package Dependencies properties.", + "properties": { + "dependencyName": { + "type": "string", + "description": "Name of package dependency." + }, + "publisher": { + "type": "string", + "description": "Name of dependency publisher." + }, + "minVersion": { + "type": "string", + "description": "Dependency version required." + } + } + }, + "NetworkInfoPatchProperties": { + "type": "object", + "description": "Network information.", + "properties": { + "subnetId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)." + } + } + }, + "NetworkInfoProperties": { + "type": "object", + "description": "Network information.", + "properties": { + "subnetId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)." + } + }, + "required": [ + "subnetId" + ] + }, + "OperationProperties": { + "type": "object", + "description": "Properties of the operation", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification payload" + } + } + }, + "PersonalDesktopAssignmentType": { + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatically assigns an available personal desktop to the user." + }, + { + "name": "Direct", + "value": "Direct", + "description": "Manually assigns a specific personal desktop to the user." + } + ] + } + }, + "PreferredAppGroupType": { + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Internal Use Only" + }, + { + "name": "Desktop", + "value": "Desktop", + "description": "Use Desktop Application Group" + }, + { + "name": "RailApplications", + "value": "RailApplications", + "description": "Use RailApplications (RemoteApp)" + } + ] + } + }, + "PrivateEndpoint": { + "type": "object", + "description": "The private endpoint resource.", + "properties": { + "id": { + "type": "string", + "description": "The ARM identifier for private endpoint.", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "The private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "PrivateEndpointConnectionListResultWithSystemData": { + "type": "object", + "description": "List of private endpoint connection associated with the specified HostPool", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnectionWithSystemData items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of the private endpoint connection.", + "properties": { + "groupIds": { + "type": "array", + "description": "The group ids for the private endpoint resource.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource.", + "readOnly": true + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning was successful" + }, + { + "name": "Creating", + "value": "Creating", + "description": "A PrivateEndpointConnection is being created" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "A PrivateEndpointConnection is being deleted" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning failed" + } + ] + }, + "readOnly": true + }, + "PrivateEndpointConnectionWithSystemData": { + "type": "object", + "description": "The Private Endpoint Connection resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Connection is Pending" + }, + { + "name": "Approved", + "value": "Approved", + "description": "Connection was Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Connection was rejected" + } + ] + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A private link resource", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of a private link resource.", + "properties": { + "groupId": { + "type": "string", + "description": "The private link resource group id.", + "readOnly": true + }, + "requiredMembers": { + "type": "array", + "description": "The private link resource required member names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "description": "The private link resource Private link DNS zone name.", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "A collection of information about the state of the connection between service consumer and provider.", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning Successful" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning in Progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning Failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning was Canceled" + } + ] + }, + "readOnly": true + }, + "ProvisioningStateSHC": { + "type": "string", + "description": "Provisioning state of the Session Host Configuration.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningStateSHC", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning Successful" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning Failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning was Canceled" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning in Progress" + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Enabled to allow this resource to be access from the public network", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "This resource is accessible from the public network." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "This resource is not accessible from the public network." + } + ] + } + }, + "PublicUDP": { + "type": "string", + "description": "Public UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "RegistrationInfo": { + "type": "object", + "description": "Represents a RegistrationInfo definition.", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "$ref": "#/definitions/RegistrationTokenOperation", + "description": "The type of resetting the token." + } + } + }, + "RegistrationInfoPatch": { + "type": "object", + "description": "Represents a RegistrationInfo definition.", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiration time of registration token." + }, + "registrationTokenOperation": { + "$ref": "#/definitions/RegistrationTokenOperation", + "description": "The type of resetting the token." + } + } + }, + "RegistrationTokenList": { + "type": "object", + "description": "List of RegistrationToken definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of RegistrationToken definitions.", + "items": { + "$ref": "#/definitions/RegistrationTokenMinimal" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results.", + "readOnly": true + } + } + }, + "RegistrationTokenMinimal": { + "type": "object", + "description": "Represents a Minimal set of properties for RegistrationToken definition.", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + } + } + }, + "RegistrationTokenOperation": { + "type": "string", + "description": "The type of resetting the token.", + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "Delete operation" + }, + { + "name": "None", + "value": "None", + "description": "No Operation" + }, + { + "name": "Update", + "value": "Update", + "description": "Update Operation" + } + ] + } + }, + "RelayUDP": { + "type": "string", + "description": "Relay UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "RelayUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "RemoteApplicationType": { + "type": "string", + "description": "Resource Type of Application.", + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true, + "values": [ + { + "name": "InBuilt", + "value": "InBuilt", + "description": "Built-in applications" + }, + { + "name": "MsixApplication", + "value": "MsixApplication", + "description": "Imported MSIX application packages" + } + ] + } + }, + "ResourceProviderOperation": { + "type": "object", + "description": "Supported operation of this resource provider.", + "properties": { + "name": { + "type": "string", + "description": "Operation name, in format of {provider}/{resource}/{operation}" + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplay", + "description": "Display metadata associated with the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Is a data action." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "ResourceProviderOperationDisplay": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Resource provider: Microsoft Desktop Virtualization." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "Type of operation: get, read, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of this operation." + } + } + }, + "ResourceProviderOperationListResult": { + "type": "object", + "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceProviderOperation items on this page", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SSOSecretType": { + "type": "string", + "description": "The type of single sign on Secret Type.", + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true, + "values": [ + { + "name": "SharedKey", + "value": "SharedKey", + "description": "The SSO Secret is a Shared Key." + }, + { + "name": "Certificate", + "value": "Certificate", + "description": "The SSO Secret is a Certificate." + }, + { + "name": "SharedKeyInKeyVault", + "value": "SharedKeyInKeyVault", + "description": "The SSO Secret is a SharedKey that is stored in KeyVault." + }, + { + "name": "CertificateInKeyVault", + "value": "CertificateInKeyVault", + "description": "The SSO Secret is a Certificate that is stored in KeyVault." + } + ] + } + }, + "ScalingHostPoolReference": { + "type": "object", + "description": "Scaling plan reference to hostpool.", + "properties": { + "hostPoolArmPath": { + "type": "string", + "description": "Arm path of referenced hostpool." + }, + "scalingPlanEnabled": { + "type": "boolean", + "description": "Is the scaling plan enabled for this hostpool." + } + } + }, + "ScalingMethodType": { + "type": "string", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool.", + "enum": [ + "PowerManage", + "CreateDeletePowerManage" + ], + "x-ms-enum": { + "name": "ScalingMethodType", + "modelAsString": true, + "values": [ + { + "name": "PowerManage", + "value": "PowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size." + }, + { + "name": "CreateDeletePowerManage", + "value": "CreateDeletePowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, as well as creating and deleting hosts that will change the host pool size. This requires the createDelete property to be set, and the assigned hostpool to have a session host config property." + } + ] + } + }, + "ScalingPlan": { + "type": "object", + "description": "Represents a scaling plan definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanProperties", + "description": "Detailed properties for scaling plan.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "ScalingPlanList": { + "type": "object", + "description": "List of scaling plan definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ScalingPlan items on this page", + "items": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScalingPlanPatch": { + "type": "object", + "description": "Scaling plan properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ScalingPlanPatchProperties", + "description": "Detailed properties for scaling plan" + } + } + }, + "ScalingPlanPatchProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + }, + "x-ms-identifiers": [ + "hostPoolArmPath" + ] + } + } + }, + "ScalingPlanPersonalSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPersonalSchedule definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties", + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ScalingPlanPersonalScheduleList": { + "type": "object", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ScalingPlanPersonalSchedule items on this page", + "items": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScalingPlanPersonalSchedulePatch": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatchProperties", + "description": "Detailed properties for ScalingPlanPersonalSchedule" + } + } + }, + "ScalingPlanPersonalSchedulePatchProperties": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "$ref": "#/definitions/StartupBehavior", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampUpActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.", + "minimum": 0 + }, + "rampUpActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.", + "minimum": 0 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "peakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.", + "minimum": 0 + }, + "peakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.", + "minimum": 0 + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampDownActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.", + "minimum": 0 + }, + "rampDownActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.", + "minimum": 0 + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "offPeakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.", + "minimum": 0 + }, + "offPeakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.", + "minimum": 0 + } + } + }, + "ScalingPlanPersonalScheduleProperties": { + "type": "object", + "description": "A ScalingPlanPersonalSchedule.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "$ref": "#/definitions/StartupBehavior", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampUpActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.", + "minimum": 0 + }, + "rampUpActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.", + "minimum": 0 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "peakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.", + "minimum": 0 + }, + "peakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.", + "minimum": 0 + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampDownActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.", + "minimum": 0 + }, + "rampDownActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.", + "minimum": 0 + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "offPeakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.", + "minimum": 0 + }, + "offPeakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.", + "minimum": 0 + } + } + }, + "ScalingPlanPooledSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPooledSchedule definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties", + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ScalingPlanPooledScheduleList": { + "type": "object", + "description": "List of ScalingPlanPooledSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ScalingPlanPooledSchedule items on this page", + "items": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScalingPlanPooledSchedulePatch": { + "type": "object", + "description": "ScalingPlanPooledSchedule properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatchProperties", + "description": "Detailed properties for ScalingPlanPooledSchedule" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "ScalingPlanPooledSchedulePatchProperties": { + "type": "object", + "description": "A ScalingPlanPooledSchedule that can be patched.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule", + "readOnly": true + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "scalingMethod": { + "$ref": "#/definitions/ScalingMethodType", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool." + }, + "createDelete": { + "$ref": "#/definitions/CreateDeleteProperties", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts." + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp up period.", + "minimum": 0, + "maximum": 100 + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp up period.", + "minimum": 1, + "maximum": 100 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp down period.", + "minimum": 0, + "maximum": 100 + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp down period.", + "minimum": 1, + "maximum": 100 + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "$ref": "#/definitions/StopHostsWhen", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanPooledScheduleProperties": { + "type": "object", + "description": "A ScalingPlanPooledSchedule.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule", + "readOnly": true + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "scalingMethod": { + "type": "string", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool.", + "default": "PowerManage", + "enum": [ + "PowerManage", + "CreateDeletePowerManage" + ], + "x-ms-enum": { + "name": "ScalingMethodType", + "modelAsString": true, + "values": [ + { + "name": "PowerManage", + "value": "PowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size." + }, + { + "name": "CreateDeletePowerManage", + "value": "CreateDeletePowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, as well as creating and deleting hosts that will change the host pool size. This requires the createDelete property to be set, and the assigned hostpool to have a session host config property." + } + ] + } + }, + "createDelete": { + "$ref": "#/definitions/CreateDeleteProperties", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts." + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp up period.", + "minimum": 0, + "maximum": 100 + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp up period.", + "minimum": 1, + "maximum": 100 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp down period.", + "minimum": 0, + "maximum": 100 + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp down period.", + "minimum": 1, + "maximum": 100 + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "$ref": "#/definitions/StopHostsWhen", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of scaling plan. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "hostPoolType": { + "type": "string", + "description": "HostPool type for desktop.", + "default": "Pooled", + "enum": [ + "Pooled", + "Personal" + ], + "x-ms-enum": { + "name": "ScalingHostPoolType", + "modelAsString": true, + "values": [ + { + "name": "Pooled", + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "name": "Personal", + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + } + ] + } + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + }, + "x-ms-identifiers": [ + "hostPoolArmPath" + ] + } + }, + "required": [ + "timeZone" + ] + }, + "ScalingSchedule": { + "type": "object", + "description": "A ScalingPlanPooledSchedule.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule." + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "scalingMethod": { + "type": "string", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool.", + "default": "PowerManage", + "enum": [ + "PowerManage", + "CreateDeletePowerManage" + ], + "x-ms-enum": { + "name": "ScalingMethodType", + "modelAsString": true, + "values": [ + { + "name": "PowerManage", + "value": "PowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size." + }, + { + "name": "CreateDeletePowerManage", + "value": "CreateDeletePowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, as well as creating and deleting hosts that will change the host pool size. This requires the createDelete property to be set, and the assigned hostpool to have a session host config property." + } + ] + } + }, + "createDelete": { + "$ref": "#/definitions/CreateDeleteProperties", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts." + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp up period.", + "minimum": 0, + "maximum": 100 + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp up period.", + "minimum": 1, + "maximum": 100 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp down period.", + "minimum": 0, + "maximum": 100 + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp down period.", + "minimum": 1, + "maximum": 100 + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "$ref": "#/definitions/StopHostsWhen", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "SecurityInfoPatchProperties": { + "type": "object", + "description": "Security Information.", + "properties": { + "type": { + "$ref": "#/definitions/VirtualMachineSecurityType", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTpm on the virtual machine." + } + } + }, + "SecurityInfoProperties": { + "type": "object", + "description": "Security Information.", + "properties": { + "type": { + "type": "string", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard.", + "default": "Standard", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot and vTpm" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + } + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTpm on the virtual machine." + } + } + }, + "SendMessage": { + "type": "object", + "description": "Represents message sent to a UserSession.", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "ServiceSpecification": { + "type": "object", + "description": "Service specification payload", + "properties": { + "logSpecifications": { + "type": "array", + "description": "Specifications of the Log for Azure Monitoring", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "SessionHandlingOperation": { + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp up period.", + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No action will be taken after disconnect" + }, + { + "name": "Deallocate", + "value": "Deallocate", + "description": "Session Host will be deallocated after disconnect" + }, + { + "name": "Hibernate", + "value": "Hibernate", + "description": "Session Host will hibernate after disconnect" + } + ] + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostProperties", + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "SessionHostComponentUpdateType": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "SessionHostConfiguration": { + "type": "object", + "description": "Schema for SessionHostConfiguration properties.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostConfigurationProperties", + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "SessionHostConfigurationList": { + "type": "object", + "description": "List of SessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "The SessionHostConfiguration items on this page", + "items": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionHostConfigurationPatch": { + "type": "object", + "description": "SessionHostConfiguration properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostConfigurationPatchProperties", + "description": "Detailed properties for SessionHostConfiguration" + } + } + }, + "SessionHostConfigurationPatchProperties": { + "type": "object", + "description": "Session host configurations of HostPool.", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "description": "Hashtable that lists key/value pair tags to apply to the VMs", + "additionalProperties": { + "type": "string" + } + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3].", + "items": { + "type": "integer", + "format": "int32" + } + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoPatchProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk Information" + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoPatchProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoPatchProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoPatchProperties", + "description": "Security Information" + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Local Admin credentials for session hosts.\"" + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoPatchProperties", + "description": "Boot Diagnostics Information" + } + } + }, + "SessionHostConfigurationProperties": { + "type": "object", + "description": "Session host configurations of HostPool.", + "properties": { + "version": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateSHC", + "description": "Provisioning state of the Session Host Configuration.", + "readOnly": true + }, + "vmTags": { + "type": "object", + "description": "Hashtable that lists key/value pair tags to apply to the VMs", + "additionalProperties": { + "type": "string" + } + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3].", + "items": { + "type": "integer", + "format": "int32" + } + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk Information" + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security Information" + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts.\"" + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics Information" + } + }, + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ] + }, + "SessionHostHealthCheckFailureDetails": { + "type": "object", + "description": "Contains details on the failure.", + "properties": { + "message": { + "type": "string", + "description": "Failure message: hints on what is wrong and how to recover.", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code corresponding for the failure.", + "readOnly": true + }, + "lastHealthCheckDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + } + } + }, + "SessionHostHealthCheckReport": { + "type": "object", + "description": "The report for session host information.", + "properties": { + "healthCheckName": { + "$ref": "#/definitions/HealthCheckName", + "description": "Represents the name of the health check operation performed.", + "readOnly": true + }, + "healthCheckResult": { + "$ref": "#/definitions/HealthCheckResult", + "description": "Represents the Health state of the health check we performed.", + "readOnly": true + }, + "additionalFailureDetails": { + "$ref": "#/definitions/SessionHostHealthCheckFailureDetails", + "description": "Additional detailed information on the failure.", + "readOnly": true + } + } + }, + "SessionHostList": { + "type": "object", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "The SessionHost items on this page", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionHostLoadBalancingAlgorithm": { + "type": "string", + "description": "Load balancing algorithm for ramp up period.", + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true, + "values": [ + { + "name": "BreadthFirst", + "value": "BreadthFirst", + "description": "Breadth First Algorithm for Load Balancing" + }, + { + "name": "DepthFirst", + "value": "DepthFirst", + "description": "Depth First Algorithm for Load Balancing" + } + ] + } + }, + "SessionHostManagement": { + "type": "object", + "description": "Schema for SessionHostManagement properties.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostManagementProperties", + "description": "Detailed properties for SessionHostManagement", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "SessionHostManagementList": { + "type": "object", + "description": "List of SessionHostManagement definitions.", + "properties": { + "value": { + "type": "array", + "description": "The SessionHostManagement items on this page", + "items": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionHostManagementOperationProgress": { + "type": "object", + "description": "SessionHostManagement Operation Progress information.", + "properties": { + "executionStartTime": { + "type": "string", + "format": "date-time", + "description": "Time that the sessionHostManagement operation was created." + }, + "totalSessionHosts": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts to be started in the sessionHostManagement operation." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement operation" + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement operation." + }, + "sessionHostsRollbackFailed": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts rollback failed in the sessionHostManagement operation." + } + } + }, + "SessionHostManagementPatch": { + "type": "object", + "description": "SessionHostManagement properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostManagementPatchProperties", + "description": "Detailed properties for SessionHostManagement" + } + } + }, + "SessionHostManagementPatchProperties": { + "type": "object", + "description": "Represents a SessionHostManagementPatch definition.", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "Parameters for a hostpool update." + }, + "provisioning": { + "$ref": "#/definitions/SessionHostProvisioningConfigurationPatchProperties", + "description": "Parameters that apply when session hosts are provisioned." + }, + "failedSessionHostCleanupPolicy": { + "$ref": "#/definitions/FailedSessionHostCleanupPolicySHC", + "description": "The policy that should be applied when the Session Host provisioning operation fails." + } + } + }, + "SessionHostManagementProperties": { + "type": "object", + "description": "Session Host Managements of HostPool.", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "Parameters for a hostpool update." + }, + "provisioning": { + "$ref": "#/definitions/SessionHostProvisioningConfigurationProperties", + "description": "Parameters that apply when session hosts are provisioned." + }, + "failedSessionHostCleanupPolicy": { + "$ref": "#/definitions/FailedSessionHostCleanupPolicySHC", + "description": "The policy that should be applied when the Session Host provisioning operation fails." + } + }, + "required": [ + "scheduledDateTimeZone", + "update" + ] + }, + "SessionHostManagementProvisioningOperationProgress": { + "type": "object", + "description": "SessionHostManagement Provisioning Operation Progress information.", + "properties": { + "executionStartTime": { + "type": "string", + "format": "date-time", + "description": "Time that the sessionHostManagement operation was created." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement provisioning operation" + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement provisioning operation." + }, + "finalSessionHostsCount": { + "type": "integer", + "format": "int32", + "description": "The final instance count of the host pool for this provisioning operation." + }, + "initialSessionHostsCount": { + "type": "integer", + "format": "int32", + "description": "The initial instance count of the host pool for this provisioning operation." + } + } + }, + "SessionHostManagementProvisioningOperationStatus": { + "type": "string", + "description": "Operation status for SessionHostManagementUpdate.", + "enum": [ + "Scheduled", + "ValidatingSessionHostProvisioning", + "Cancelling", + "ProvisioningSessionHosts", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "SessionHostManagementProvisioningOperationStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The operation is scheduled." + }, + { + "name": "ValidatingSessionHostProvisioning", + "value": "ValidatingSessionHostProvisioning", + "description": "The operation is currently validating the provisioning." + }, + { + "name": "Cancelling", + "value": "Cancelling", + "description": "Canceling the operation." + }, + { + "name": "ProvisioningSessionHosts", + "value": "ProvisioningSessionHosts", + "description": "The operation is currently provisioning session hosts." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation is canceled." + } + ] + }, + "readOnly": true + }, + "SessionHostManagementProvisioningStatus": { + "type": "object", + "description": "Schema for SessionHostManagementUpdateStatus properties.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ID for the async operation." + }, + "name": { + "type": "string", + "description": "Name of the async operation." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation." + }, + "error": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "description": "If present, details of the operation error." + }, + "status": { + "$ref": "#/definitions/SessionHostManagementProvisioningOperationStatus", + "description": "Operation status." + }, + "properties": { + "$ref": "#/definitions/SessionHostManagementProvisioningStatusProperties", + "description": "The custom properties of the SessionHost Provisioning Status." + } + }, + "required": [ + "status" + ] + }, + "SessionHostManagementProvisioningStatusProperties": { + "type": "object", + "description": "Properties bag for sessionHostManagement Provisioning Statuses.", + "properties": { + "correlationId": { + "type": "string", + "description": "The correlation Id for Log Analytics." + }, + "progress": { + "$ref": "#/definitions/SessionHostManagementProvisioningOperationProgress", + "description": "Progress information on the sessionHostManagement operation." + }, + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "$ref": "#/definitions/SessionHostManagement", + "description": "SessionHostManagement properties used for the operation." + } + } + }, + "SessionHostManagementUpdateStatus": { + "type": "object", + "description": "Schema for SessionHostManagementUpdateStatus properties.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ID for the async operation." + }, + "name": { + "type": "string", + "description": "Name of the async operation." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation." + }, + "error": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "description": "If present, details of the operation error." + }, + "status": { + "$ref": "#/definitions/updateStatus", + "description": "Operation status. Current defined values are < Error | Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling > | Succeeded | Failed | Canceled" + }, + "properties": { + "$ref": "#/definitions/SessionHostManagementUpdateStatusProperties", + "description": "Properties bag for sessionHostManagement Update Statuses." + } + }, + "required": [ + "status" + ] + }, + "SessionHostManagementUpdateStatusProperties": { + "type": "object", + "description": "The current status of the session host update async operation.", + "properties": { + "correlationId": { + "type": "string", + "description": "The correlation Id for Log Analytics.." + }, + "progress": { + "$ref": "#/definitions/SessionHostManagementOperationProgress", + "description": "Progress information on the sessionHostManagement operation." + }, + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "$ref": "#/definitions/SessionHostManagement", + "description": "SessionHostManagement properties used for the operation." + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostPatchProperties", + "description": "Detailed properties for SessionHost" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "SessionHostPatchProperties": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + } + } + }, + "SessionHostProperties": { + "type": "object", + "description": "Schema for SessionHost properties.", + "properties": { + "activeSessions": { + "type": "integer", + "format": "int32", + "description": "Number of active sessions on SessionHost." + }, + "disconnectedSessions": { + "type": "integer", + "format": "int32", + "description": "Number of disconnected sessions on SessionHost." + }, + "pendingSessions": { + "type": "integer", + "format": "int32", + "description": "Number of pending sessions on SessionHost." + }, + "objectId": { + "type": "string", + "description": "ObjectId of SessionHost. (internal use)", + "readOnly": true + }, + "lastHeartBeat": { + "type": "string", + "format": "date-time", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "format": "int32", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "$ref": "#/definitions/UpdateState", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + }, + "lastSessionHostUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time update was completed.", + "readOnly": true + }, + "sessionHostConfiguration": { + "type": "string", + "description": "SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z", + "readOnly": true + }, + "sessionHostHealthCheckResults": { + "type": "array", + "description": "List of SessionHostHealthCheckReports", + "items": { + "$ref": "#/definitions/SessionHostHealthCheckReport" + }, + "readOnly": true, + "x-ms-identifiers": [ + "healthCheckName" + ] + } + } + }, + "SessionHostProvisioningConfigurationPatchProperties": { + "type": "object", + "description": "The configuration for session host provisioning operations.", + "properties": { + "setDrainMode": { + "type": "boolean", + "description": "Whether the session host should be set in drain mode following provisioning." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts to exist in the Host Pool.", + "minimum": 1 + }, + "canaryPolicy": { + "$ref": "#/definitions/CanaryPolicy", + "description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation." + } + } + }, + "SessionHostProvisioningConfigurationProperties": { + "type": "object", + "description": "The configuration for session host provisioning operations.", + "properties": { + "setDrainMode": { + "type": "boolean", + "description": "Whether the session host should be set in drain mode following provisioning." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts to exist in the Host Pool.", + "minimum": 1 + }, + "canaryPolicy": { + "$ref": "#/definitions/CanaryPolicy", + "description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation." + } + } + }, + "SessionState": { + "type": "string", + "description": "State of user session.", + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "SessionState is unknown" + }, + { + "name": "Active", + "value": "Active", + "description": "Session is active" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "Session is disconnected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "Session is pending connection" + }, + { + "name": "LogOff", + "value": "LogOff", + "description": "Session is logging off" + }, + { + "name": "UserProfileDiskMounted", + "value": "UserProfileDiskMounted", + "description": "Session has mounted user profile disk" + } + ] + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "properties": { + "properties": { + "$ref": "#/definitions/StartMenuItemProperties", + "description": "Detailed properties for StartMenuItem" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "StartMenuItemList": { + "type": "object", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "The StartMenuItem items on this page", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StartMenuItemProperties": { + "type": "object", + "description": "Schema for StartMenuItem properties.", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + } + } + }, + "StartupBehavior": { + "type": "string", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool.", + "enum": [ + "None", + "WithAssignedUser", + "All" + ], + "x-ms-enum": { + "name": "StartupBehavior", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts." + }, + { + "name": "WithAssignedUser", + "value": "WithAssignedUser", + "description": "Session hosts with an assigned user will be started during Ramp Up" + }, + { + "name": "All", + "value": "All", + "description": "All personal session hosts in the hostpool will be started during ramp up." + } + ] + } + }, + "Status": { + "type": "string", + "description": "Status for a SessionHost.", + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed", + "NoHeartbeat", + "NotJoinedToDomain", + "DomainTrustRelationshipLost", + "SxSStackListenerNotReady", + "FSLogixNotHealthy", + "NeedsAssistance" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available", + "description": "Session Host has passed all the health checks and is available to handle connections." + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status." + }, + { + "name": "Shutdown", + "value": "Shutdown", + "description": "Session Host is shutdown - RD Agent reported session host to be stopped or deallocated." + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "The Session Host is unavailable because it is currently disconnected." + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections." + }, + { + "name": "UpgradeFailed", + "value": "UpgradeFailed", + "description": "Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed." + }, + { + "name": "NoHeartbeat", + "value": "NoHeartbeat", + "description": "The Session Host is not heart beating." + }, + { + "name": "NotJoinedToDomain", + "value": "NotJoinedToDomain", + "description": "SessionHost is not joined to domain." + }, + { + "name": "DomainTrustRelationshipLost", + "value": "DomainTrustRelationshipLost", + "description": "SessionHost's domain trust relationship lost" + }, + { + "name": "SxSStackListenerNotReady", + "value": "SxSStackListenerNotReady", + "description": "SxS stack installed on the SessionHost is not ready to receive connections." + }, + { + "name": "FSLogixNotHealthy", + "value": "FSLogixNotHealthy", + "description": "FSLogix is in an unhealthy state on the session host." + }, + { + "name": "NeedsAssistance", + "value": "NeedsAssistance", + "description": "New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal." + } + ] + } + }, + "StopHostsWhen": { + "type": "string", + "description": "Specifies when to stop hosts during ramp down period.", + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true, + "values": [ + { + "name": "ZeroSessions", + "value": "ZeroSessions", + "description": "Zero Total Sessions" + }, + { + "name": "ZeroActiveSessions", + "value": "ZeroActiveSessions", + "description": "Zero Active Sessions" + } + ] + } + }, + "Time": { + "type": "object", + "description": "The time for a scaling action to occur.", + "properties": { + "hour": { + "type": "integer", + "format": "int32", + "description": "The hour.", + "minimum": 0, + "maximum": 23 + }, + "minute": { + "type": "integer", + "format": "int32", + "description": "The minute.", + "minimum": 0, + "maximum": 59 + } + }, + "required": [ + "hour", + "minute" + ] + }, + "UpdateSessionHostsRequestBody": { + "type": "object", + "description": "Object containing the definition for properties to be used for a sessionHostUpdate operation.", + "properties": { + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately" + }, + "scheduledDateTimeZone": { + "type": "string", + "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object." + } + } + }, + "UpdateState": { + "type": "string", + "description": "Update state of a SessionHost.", + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true, + "values": [ + { + "name": "Initial", + "value": "Initial", + "description": "Update is initializing" + }, + { + "name": "Pending", + "value": "Pending", + "description": "Update is pending" + }, + { + "name": "Started", + "value": "Started", + "description": "Update has started" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Update has succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Update has failed" + } + ] + }, + "readOnly": true + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "properties": { + "properties": { + "$ref": "#/definitions/UserSessionProperties", + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "UserSessionList": { + "type": "object", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "The UserSession items on this page", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "UserSessionProperties": { + "type": "object", + "description": "Schema for UserSession properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of user session. (internal use)", + "readOnly": true + }, + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "$ref": "#/definitions/ApplicationType", + "description": "Application type of application." + }, + "sessionState": { + "$ref": "#/definitions/SessionState", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the user session create." + } + } + }, + "VirtualMachineDiskType": { + "type": "string", + "description": "The disk type used by virtual machine in hostpool session host.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + } + }, + "VirtualMachineSecurityType": { + "type": "string", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard.", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot and vTpm" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "WorkspaceList": { + "type": "object", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "The Workspace items on this page", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.A patch model", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/WorkspacePatchProperties", + "description": "Detailed properties for Workspace" + } + } + }, + "WorkspacePatchProperties": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Enabled to allow this resource to be access from the public network" + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "Schema for Workspace properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Workspace. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints" + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connection associated with the specified resource", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "oboTenantId": { + "type": "string", + "description": "Tenant that the resource is being requested on behalf of." + } + } + }, + "failHealthCheckOnStagingFailure": { + "type": "string", + "description": "Parameter indicating how the health check should behave if this package fails staging", + "enum": [ + "Unhealthy", + "NeedsAssistance", + "DoNotFail" + ], + "x-ms-enum": { + "name": "failHealthCheckOnStagingFailure", + "modelAsString": true, + "values": [ + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Health Check will report unhealthy" + }, + { + "name": "NeedsAssistance", + "value": "NeedsAssistance", + "description": "Health Check will report NeedsAssistance" + }, + { + "name": "DoNotFail", + "value": "DoNotFail", + "description": "Health Check will not report failure" + } + ] + } + }, + "packageTimestamped": { + "type": "string", + "description": "Is package timestamped so it can ignore the certificate expiry date", + "enum": [ + "Timestamped", + "NotTimestamped" + ], + "x-ms-enum": { + "name": "packageTimestamped", + "modelAsString": true, + "values": [ + { + "name": "Timestamped", + "value": "Timestamped", + "description": "Package is timestamped" + }, + { + "name": "NotTimestamped", + "value": "NotTimestamped", + "description": "Package is not timestamped, use certificate expiry date" + } + ] + } + }, + "type": { + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "name": "Marketplace", + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Using a custom image." + } + ] + } + }, + "updateStatus": { + "type": "string", + "description": "Operation status for SessionHostManagementUpdate.", + "enum": [ + "Error", + "Scheduled", + "UpdatingSessionHosts", + "ValidatingSessionHostUpdate", + "Paused", + "Pausing", + "Cancelling", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "updateStatus", + "modelAsString": true, + "values": [ + { + "name": "Error", + "value": "Error", + "description": "The operation has an error." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The operation is scheduled." + }, + { + "name": "UpdatingSessionHosts", + "value": "UpdatingSessionHosts", + "description": "The operation is currently updating Session Hosts." + }, + { + "name": "ValidatingSessionHostUpdate", + "value": "ValidatingSessionHostUpdate", + "description": "The operation is validating the update." + }, + { + "name": "Paused", + "value": "Paused", + "description": "The operation is paused." + }, + { + "name": "Pausing", + "value": "Pausing", + "description": "The operation is pausing." + }, + { + "name": "Cancelling", + "value": "Cancelling", + "description": "Canceling the operation." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation failed." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "The operation is canceled" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..dc9b5d895d24 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "ActiveSessionHostConfigurations_Get", + "title": "ActiveSessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..06beea9b4e8e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "title": "ActiveSessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackageInfo_Import.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackageInfo_Import.json new file mode 100644 index 000000000000..2f23eea68a4a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackageInfo_Import.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "importPackageInfoRequest": { + "path": "https://url.com/imagePath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + }, + "operationId": "AppAttachPackageInfo_Import", + "title": "AppAttachPackageInfo_Import" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_CreateOrUpdate.json new file mode 100644 index 000000000000..cbdde4e1a715 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_CreateOrUpdate.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2025-08-01-preview", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + } + }, + "appAttachPackageName": "msixpackagefullname", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "AppAttachPackage_CreateOrUpdate", + "title": "AppAttachPackage_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..07e5b911996e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Delete.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + "204": {} + }, + "operationId": "AppAttachPackage_Delete", + "title": "AppAttachPackage_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Get.json new file mode 100644 index 000000000000..cd1027fbef86 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Get", + "title": "AppAttachPackage_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..427d64f1a9f4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListByResourceGroup", + "title": "AppAttachPackage_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..22c7799378d1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListBySubscription", + "title": "AppAttachPackage_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Update.json new file mode 100644 index 000000000000..6bbe58727949 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/AppAttachPackage_Update.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackagePatch": { + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp1", + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": "DoNotFail" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Update", + "title": "AppAttachPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..65ef37526bee --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-08-01-preview", + "applicationGroup": { + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "showInFeed": true, + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "applicationGroupName": "applicationGroup1", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "ApplicationGroups_CreateOrUpdate", + "title": "ApplicationGroup_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Delete.json new file mode 100644 index 000000000000..934dc813f1c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + }, + "operationId": "ApplicationGroups_Delete", + "title": "ApplicationGroups_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Get.json new file mode 100644 index 000000000000..b3ca7f13557c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Get", + "title": "ApplicationGroup_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..36f6fd2078f6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_ListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListByResourceGroup", + "title": "ApplicationGroup_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_ListBySubscription.json new file mode 100644 index 000000000000..469c6073306c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_ListBySubscription.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListBySubscription", + "title": "ApplicationGroup_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Update.json new file mode 100644 index 000000000000..213e49b58051 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ApplicationGroups_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Update", + "title": "ApplicationGroup_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_CreateOrUpdate.json new file mode 100644 index 000000000000..b0863c2b9c70 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_CreateOrUpdate", + "title": "Applications_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Delete.json new file mode 100644 index 000000000000..c57d3043b417 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Delete.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + }, + "operationId": "Applications_Delete", + "title": "Applications_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Get.json new file mode 100644 index 000000000000..66d4ab382ebf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Get", + "title": "Applications_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_List.json new file mode 100644 index 000000000000..9ca1298c58e0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + }, + "operationId": "Applications_List", + "title": "Applications_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Update.json new file mode 100644 index 000000000000..196bd0021a4a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Applications_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-08-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Update", + "title": "Applications_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_Get.json new file mode 100644 index 000000000000..69f969f030d4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Get", + "title": "Desktops_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_List.json new file mode 100644 index 000000000000..ca773a0c5208 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + }, + "operationId": "Desktops_List", + "title": "Desktops_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_Update.json new file mode 100644 index 000000000000..c62f793f529a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Desktops_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-08-01-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Update", + "title": "Desktops_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPool_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPool_CreateOrUpdate.json new file mode 100644 index 000000000000..fea42d21d6cd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPool_CreateOrUpdate.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995", + "deploymentScope": "Geographical" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + } + }, + "operationId": "HostPools_CreateOrUpdate", + "title": "HostPools_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPool_Lists.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPool_Lists.json new file mode 100644 index 000000000000..8eb7b9344dac --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPool_Lists.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + } + ] + } + } + }, + "operationId": "HostPools_List", + "title": "HostPool_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Delete.json new file mode 100644 index 000000000000..baff8f3b8e0d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Delete.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "deploymentScope": "Geographical" + } + }, + "204": {} + }, + "operationId": "HostPools_Delete", + "title": "HostPools_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Get.json new file mode 100644 index 000000000000..f5d1490ca907 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Get.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + }, + "operationId": "HostPools_Get", + "title": "HostPools_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_ListByResourceGroup.json new file mode 100644 index 000000000000..75774d68c38e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_ListByResourceGroup.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical" + } + } + ] + } + } + }, + "operationId": "HostPools_ListByResourceGroup", + "title": "HostPools_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_ListRegistrationTokens.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_ListRegistrationTokens.json new file mode 100644 index 000000000000..261e0785603a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_ListRegistrationTokens.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token" + } + ] + } + } + }, + "operationId": "HostPools_ListRegistrationTokens", + "title": "HostPools_ListRegistrationTokens" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_RetrieveRegistrationToken.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_RetrieveRegistrationToken.json new file mode 100644 index 000000000000..e04fa6122d75 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_RetrieveRegistrationToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + }, + "operationId": "HostPools_RetrieveRegistrationToken", + "title": "HostPools_RetrieveRegistrationToken" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Update.json new file mode 100644 index 000000000000..db12a4bfb7e4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/HostPools_Update.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + }, + "operationId": "HostPools_Update", + "title": "HostPools_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_CreateOrUpdate.json new file mode 100644 index 000000000000..96a9620a8305 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_CreateOrUpdate.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_CreateOrUpdate", + "title": "MSIXPackages_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Delete.json new file mode 100644 index 000000000000..c0abc9c1d8a0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Delete.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + }, + "operationId": "MSIXPackages_Delete", + "title": "MSIXPackages_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Get.json new file mode 100644 index 000000000000..3205c628cc6f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Get", + "title": "MSIXPackages_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_List.json new file mode 100644 index 000000000000..4804b17c7625 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_List.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MSIXPackages_List", + "title": "MSIXPackages_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Update.json new file mode 100644 index 000000000000..c3057452782a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MSIXPackages_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Update", + "title": "MSIXPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MsixImages_Expand.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MsixImages_Expand.json new file mode 100644 index 000000000000..519f732acf4e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/MsixImages_Expand.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-08-01-preview", + "msixImageURI": { + "uri": "https://url.com/imagePath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/imagepath", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/msixImageURI", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MsixImages_Expand", + "title": "MsixImages_Expand" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Operations_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..05bb825d830a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_DeleteByHostPool.json new file mode 100644 index 000000000000..4891ce882219 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_DeleteByHostPool.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "title": "PrivateEndpointConnections_DeleteByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_DeleteByWorkspace.json new file mode 100644 index 000000000000..7000a7f1a0ad --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_DeleteByWorkspace.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "title": "PrivateEndpointConnections_DeleteByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_GetByHostPool.json new file mode 100644 index 000000000000..d1fa7fe2c1ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_GetByHostPool.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByHostPool", + "title": "PrivateEndpointConnections_GetByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_GetByWorkspace.json new file mode 100644 index 000000000000..afb5f278655d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_GetByWorkspace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "title": "PrivateEndpointConnections_GetByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_ListByHostPool.json new file mode 100644 index 000000000000..d7ed60617d29 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_ListByHostPool.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByHostPool", + "title": "PrivateEndpointConnections_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_ListByWorkspace.json new file mode 100644 index 000000000000..80f911d510e8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_ListByWorkspace.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "title": "PrivateEndpointConnections_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_UpdateByHostPool.json new file mode 100644 index 000000000000..d9534d5b74ec --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_UpdateByHostPool.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "title": "PrivateEndpointConnections_UpdateByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_UpdateByWorkspace.json new file mode 100644 index 000000000000..c84f801e7483 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateEndpointConnections_UpdateByWorkspace.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-08-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "title": "PrivateEndpointConnections_UpdateByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..8c2896b235b4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByHostPool", + "title": "PrivateLinkResources_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..187a5f2a4324 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByWorkspace", + "title": "PrivateLinkResources_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Create.json new file mode 100644 index 000000000000..325f82274d43 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Create.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Create", + "title": "ScalingPlanPersonalSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Delete.json new file mode 100644 index 000000000000..1305d6799b33 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPersonalSchedules_Delete", + "title": "ScalingPlanPersonalSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Get.json new file mode 100644 index 000000000000..d02deed33347 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Get", + "title": "ScalingPlanPersonalSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_List.json new file mode 100644 index 000000000000..6c933470a6be --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_List.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_List", + "title": "ScalingPlanPersonalSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Update.json new file mode 100644 index 000000000000..b8b64b731914 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPersonalSchedules_Update.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Update", + "title": "ScalingPlanPersonalSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Create.json new file mode 100644 index 000000000000..cbd454dcf57c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Create.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json new file mode 100644 index 000000000000..ec9e93adc882 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_CreateUsingCreateDelete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Delete.json new file mode 100644 index 000000000000..3d68bbd90ecd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPooledSchedules_Delete", + "title": "ScalingPlanPooledSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Get.json new file mode 100644 index 000000000000..ad1870d49465 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Get", + "title": "ScalingPlanPooledSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_List.json new file mode 100644 index 000000000000..b5735a0eefbe --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_List.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + }, + "operationId": "ScalingPlanPooledSchedules_List", + "title": "ScalingPlanPooledSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Update.json new file mode 100644 index 000000000000..591416bfd7c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlanPooledSchedules_Update.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-08-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Update", + "title": "ScalingPlanPooledSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Create.json new file mode 100644 index 000000000000..9c525c39006d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Create.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Create", + "title": "ScalingPlans_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Delete.json new file mode 100644 index 000000000000..5d781a8b230d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Delete.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + }, + "operationId": "ScalingPlans_Delete", + "title": "ScalingPlans_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Get.json new file mode 100644 index 000000000000..ec60170e3a94 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Get.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Get", + "title": "ScalingPlans_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListByHostPool.json new file mode 100644 index 000000000000..221fbf34cb81 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByHostPool", + "title": "ScalingPlans_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListByResourceGroup.json new file mode 100644 index 000000000000..6ffb3648878f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListByResourceGroup.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByResourceGroup", + "title": "ScalingPlans_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListBySubscription.json new file mode 100644 index 000000000000..d5e83842ded2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_ListBySubscription.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListBySubscription", + "title": "ScalingPlans_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Update.json new file mode 100644 index 000000000000..b81dba7493ee --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/ScalingPlans_Update.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-08-01-preview", + "scalingPlan": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Update", + "title": "ScalingPlans_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..d15b8e6bfaea --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_CreateOrUpdate.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "title": "SessionHostConfigurations_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..6357610c61c6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_Get.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_Get", + "title": "SessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..fc75fca37b5e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "SessionHostConfigurations_ListByHostPool", + "title": "SessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..456944a23d18 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostConfigurations_Update.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "SessionHostConfigurations_Update", + "title": "SessionHostConfigurations_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagementsUpdateStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagementsUpdateStatus_Get.json new file mode 100644 index 000000000000..b9afd5033a62 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagementsUpdateStatus_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostUpdateStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostManagementsUpdateStatus_Get", + "title": "SessionHostManagementsUpdateStatus_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json new file mode 100644 index 000000000000..2eecfbcc3181 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPoolProvisioningControlParameter": { + "action": "Cancel", + "cancelMessage": "Cancel host pool provisioning" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostProvisioning_Post", + "title": "SessionHostManagements_ControlSessionHostProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..b3b99ed813bf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "hostPoolUpdateControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostUpdate_Post", + "title": "SessionHostManagements_ControlSessionHostUpdate_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Create.json new file mode 100644 index 000000000000..25d8550bc0c1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_CreateOrUpdate", + "title": "SessionHostManagements_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Get.json new file mode 100644 index 000000000000..c592a5b21dad --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Get", + "title": "SessionHostManagements_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..29d2282a7613 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + }, + "operationId": "SessionHostManagements_ListByHostPool", + "title": "SessionHostManagements_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json new file mode 100644 index 000000000000..839bfc1e8dfe --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostProvisioningStatuses_Get", + "title": "SessionHostManagements_SessionHostProvisioningStatuses_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Update.json new file mode 100644 index 000000000000..180913c963bd --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Update", + "title": "SessionHostManagements_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..680750cbb90a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "204": { + "description": "Operation completed successfully." + } + }, + "operationId": "InitiateSessionHostUpdate_Post", + "title": "SessionHostManagements_UpdateSessionHosts_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..84005e7c9568 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "description": "Operation completed successfully." + } + }, + "operationId": "SessionHosts_RetryProvisioning", + "title": "SessionHosts_RetryProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Delete.json new file mode 100644 index 000000000000..0fd7143d7cd5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + }, + "operationId": "SessionHosts_Delete", + "title": "SessionHost_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Get.json new file mode 100644 index 000000000000..d2e7c9b3fde6 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Get", + "title": "SessionHost_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_List.json new file mode 100644 index 000000000000..32c2ad56e249 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_List.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + }, + "operationId": "SessionHosts_List", + "title": "SessionHost_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Update.json new file mode 100644 index 000000000000..6a411d019053 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/SessionHosts_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Update", + "title": "SessionHost_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/StartMenuItems_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/StartMenuItems_List.json new file mode 100644 index 000000000000..baa3a8f63c6f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/StartMenuItems_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + }, + "operationId": "StartMenuItems_List", + "title": "StartMenuItems_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSession_Get.json new file mode 100644 index 000000000000..be3852f0619b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSession_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + }, + "operationId": "UserSessions_Get", + "title": "UserSessions_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_Delete.json new file mode 100644 index 000000000000..36c339f228b0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + }, + "operationId": "UserSessions_Delete", + "title": "UserSession_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_Disconnect.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_Disconnect.json new file mode 100644 index 000000000000..0270d422c25a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_Disconnect.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": {} + }, + "operationId": "UserSessions_Disconnect", + "title": "UserSession_Disconnect_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_List.json new file mode 100644 index 000000000000..51508fe35683 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_List", + "title": "UserSession_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_ListByHostPool.json new file mode 100644 index 000000000000..8aed92f14df1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_ListByHostPool.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-08-01-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_ListByHostPool", + "title": "UserSession_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_SendMessage.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_SendMessage.json new file mode 100644 index 000000000000..6053954e5eba --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/UserSessions_SendMessage.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-08-01-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": { + "description": "The request has succeeded." + } + }, + "operationId": "UserSessions_SendMessage", + "title": "UserSession_SendMessage_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..7e3ecf6dc57a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_CreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspace_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Delete.json new file mode 100644 index 000000000000..7a3ffeffce5d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + }, + "operationId": "Workspaces_Delete", + "title": "Workspace_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Get.json new file mode 100644 index 000000000000..35c7018f71f5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Get", + "title": "Workspace_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_ListByResourceGroup.json new file mode 100644 index 000000000000..1e67a88dce13 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListByResourceGroup", + "title": "Workspace_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_ListBySubscription.json new file mode 100644 index 000000000000..351a8d64c8ce --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-08-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListBySubscription", + "title": "Workspaces_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Update.json new file mode 100644 index 000000000000..890be300bd5f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-08-01-preview/examples/Workspaces_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-08-01-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Update", + "title": "Workspace_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/desktopvirtualization.json new file mode 100644 index 000000000000..fb90f68343ab --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/desktopvirtualization.json @@ -0,0 +1,12283 @@ +{ + "swagger": "2.0", + "info": { + "title": "Desktop Virtualization API Client", + "version": "2025-09-01-preview", + "description": "This Typespec represents the Desktop Virtualization API interfaces.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AppAttachPackages" + }, + { + "name": "StartMenuItems" + }, + { + "name": "ApplicationGroups" + }, + { + "name": "AppAttachPackageInfo" + }, + { + "name": "MSIXImages" + }, + { + "name": "PrivateLinkResources" + }, + { + "name": "HostPools" + }, + { + "name": "ScalingPlans" + }, + { + "name": "Workspaces" + }, + { + "name": "Applications" + }, + { + "name": "Desktops" + }, + { + "name": "CustomPrivateEndpointConnection" + }, + { + "name": "SessionHosts" + }, + { + "name": "UserSessions" + }, + { + "name": "ScalingPlanPersonalSchedules" + }, + { + "name": "ScalingPlanPooledSchedules" + }, + { + "name": "MSIXPackages" + }, + { + "name": "ActiveSessionHostConfigurations" + }, + { + "name": "InitiateSessionHostUpdate" + }, + { + "name": "ControlSessionHostUpdate" + }, + { + "name": "SessionHostManagement" + }, + { + "name": "SessionHostManagements" + }, + { + "name": "SessionHostConfigurations" + }, + { + "name": "SessionHostManagementUpdateStatuses" + } + ], + "paths": { + "/providers/Microsoft.DesktopVirtualization/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceProviderOperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Provider Operations": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "operationId": "AppAttachPackage_ListBySubscription", + "tags": [ + "AppAttachPackages" + ], + "description": "List App Attach packages in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are package name, host pool, and resource group.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_ListBySubscription": { + "$ref": "./examples/AppAttachPackage_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "operationId": "ApplicationGroups_ListBySubscription", + "tags": [ + "ApplicationGroups" + ], + "description": "List applicationGroups in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_List": { + "$ref": "./examples/ApplicationGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "operationId": "HostPools_List", + "tags": [ + "HostPools" + ], + "description": "List hostPools in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPool_List": { + "$ref": "./examples/HostPool_Lists.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "operationId": "ScalingPlans_ListBySubscription", + "tags": [ + "ScalingPlans" + ], + "description": "List scaling plans in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_ListBySubscription": { + "$ref": "./examples/ScalingPlans_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "operationId": "Workspaces_ListBySubscription", + "tags": [ + "Workspaces" + ], + "description": "List workspaces in subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspaces_ListBySubscription": { + "$ref": "./examples/Workspaces_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages": { + "get": { + "operationId": "AppAttachPackage_ListByResourceGroup", + "tags": [ + "AppAttachPackages" + ], + "description": "List App Attach packages in resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are package name and host pool.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_ListByResourceGroup": { + "$ref": "./examples/AppAttachPackage_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}": { + "get": { + "operationId": "AppAttachPackage_Get", + "tags": [ + "AppAttachPackages" + ], + "description": "Get an app attach package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Get": { + "$ref": "./examples/AppAttachPackage_Get.json" + } + } + }, + "put": { + "operationId": "AppAttachPackage_CreateOrUpdate", + "tags": [ + "AppAttachPackages" + ], + "description": "Create or update an App Attach package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + }, + { + "name": "appAttachPackage", + "in": "body", + "description": "Object containing App Attach Package definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AppAttachPackage' update operation succeeded", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "201": { + "description": "Resource 'AppAttachPackage' create operation succeeded", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Create": { + "$ref": "./examples/AppAttachPackage_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "AppAttachPackage_Update", + "tags": [ + "AppAttachPackages" + ], + "description": "Update an App Attach Package", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + }, + { + "name": "appAttachPackagePatch", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/AppAttachPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Update": { + "$ref": "./examples/AppAttachPackage_Update.json" + } + } + }, + "delete": { + "operationId": "AppAttachPackage_Delete", + "tags": [ + "AppAttachPackages" + ], + "description": "Remove an App Attach Package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appAttachPackageName", + "in": "path", + "description": "The name of the App Attach package", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[a-z0-9]([a-z0-9]|(-(?!-))){1,61}[a-z0-9]$" + }, + { + "name": "force", + "in": "query", + "description": "Allows force delete", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackage_Delete": { + "$ref": "./examples/AppAttachPackage_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { + "get": { + "operationId": "ApplicationGroups_ListByResourceGroup", + "tags": [ + "ApplicationGroups" + ], + "description": "List applicationGroups.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are applicationGroupType.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationGroupList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_ListByResourceGroup": { + "$ref": "./examples/ApplicationGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { + "get": { + "operationId": "ApplicationGroups_Get", + "tags": [ + "ApplicationGroups" + ], + "description": "Get an application group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_Get": { + "$ref": "./examples/ApplicationGroups_Get.json" + } + } + }, + "put": { + "operationId": "ApplicationGroups_CreateOrUpdate", + "tags": [ + "ApplicationGroups" + ], + "description": "Create or update an applicationGroup.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationGroup", + "in": "body", + "description": "Object containing ApplicationGroup definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApplicationGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "201": { + "description": "Resource 'ApplicationGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_Create": { + "$ref": "./examples/ApplicationGroups_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "ApplicationGroups_Update", + "tags": [ + "ApplicationGroups" + ], + "description": "Update an applicationGroup.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationGroup", + "in": "body", + "description": "The AppGroup properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroup_Update": { + "$ref": "./examples/ApplicationGroups_Update.json" + } + } + }, + "delete": { + "operationId": "ApplicationGroups_Delete", + "tags": [ + "ApplicationGroups" + ], + "description": "Remove an applicationGroup.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApplicationGroups_Delete": { + "$ref": "./examples/ApplicationGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { + "get": { + "operationId": "Applications_List", + "tags": [ + "Applications" + ], + "description": "List applications.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_List": { + "$ref": "./examples/Applications_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { + "get": { + "operationId": "Applications_Get", + "tags": [ + "Applications" + ], + "description": "Get an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_Get": { + "$ref": "./examples/Applications_Get.json" + } + } + }, + "put": { + "operationId": "Applications_CreateOrUpdate", + "tags": [ + "Applications" + ], + "description": "Create or update an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "application", + "in": "body", + "description": "Object containing Application definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Application' update operation succeeded", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "201": { + "description": "Resource 'Application' create operation succeeded", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_CreateOrUpdate": { + "$ref": "./examples/Applications_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Applications_Update", + "tags": [ + "Applications" + ], + "description": "Update an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "application", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_Update": { + "$ref": "./examples/Applications_Update.json" + } + } + }, + "delete": { + "operationId": "Applications_Delete", + "tags": [ + "Applications" + ], + "description": "Remove an application.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "applicationName", + "in": "path", + "description": "The name of the application within the specified application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Applications_Delete": { + "$ref": "./examples/Applications_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { + "get": { + "operationId": "Desktops_List", + "tags": [ + "Desktops" + ], + "description": "List desktops.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DesktopList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Desktops_List": { + "$ref": "./examples/Desktops_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { + "get": { + "operationId": "Desktops_Get", + "tags": [ + "Desktops" + ], + "description": "Get a desktop.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "desktopName", + "in": "path", + "description": "The name of the desktop within the specified desktop group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Desktops_Get": { + "$ref": "./examples/Desktops_Get.json" + } + } + }, + "patch": { + "operationId": "Desktops_Update", + "tags": [ + "Desktops" + ], + "description": "Update a desktop.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "desktopName", + "in": "path", + "description": "The name of the desktop within the specified desktop group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 24, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "desktop", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/DesktopPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Desktop" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Desktops_Update": { + "$ref": "./examples/Desktops_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { + "get": { + "operationId": "StartMenuItems_List", + "tags": [ + "StartMenuItems" + ], + "description": "List start menu items in the given application group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "applicationGroupName", + "in": "path", + "description": "The name of the application group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StartMenuItemList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StartMenuItems_List": { + "$ref": "./examples/StartMenuItems_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { + "get": { + "operationId": "HostPools_ListByResourceGroup", + "tags": [ + "HostPools" + ], + "description": "List hostPools.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/HostPoolList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_ListByResourceGroup": { + "$ref": "./examples/HostPools_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { + "get": { + "operationId": "HostPools_Get", + "tags": [ + "HostPools" + ], + "description": "Get a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_Get": { + "$ref": "./examples/HostPools_Get.json" + } + } + }, + "put": { + "operationId": "HostPools_CreateOrUpdate", + "tags": [ + "HostPools" + ], + "description": "Create or update a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPool", + "in": "body", + "description": "Object containing HostPool definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/HostPool" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HostPool' update operation succeeded", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "201": { + "description": "Resource 'HostPool' create operation succeeded", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_CreateOrUpdate": { + "$ref": "./examples/HostPool_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "HostPools_Update", + "tags": [ + "HostPools" + ], + "description": "Update a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPool", + "in": "body", + "description": "The properties to be updated.", + "required": false, + "schema": { + "$ref": "#/definitions/HostPoolPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HostPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_Update": { + "$ref": "./examples/HostPools_Update.json" + } + } + }, + "delete": { + "operationId": "HostPools_Delete", + "tags": [ + "HostPools" + ], + "description": "Remove a host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "force", + "in": "query", + "description": "Force flag to delete sessionHost.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_Delete": { + "$ref": "./examples/HostPools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations": { + "get": { + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "tags": [ + "ActiveSessionHostConfigurations" + ], + "description": "Operation to list the ActiveSessionHostConfigurations associated with the HostPool", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfigurationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActiveSessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/ActiveSessionHostConfigurations_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default": { + "get": { + "operationId": "ActiveSessionHostConfigurations_Get", + "tags": [ + "ActiveSessionHostConfigurations" + ], + "description": "Get a ActiveSessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActiveSessionHostConfigurations_Get": { + "$ref": "./examples/ActiveSessionHostConfigurations_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage": { + "post": { + "operationId": "MsixImages_Expand", + "tags": [ + "MSIXImages" + ], + "description": "Expands and Lists MSIX packages in an Image, given the Image Path.\nThis action uses incorrect Msix casing intentionally to match the previous APIs.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixImageURI", + "in": "body", + "description": "Represents URI referring to MSIX Image", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXImageURI" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExpandMsixImageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MsixImages_Expand": { + "$ref": "./examples/MsixImages_Expand.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo": { + "post": { + "operationId": "AppAttachPackageInfo_Import", + "tags": [ + "AppAttachPackageInfo" + ], + "description": "Gets information from a package given the path to the package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "importPackageInfoRequest", + "in": "body", + "description": "Information to import app attach package", + "required": true, + "schema": { + "$ref": "#/definitions/ImportPackageInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppAttachPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppAttachPackageInfo_Import": { + "$ref": "./examples/AppAttachPackageInfo_Import.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens": { + "post": { + "operationId": "HostPools_ListRegistrationTokens", + "tags": [ + "HostPools" + ], + "description": "Operation to list the RegistrationTokens associated with the HostPool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RegistrationTokenList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_ListRegistrationTokens": { + "$ref": "./examples/HostPools_ListRegistrationTokens.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages": { + "get": { + "operationId": "MSIXPackages_List", + "tags": [ + "MSIXPackages" + ], + "description": "List MSIX packages in hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/MSIXPackageList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_List": { + "$ref": "./examples/MSIXPackages_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}": { + "get": { + "operationId": "MSIXPackages_Get", + "tags": [ + "MSIXPackages" + ], + "description": "Get a msixpackage.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_Get": { + "$ref": "./examples/MSIXPackages_Get.json" + } + } + }, + "put": { + "operationId": "MSIXPackages_CreateOrUpdate", + "tags": [ + "MSIXPackages" + ], + "description": "Create or update a MSIX package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackage", + "in": "body", + "description": "Object containing MSIX Package definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MSIXPackage' update operation succeeded", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "201": { + "description": "Resource 'MSIXPackage' create operation succeeded", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_Create": { + "$ref": "./examples/MSIXPackages_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "MSIXPackages_Update", + "tags": [ + "MSIXPackages" + ], + "description": "Update an MSIX Package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackage", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MSIXPackagePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackage_Update": { + "$ref": "./examples/MSIXPackages_Update.json" + } + } + }, + "delete": { + "operationId": "MSIXPackages_Delete", + "tags": [ + "MSIXPackages" + ], + "description": "Remove an MSIX Package.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "msixPackageFullName", + "in": "path", + "description": "The version specific package full name of the MSIX package within specified hostpool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 100, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MSIXPackages_Delete": { + "$ref": "./examples/MSIXPackages_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "List private endpoint connections associated with hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_GetByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Get a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_GetByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_GetByHostPool.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Approve or reject a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + }, + { + "name": "connection", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionWithSystemData' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_UpdateByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_UpdateByHostPool.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Delete a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_DeleteByHostPool": { + "$ref": "./examples/PrivateEndpointConnections_DeleteByHostPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResources_ListByHostPool", + "tags": [ + "PrivateLinkResources" + ], + "description": "List the private link resources available for this hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByHostPool": { + "$ref": "./examples/PrivateLinkResources_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken": { + "post": { + "operationId": "HostPools_RetrieveRegistrationToken", + "tags": [ + "HostPools" + ], + "description": "Registration token of the host pool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RegistrationInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HostPools_RetrieveRegistrationToken": { + "$ref": "./examples/HostPools_RetrieveRegistrationToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans": { + "get": { + "operationId": "ScalingPlans_ListByHostPool", + "tags": [ + "ScalingPlans" + ], + "description": "List scaling plan associated with hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_ListByHostPool": { + "$ref": "./examples/ScalingPlans_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations": { + "get": { + "operationId": "SessionHostConfigurations_ListByHostPool", + "tags": [ + "SessionHostConfigurations" + ], + "description": "List SessionHostConfigurations.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostConfigurationList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_ListByHostPool": { + "$ref": "./examples/SessionHostConfigurations_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default": { + "get": { + "operationId": "SessionHostConfigurations_Get", + "tags": [ + "SessionHostConfigurations" + ], + "description": "Get a SessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_Get": { + "$ref": "./examples/SessionHostConfigurations_Get.json" + } + } + }, + "put": { + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "tags": [ + "SessionHostConfigurations" + ], + "description": "Create or update a SessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostConfiguration", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SessionHostConfiguration' update operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "201": { + "description": "Resource 'SessionHostConfiguration' create operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_Create": { + "$ref": "./examples/SessionHostConfigurations_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SessionHostConfigurations_Update", + "tags": [ + "SessionHostConfigurations" + ], + "description": "Update a SessionHostConfiguration.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostConfiguration", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostConfigurationPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostConfigurations_Update": { + "$ref": "./examples/SessionHostConfigurations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements": { + "get": { + "operationId": "SessionHostManagements_ListByHostPool", + "tags": [ + "SessionHostManagements" + ], + "description": "List SessionHostManagements.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostManagementList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_ListByHostPool": { + "$ref": "./examples/SessionHostManagements_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default": { + "get": { + "operationId": "SessionHostManagements_Get", + "tags": [ + "SessionHostManagements" + ], + "description": "Get a SessionHostManagement.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_Get": { + "$ref": "./examples/SessionHostManagements_Get.json" + } + } + }, + "put": { + "operationId": "SessionHostManagements_CreateOrUpdate", + "tags": [ + "SessionHostManagements" + ], + "description": "Create or update a SessionHostManagement.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostManagement", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SessionHostManagement' update operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "201": { + "description": "Resource 'SessionHostManagement' create operation succeeded", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_Create": { + "$ref": "./examples/SessionHostManagements_Create.json" + } + } + }, + "patch": { + "operationId": "SessionHostManagements_Update", + "tags": [ + "SessionHostManagements" + ], + "description": "Update a SessionHostManagement.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostManagement", + "in": "body", + "description": "The properties to be updated.", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostManagementPatch" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_Update": { + "$ref": "./examples/SessionHostManagements_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostProvisioning": { + "post": { + "operationId": "ControlSessionHostProvisioning_Post", + "tags": [ + "SessionHostManagement" + ], + "description": "Control provisioning of a hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPoolProvisioningControlParameter", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolProvisioningControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_ControlSessionHostProvisioning_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate": { + "post": { + "operationId": "ControlSessionHostUpdate_Post", + "tags": [ + "ControlSessionHostUpdate" + ], + "description": "Control actions on a session host update.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "hostPoolUpdateControlParameter", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/HostPoolUpdateControlParameter" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_ControlSessionHostUpdate_Post": { + "$ref": "./examples/SessionHostManagements_ControlSessionHostUpdate_Post.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate": { + "post": { + "operationId": "InitiateSessionHostUpdate_Post", + "tags": [ + "InitiateSessionHostUpdate" + ], + "description": "Initiates a hostpool update or schedule an update for the future.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "updateSessionHostsRequestBody", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/UpdateSessionHostsRequestBody" + } + } + ], + "responses": { + "204": { + "description": "Azure operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_UpdateSessionHosts_Post": { + "$ref": "./examples/SessionHostManagements_UpdateSessionHosts_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostProvisioningStatuses/default": { + "get": { + "operationId": "SessionHostProvisioningStatuses_Get", + "tags": [ + "SessionHostManagement" + ], + "description": "Get the session host provisioning status for a given hostpool.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostManagementProvisioningStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagements_SessionHostProvisioningStatuses_Get": { + "$ref": "./examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default": { + "get": { + "operationId": "SessionHostManagementsUpdateStatus_Get", + "tags": [ + "SessionHostManagementUpdateStatuses" + ], + "description": "Get a SessionHostManagementUpdateStatus.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHostManagementUpdateStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHostManagementsUpdateStatus_Get": { + "$ref": "./examples/SessionHostManagementsUpdateStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { + "get": { + "operationId": "SessionHosts_List", + "tags": [ + "SessionHosts" + ], + "description": "List sessionHosts.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "vmPath", + "in": "query", + "description": "The path to the VM.", + "required": false, + "type": "string", + "minLength": 3, + "maxLength": 1092, + "pattern": "^[A-Z][a-z][0-9][@./-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SessionHostList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_List": { + "$ref": "./examples/SessionHosts_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { + "get": { + "operationId": "SessionHosts_Get", + "tags": [ + "SessionHosts" + ], + "description": "Get a session host.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_Get": { + "$ref": "./examples/SessionHosts_Get.json" + } + } + }, + "patch": { + "operationId": "SessionHosts_Update", + "tags": [ + "SessionHosts" + ], + "description": "Update a session host.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "force", + "in": "query", + "description": "Force flag to update assign, unassign or reassign personal desktop.", + "required": false, + "type": "boolean" + }, + { + "name": "sessionHost", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/SessionHostPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SessionHost" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_Update": { + "$ref": "./examples/SessionHosts_Update.json" + } + } + }, + "delete": { + "operationId": "SessionHosts_Delete", + "tags": [ + "SessionHosts" + ], + "description": "Remove a SessionHost.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "force", + "in": "query", + "description": "Force flag to force sessionHost deletion even when userSession exists.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHost_Delete": { + "$ref": "./examples/SessionHosts_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning": { + "post": { + "operationId": "SessionHosts_RetryProvisioning", + "tags": [ + "SessionHosts" + ], + "description": "Retry provisioning on a SessionHost.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SessionHosts_RetryProvisioning_Post": { + "$ref": "./examples/SessionHost_RetryProvisioning_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { + "get": { + "operationId": "UserSessions_List", + "tags": [ + "UserSessions" + ], + "description": "List userSessions.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_List": { + "$ref": "./examples/UserSessions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { + "get": { + "operationId": "UserSessions_Get", + "tags": [ + "UserSessions" + ], + "description": "Get a userSession.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserSession" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSessions_Get": { + "$ref": "./examples/UserSession_Get.json" + } + } + }, + "delete": { + "operationId": "UserSessions_Delete", + "tags": [ + "UserSessions" + ], + "description": "Remove a userSession.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + }, + { + "name": "force", + "in": "query", + "description": "Force flag to login off userSession.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_Delete": { + "$ref": "./examples/UserSessions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { + "post": { + "operationId": "UserSessions_Disconnect", + "tags": [ + "UserSessions" + ], + "description": "Disconnect a userSession.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_Disconnect_Post": { + "$ref": "./examples/UserSessions_Disconnect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { + "post": { + "operationId": "UserSessions_SendMessage", + "tags": [ + "UserSessions" + ], + "description": "Send a message to a user.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "sessionHostName", + "in": "path", + "description": "The name of the session host within the specified host pool", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 48, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "userSessionId", + "in": "path", + "description": "The name of the user session within the specified session host", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 24 + }, + { + "name": "sendMessage", + "in": "body", + "description": "Represents message sent to a UserSession.", + "required": false, + "schema": { + "$ref": "#/definitions/SendMessage" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_SendMessage_Post": { + "$ref": "./examples/UserSessions_SendMessage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { + "get": { + "operationId": "UserSessions_ListByHostPool", + "tags": [ + "UserSessions" + ], + "description": "A synchronous resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "hostPoolName", + "in": "path", + "description": "The name of the host pool within the specified resource group", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/UserSessionList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UserSession_ListByHostPool": { + "$ref": "./examples/UserSessions_ListByHostPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans": { + "get": { + "operationId": "ScalingPlans_ListByResourceGroup", + "tags": [ + "ScalingPlans" + ], + "description": "List scaling plans.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_ListByResourceGroup": { + "$ref": "./examples/ScalingPlans_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}": { + "get": { + "operationId": "ScalingPlans_Get", + "tags": [ + "ScalingPlans" + ], + "description": "Get a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Get": { + "$ref": "./examples/ScalingPlans_Get.json" + } + } + }, + "put": { + "operationId": "ScalingPlans_Create", + "tags": [ + "ScalingPlans" + ], + "description": "Create or update a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlan", + "in": "body", + "description": "Object containing scaling plan definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ScalingPlan' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "201": { + "description": "Resource 'ScalingPlan' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Create": { + "$ref": "./examples/ScalingPlans_Create.json" + } + } + }, + "patch": { + "operationId": "ScalingPlans_Update", + "tags": [ + "ScalingPlans" + ], + "description": "Update a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlan", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Update": { + "$ref": "./examples/ScalingPlans_Update.json" + } + } + }, + "delete": { + "operationId": "ScalingPlans_Delete", + "tags": [ + "ScalingPlans" + ], + "description": "Remove a scaling plan.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlans_Delete": { + "$ref": "./examples/ScalingPlans_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules": { + "get": { + "operationId": "ScalingPlanPersonalSchedules_List", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "List ScalingPlanPersonalSchedules.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_List": { + "$ref": "./examples/ScalingPlanPersonalSchedules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}": { + "get": { + "operationId": "ScalingPlanPersonalSchedules_Get", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Get a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Get": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Get.json" + } + } + }, + "put": { + "operationId": "ScalingPlanPersonalSchedules_Create", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Create or update a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "Object containing ScalingPlanPersonalSchedule definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ScalingPlanPersonalSchedule' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "201": { + "description": "Resource 'ScalingPlanPersonalSchedule' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Create": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Create.json" + } + } + }, + "patch": { + "operationId": "ScalingPlanPersonalSchedules_Update", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Update a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Update": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Update.json" + } + } + }, + "delete": { + "operationId": "ScalingPlanPersonalSchedules_Delete", + "tags": [ + "ScalingPlanPersonalSchedules" + ], + "description": "Remove a ScalingPlanPersonalSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPersonalSchedules_Delete": { + "$ref": "./examples/ScalingPlanPersonalSchedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules": { + "get": { + "operationId": "ScalingPlanPooledSchedules_List", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "List ScalingPlanPooledSchedules.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledScheduleList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_List": { + "$ref": "./examples/ScalingPlanPooledSchedules_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}": { + "get": { + "operationId": "ScalingPlanPooledSchedules_Get", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Get a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Get": { + "$ref": "./examples/ScalingPlanPooledSchedules_Get.json" + } + } + }, + "put": { + "operationId": "ScalingPlanPooledSchedules_Create", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Create or update a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "Object containing ScalingPlanPooledSchedule definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ScalingPlanPooledSchedule' update operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "201": { + "description": "Resource 'ScalingPlanPooledSchedule' create operation succeeded", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Create": { + "$ref": "./examples/ScalingPlanPooledSchedules_Create.json" + }, + "ScalingPlanPooledSchedules_CreateUsingCreateDelete": { + "$ref": "./examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json" + } + } + }, + "patch": { + "operationId": "ScalingPlanPooledSchedules_Update", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Update a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanSchedule", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Update": { + "$ref": "./examples/ScalingPlanPooledSchedules_Update.json" + } + } + }, + "delete": { + "operationId": "ScalingPlanPooledSchedules_Delete", + "tags": [ + "ScalingPlanPooledSchedules" + ], + "description": "Remove a ScalingPlanPooledSchedule.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "scalingPlanName", + "in": "path", + "description": "The name of the scaling plan.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "scalingPlanScheduleName", + "in": "path", + "description": "The name of the ScalingPlanSchedule", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ScalingPlanPooledSchedules_Delete": { + "$ref": "./examples/ScalingPlanPooledSchedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { + "get": { + "operationId": "Workspaces_ListByResourceGroup", + "tags": [ + "Workspaces" + ], + "description": "List workspaces.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/WorkspaceList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_ListByResourceGroup": { + "$ref": "./examples/Workspaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { + "get": { + "operationId": "Workspaces_Get", + "tags": [ + "Workspaces" + ], + "description": "Get a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Get": { + "$ref": "./examples/Workspaces_Get.json" + } + } + }, + "put": { + "operationId": "Workspaces_CreateOrUpdate", + "tags": [ + "Workspaces" + ], + "description": "Create or update a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "workspace", + "in": "body", + "description": "Object containing Workspace definitions.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Workspace' update operation succeeded", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "Resource 'Workspace' create operation succeeded", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Create": { + "$ref": "./examples/Workspaces_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Workspaces_Update", + "tags": [ + "Workspaces" + ], + "description": "Update a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "workspace", + "in": "body", + "description": "The resource properties to be updated", + "required": false, + "schema": { + "$ref": "#/definitions/WorkspacePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Update": { + "$ref": "./examples/Workspaces_Update.json" + } + } + }, + "delete": { + "operationId": "Workspaces_Delete", + "tags": [ + "Workspaces" + ], + "description": "Remove a workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Workspace_Delete": { + "$ref": "./examples/Workspaces_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "List private endpoint connections associated with Workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResultWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_ListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Get a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_GetByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_GetByWorkspace.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Approve or reject a private endpoint connection.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + }, + { + "name": "connection", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionWithSystemData' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_UpdateByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_UpdateByWorkspace.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "tags": [ + "CustomPrivateEndpointConnection" + ], + "description": "Delete a PrivateEndpointConnectionWithSystemData", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name parameter for private endpoint", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_DeleteByWorkspace": { + "$ref": "./examples/PrivateEndpointConnections_DeleteByWorkspace.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResources_ListByWorkspace", + "tags": [ + "PrivateLinkResources" + ], + "description": "List the private link resources available for this workspace.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 64, + "pattern": "^[A-Za-z0-9@.\\-_ ]*$" + }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items per page.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "isDescending", + "in": "query", + "description": "Indicates whether the collection is descending.", + "required": false, + "type": "boolean" + }, + { + "name": "initialSkip", + "in": "query", + "description": "Initial number of items to skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByWorkspace": { + "$ref": "./examples/PrivateLinkResources_ListByWorkspace.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ActiveDirectoryInfoPatchProperties": { + "type": "object", + "description": "Active directory info. Only one should be populated based on the join type", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Credentials needed to create the virtual machine." + } + } + }, + "ActiveDirectoryInfoProperties": { + "type": "object", + "description": "Active directory info. Only one should be populated based on the join type.", + "properties": { + "domainCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Credentials needed to create the virtual machine." + }, + "ouPath": { + "type": "string", + "description": "The organizational unit(OU) path." + }, + "domainName": { + "type": "string", + "description": "The domain a virtual machine connected to a hostpool will join." + } + }, + "required": [ + "domainCredentials", + "ouPath" + ] + }, + "ActiveSessionHostConfiguration": { + "type": "object", + "description": "Schema for ActiveSessionHostConfiguration properties.", + "properties": { + "properties": { + "$ref": "#/definitions/ActiveSessionHostConfigurationProperties", + "description": "Detailed properties for ActiveSessionHostConfiguration", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ActiveSessionHostConfigurationList": { + "type": "object", + "description": "List of ActiveSessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ActiveSessionHostConfiguration items on this page", + "items": { + "$ref": "#/definitions/ActiveSessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ActiveSessionHostConfigurationProperties": { + "type": "object", + "description": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState", + "properties": { + "version": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "description": "Hashtable that lists key/value pair tags to apply to the VMs", + "additionalProperties": { + "type": "string" + } + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided." + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3].", + "items": { + "type": "integer", + "format": "int32" + } + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk information." + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of the HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security information." + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts." + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics information." + } + }, + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ] + }, + "AgentUpdatePatchProperties": { + "type": "object", + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "properties": { + "type": { + "$ref": "#/definitions/SessionHostComponentUpdateType", + "description": "The type of maintenance for session host components." + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "AgentUpdateProperties": { + "type": "object", + "description": "The session host configuration for updating agent, monitoring agent, and stack component.", + "properties": { + "type": { + "$ref": "#/definitions/SessionHostComponentUpdateType", + "description": "The type of maintenance for session host components." + }, + "useSessionHostLocalTime": { + "type": "boolean", + "description": "Whether to use localTime of the virtual machine." + }, + "maintenanceWindowTimeZone": { + "type": "string", + "description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true." + }, + "maintenanceWindows": { + "type": "array", + "description": "List of maintenance windows. Maintenance windows are 2 hours long.", + "items": { + "$ref": "#/definitions/MaintenanceWindowProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "AllowRDPShortPathWithPrivateLink": { + "type": "string", + "description": "Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "AllowRDPShortPathWithPrivateLink", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "Blocks the use of RDPShortPath if the hostpool PublicNetworkAccess setting is configured to require private link." + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Allows the use of RDPShortPath even if the hostpool PublicNetworkAccess is configured to require the use of private link." + } + ] + } + }, + "AppAttachPackage": { + "type": "object", + "description": "Schema for App Attach Package properties.", + "properties": { + "properties": { + "$ref": "#/definitions/AppAttachPackageProperties", + "description": "Detailed properties for App Attach Package", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "AppAttachPackageArchitectures": { + "type": "string", + "description": "Possible device architectures that an app attach package can be configured for", + "enum": [ + "ARM", + "ARM64", + "x86", + "x64", + "Neutral", + "x86a64", + "ALL" + ], + "x-ms-enum": { + "name": "AppAttachPackageArchitectures", + "modelAsString": true, + "values": [ + { + "name": "ARM", + "value": "ARM", + "description": "ARM 32-bit" + }, + { + "name": "ARM64", + "value": "ARM64", + "description": "ARM 64-bit" + }, + { + "name": "x86", + "value": "x86", + "description": "32-bit x86" + }, + { + "name": "x64", + "value": "x64", + "description": "64-bit" + }, + { + "name": "Neutral", + "value": "Neutral", + "description": "Any architecture can be used" + }, + { + "name": "x86a64", + "value": "x86a64", + "description": "X86 Compiled Hybrid Portable Executable for ARM64" + }, + { + "name": "ALL", + "value": "ALL", + "description": "Select all listed applications, no filters" + } + ] + } + }, + "AppAttachPackageInfoProperties": { + "type": "object", + "description": "Schema for Import Package Information properties.", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of App Attach Package. Assigned at import time" + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share." + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml." + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name." + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml." + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal." + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed." + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool." + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies.", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [] + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Date Package was last updated, found in the appxmanifest.xml." + }, + "packageApplications": { + "type": "array", + "description": "List of package applications.", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [] + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml." + }, + "certificateExpiry": { + "type": "string", + "format": "date-time", + "description": "Date certificate expires, found in the appxmanifest.xml." + }, + "isPackageTimestamped": { + "$ref": "#/definitions/packageTimestamped", + "description": "Is package timestamped so it can ignore the certificate expiry date" + } + } + }, + "AppAttachPackageList": { + "type": "object", + "description": "List of App Attach Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "The AppAttachPackage items on this page", + "items": { + "$ref": "#/definitions/AppAttachPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AppAttachPackagePatch": { + "type": "object", + "description": "Schema for updatable App Attach Package properties.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AppAttachPackagePatchProperties", + "description": "Detailed properties for App Attach Package" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "AppAttachPackagePatchProperties": { + "type": "object", + "description": "Schema for patchable fields on an App Attach Package.", + "properties": { + "image": { + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "description": "Detailed properties for App Attach Package" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource." + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL path to certificate name located in keyVault" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/failHealthCheckOnStagingFailure", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "packageLookbackUrl": { + "type": "string", + "format": "uri", + "description": "Lookback url to third party control plane, is null for native app attach packages" + }, + "customData": { + "type": "string", + "description": "Field that can be populated with custom data and filtered on in list GET calls" + } + } + }, + "AppAttachPackageProperties": { + "type": "object", + "description": "Schema for App Attach Package properties.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the App Attach Package.", + "readOnly": true + }, + "image": { + "$ref": "#/definitions/AppAttachPackageInfoProperties", + "description": "Detailed properties for App Attach Package" + }, + "hostPoolReferences": { + "type": "array", + "description": "List of Hostpool resource Ids.", + "items": { + "type": "string" + } + }, + "keyVaultURL": { + "type": "string", + "description": "URL path to certificate name located in keyVault" + }, + "failHealthCheckOnStagingFailure": { + "$ref": "#/definitions/failHealthCheckOnStagingFailure", + "description": "Parameter indicating how the health check should behave if this package fails staging" + }, + "packageOwnerName": { + "type": "string", + "description": "Specific name of package owner, is \"AppAttach\" for native app attach packages" + }, + "packageLookbackUrl": { + "type": "string", + "format": "uri", + "description": "Lookback url to third party control plane, is null for native app attach packages" + }, + "customData": { + "type": "string", + "description": "Field that can be populated with custom data and filtered on in list GET calls" + } + } + }, + "Application": { + "type": "object", + "description": "Schema for Application properties.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationProperties", + "description": "Detailed properties for Application", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ApplicationGroup": { + "type": "object", + "description": "Represents a ApplicationGroup definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationGroupProperties", + "description": "Detailed properties for ApplicationGroup", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "ApplicationGroupList": { + "type": "object", + "description": "List of ApplicationGroup definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ApplicationGroup items on this page", + "items": { + "$ref": "#/definitions/ApplicationGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApplicationGroupPatch": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ApplicationGroupPatchProperties", + "description": "ApplicationGroup properties that can be patched." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "ApplicationGroupPatchProperties": { + "type": "object", + "description": "ApplicationGroup properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + } + } + }, + "ApplicationGroupProperties": { + "type": "object", + "description": "Schema for ApplicationGroup properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of ApplicationGroup. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of ApplicationGroup." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of ApplicationGroup." + }, + "hostPoolArmPath": { + "type": "string", + "description": "HostPool arm path of ApplicationGroup." + }, + "workspaceArmPath": { + "type": "string", + "description": "Workspace arm path of ApplicationGroup.", + "readOnly": true + }, + "applicationGroupType": { + "$ref": "#/definitions/ApplicationGroupType", + "description": "Resource Type of ApplicationGroup." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "showInFeed": { + "type": "boolean", + "description": "Boolean representing whether the applicationGroup is show in the feed." + }, + "oboTenantId": { + "type": "string", + "description": "Tenant that the resource is being requested on behalf of." + } + }, + "required": [ + "hostPoolArmPath", + "applicationGroupType" + ] + }, + "ApplicationGroupType": { + "type": "string", + "description": "Resource Type of ApplicationGroup.", + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationGroupType", + "modelAsString": true, + "values": [ + { + "name": "RemoteApp", + "value": "RemoteApp", + "description": "Application group is Remote and can launch individual applications without a Desktop." + }, + { + "name": "Desktop", + "value": "Desktop", + "description": "Application Group delivers a full expected Desktop experience" + } + ] + } + }, + "ApplicationList": { + "type": "object", + "description": "List of Application definitions.", + "properties": { + "value": { + "type": "array", + "description": "The Application items on this page", + "items": { + "$ref": "#/definitions/Application" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApplicationPatch": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/ApplicationPatchProperties", + "description": "Detailed properties for Application" + } + } + }, + "ApplicationPatchProperties": { + "type": "object", + "description": "Application properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "commandLineSetting": { + "$ref": "#/definitions/CommandLineSetting", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications" + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications" + }, + "applicationType": { + "$ref": "#/definitions/RemoteApplicationType", + "description": "Resource Type of Application." + } + } + }, + "ApplicationProperties": { + "type": "object", + "description": "Schema for Application properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Application. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Application." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Application." + }, + "filePath": { + "type": "string", + "description": "Specifies a path for the executable file for the application." + }, + "msixPackageFamilyName": { + "type": "string", + "description": "Specifies the package family name for MSIX applications", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "msixPackageApplicationId": { + "type": "string", + "description": "Specifies the package application Id for MSIX applications", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "applicationType": { + "$ref": "#/definitions/RemoteApplicationType", + "description": "Resource Type of Application.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "commandLineSetting": { + "$ref": "#/definitions/CommandLineSetting", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." + }, + "commandLineArguments": { + "type": "string", + "description": "Command Line Arguments for Application." + }, + "showInPortal": { + "type": "boolean", + "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." + }, + "iconPath": { + "type": "string", + "description": "Path to icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + }, + "iconHash": { + "type": "string", + "description": "Hash of the icon.", + "readOnly": true + }, + "iconContent": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array.", + "readOnly": true + } + }, + "required": [ + "commandLineSetting" + ] + }, + "ApplicationType": { + "type": "string", + "description": "Application type of application.", + "enum": [ + "RemoteApp", + "Desktop" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true, + "values": [ + { + "name": "RemoteApp", + "value": "RemoteApp", + "description": "Remote Applications (non-desktop)" + }, + { + "name": "Desktop", + "value": "Desktop", + "description": "Desktop Applications" + } + ] + } + }, + "AzureActiveDirectoryInfoProperties": { + "type": "object", + "description": "Azure Active directory info. Only one should be populated based on the join type", + "properties": { + "mdmProviderGuid": { + "type": "string", + "description": "The Mobile Device Management(MDM) guid." + } + }, + "required": [ + "mdmProviderGuid" + ] + }, + "BootDiagnosticsInfoPatchProperties": { + "type": "object", + "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", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and screenshot.

      If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + } + }, + "BootDiagnosticsInfoProperties": { + "type": "object", + "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", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and screenshot.

      If storageUri is not specified while enabling boot diagnostics, managed storage will be used." + } + } + }, + "CanaryPolicy": { + "type": "string", + "description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation.", + "enum": [ + "Auto", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "CanaryPolicy", + "modelAsString": true, + "values": [ + { + "name": "Auto", + "value": "Auto", + "description": "Decided by service whether to provision Canary VM." + }, + { + "name": "Never", + "value": "Never", + "description": "Never provision Canary VM." + }, + { + "name": "Always", + "value": "Always", + "description": "Always provision Canary VM." + } + ] + } + }, + "CommandLineSetting": { + "type": "string", + "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", + "enum": [ + "DoNotAllow", + "Allow", + "Require" + ], + "x-ms-enum": { + "name": "CommandLineSetting", + "modelAsString": true, + "values": [ + { + "name": "DoNotAllow", + "value": "DoNotAllow", + "description": "Cannot be launched with command line arguments." + }, + { + "name": "Allow", + "value": "Allow", + "description": "Can optionally be launched with command line arguments." + }, + { + "name": "Require", + "value": "Require", + "description": "Required to be launched with command line arguments." + } + ] + } + }, + "CreateDeleteProperties": { + "type": "object", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts.", + "properties": { + "rampUpMaximumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "x-nullable": true + }, + "rampUpMinimumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "maximum": 59, + "x-nullable": true + }, + "rampDownMaximumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Maximum number of session hosts that may be created by the Scaling Service. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "x-nullable": true + }, + "rampDownMinimumHostPoolSize": { + "type": "integer", + "format": "int32", + "description": "Minimum number of session hosts that will be be created by the Scaling Service. Scaling will not delete any hosts when this limit is met. This requires the assigned hostpool to have a session host config property.", + "minimum": 0, + "maximum": 59, + "x-nullable": true + } + }, + "x-nullable": true + }, + "CustomInfoPatchProperties": { + "type": "object", + "description": "Custom image information.", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the image." + } + } + }, + "CustomInfoProperties": { + "type": "object", + "description": "Custom image information.", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the image." + } + }, + "required": [ + "resourceId" + ] + }, + "DayOfWeek": { + "type": "string", + "description": "Day of the week. Modeled as string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "DeploymentScope": { + "type": "string", + "description": "DeploymentScope type for HostPool.", + "enum": [ + "Geographical", + "Regional" + ], + "x-ms-enum": { + "name": "DeploymentScope", + "modelAsString": true, + "values": [ + { + "name": "Geographical", + "value": "Geographical", + "description": "For geographical Broker and ArmProvider talking to Geographical SQL DB" + }, + { + "name": "Regional", + "value": "Regional", + "description": "For regional Broker and ArmProvider talking to regional SQL DB" + } + ] + } + }, + "Desktop": { + "type": "object", + "description": "Schema for Desktop properties.", + "properties": { + "properties": { + "$ref": "#/definitions/DesktopProperties", + "description": "Detailed properties for Desktop", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "DesktopList": { + "type": "object", + "description": "List of Desktop definitions.", + "properties": { + "value": { + "type": "array", + "description": "The Desktop items on this page", + "items": { + "$ref": "#/definitions/Desktop" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DesktopPatch": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/DesktopPatchProperties", + "description": "Detailed properties for Desktop" + } + } + }, + "DesktopPatchProperties": { + "type": "object", + "description": "Desktop properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + } + } + }, + "DesktopProperties": { + "type": "object", + "description": "Schema for Desktop properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Desktop. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Desktop." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Desktop." + }, + "iconHash": { + "type": "string", + "description": "Hash of the icon.", + "readOnly": true + }, + "iconContent": { + "type": "string", + "format": "byte", + "description": "The icon a 64 bit string as a byte array.", + "readOnly": true + } + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk settings for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOption", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local", + "description": "Operating system disk local setting." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Gets or sets specifies the ephemeral disk placement for operating system disk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'CacheDisk', 'ResourceDisk'.", + "enum": [ + "CacheDisk", + "ResourceDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "Cache disk placement" + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "Resource disk placement" + } + ] + } + }, + "DiffDiskProperties": { + "type": "object", + "description": "Specifies the ephemeral disk settings for the operating system disk used by the virtual machine.", + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Gets or sets specifies the ephemeral disk placement for operating system disk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Possible values include: 'CacheDisk', 'ResourceDisk'." + } + } + }, + "DirectUDP": { + "type": "string", + "description": "Direct UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DirectUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "DiskInfoProperties": { + "type": "object", + "description": "Disk information.", + "properties": { + "managedDisk": { + "$ref": "#/definitions/ManagedDiskProperties", + "description": "The managed disk parameters." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskProperties", + "description": "Specifies the ephemeral disk settings for the operating system disk used by the virtual machine." + } + } + }, + "DomainInfoPatchProperties": { + "type": "object", + "description": "Domain configurations of session hosts.", + "properties": { + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoPatchProperties", + "description": "Active directory info. Only one should be populated based on the join type." + } + } + }, + "DomainInfoProperties": { + "type": "object", + "description": "Domain configurations of session hosts.", + "properties": { + "joinType": { + "$ref": "#/definitions/DomainJoinType", + "description": "The type of domain join done by the virtual machine." + }, + "activeDirectoryInfo": { + "$ref": "#/definitions/ActiveDirectoryInfoProperties", + "description": "Active directory info. Only one should be populated based on the join type." + }, + "azureActiveDirectoryInfo": { + "$ref": "#/definitions/AzureActiveDirectoryInfoProperties", + "description": "Azure active directory info. Only one should be populated based on the join type." + } + }, + "required": [ + "joinType" + ] + }, + "DomainJoinType": { + "type": "string", + "description": "The type of domain join done by the virtual machine.", + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true, + "values": [ + { + "name": "ActiveDirectory", + "value": "ActiveDirectory", + "description": "Using microsoft active directory." + }, + { + "name": "AzureActiveDirectory", + "value": "AzureActiveDirectory", + "description": "Using microsoft azure active directory." + } + ] + } + }, + "ExpandMsixImage": { + "type": "object", + "description": "Represents the definition of contents retrieved after expanding the MSIX Image.", + "properties": { + "properties": { + "$ref": "#/definitions/ExpandMsixImageProperties", + "description": "Detailed properties for ExpandMsixImage" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "ExpandMsixImageList": { + "type": "object", + "description": "List of MSIX package properties retrieved from MSIX Image expansion.", + "properties": { + "value": { + "type": "array", + "description": "The ExpandMsixImage items on this page", + "items": { + "$ref": "#/definitions/ExpandMsixImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ExpandMsixImageProperties": { + "type": "object", + "description": "Schema for Expand MSIX Image properties.", + "properties": { + "packageAlias": { + "type": "string", + "description": "Alias of MSIX Package." + }, + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share." + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml." + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name." + }, + "packageFullName": { + "type": "string", + "description": "Package Full Name from appxmanifest.xml." + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal." + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed." + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool." + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies.", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [ + "dependencyName" + ] + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Date Package was last updated, found in the appxmanifest.xml." + }, + "packageApplications": { + "type": "array", + "description": "List of package applications.", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [ + "appId" + ] + }, + "certificateName": { + "type": "string", + "description": "Certificate name found in the appxmanifest.xml." + }, + "certificateExpiry": { + "type": "string", + "format": "date-time", + "description": "Date certificate expires, found in the appxmanifest.xml." + } + } + }, + "FailedSessionHostCleanupPolicySHC": { + "type": "string", + "description": "The policy that should be applied when the Session Host provisioning operation fails.", + "enum": [ + "KeepAll", + "KeepOne", + "KeepNone" + ], + "x-ms-enum": { + "name": "FailedSessionHostCleanupPolicySHC", + "modelAsString": true, + "values": [ + { + "name": "KeepAll", + "value": "KeepAll", + "description": "Keep All." + }, + { + "name": "KeepOne", + "value": "KeepOne", + "description": "Keep One." + }, + { + "name": "KeepNone", + "value": "KeepNone", + "description": "Keep None." + } + ] + } + }, + "HealthCheckName": { + "type": "string", + "description": "Represents the name of the health check operation performed.", + "enum": [ + "DomainJoinedCheck", + "DomainTrustCheck", + "FSLogixHealthCheck", + "SxSStackListenerCheck", + "UrlsAccessibleCheck", + "MonitoringAgentCheck", + "DomainReachable", + "WebRTCRedirectorCheck", + "SupportedEncryptionCheck", + "MetaDataServiceCheck", + "AppAttachHealthCheck" + ], + "x-ms-enum": { + "name": "HealthCheckName", + "modelAsString": true, + "values": [ + { + "name": "DomainJoinedCheck", + "value": "DomainJoinedCheck", + "description": "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)" + }, + { + "name": "DomainTrustCheck", + "value": "DomainTrustCheck", + "description": "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)" + }, + { + "name": "FSLogixHealthCheck", + "value": "FSLogixHealthCheck", + "description": "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)" + }, + { + "name": "SxSStackListenerCheck", + "value": "SxSStackListenerCheck", + "description": "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)" + }, + { + "name": "UrlsAccessibleCheck", + "value": "UrlsAccessibleCheck", + "description": "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)" + }, + { + "name": "MonitoringAgentCheck", + "value": "MonitoringAgentCheck", + "description": "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)" + }, + { + "name": "DomainReachable", + "value": "DomainReachable", + "description": "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)" + }, + { + "name": "WebRTCRedirectorCheck", + "value": "WebRTCRedirectorCheck", + "description": "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)" + }, + { + "name": "SupportedEncryptionCheck", + "value": "SupportedEncryptionCheck", + "description": "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)" + }, + { + "name": "MetaDataServiceCheck", + "value": "MetaDataServiceCheck", + "description": "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)" + }, + { + "name": "AppAttachHealthCheck", + "value": "AppAttachHealthCheck", + "description": "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual de-registration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)" + } + ] + } + }, + "HealthCheckResult": { + "type": "string", + "description": "Represents the Health state of the health check we performed.", + "enum": [ + "Unknown", + "HealthCheckSucceeded", + "HealthCheckFailed", + "SessionHostShutdown" + ], + "x-ms-enum": { + "name": "HealthCheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Health check result is not currently known." + }, + { + "name": "HealthCheckSucceeded", + "value": "HealthCheckSucceeded", + "description": "Health check passed." + }, + { + "name": "HealthCheckFailed", + "value": "HealthCheckFailed", + "description": "Health check failed." + }, + { + "name": "SessionHostShutdown", + "value": "SessionHostShutdown", + "description": "We received a Shutdown notification." + } + ] + } + }, + "HostPool": { + "type": "object", + "description": "Represents a HostPool definition.", + "properties": { + "properties": { + "$ref": "#/definitions/HostPoolProperties", + "description": "Detailed properties for HostPool", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "HostPoolList": { + "type": "object", + "description": "List of HostPool definitions.", + "properties": { + "value": { + "type": "array", + "description": "The HostPool items on this page", + "items": { + "$ref": "#/definitions/HostPool" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HostPoolPatch": { + "type": "object", + "description": "HostPool properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/HostPoolPatchProperties", + "description": "HostPool properties that can be patched." + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource.", + "x-nullable": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "HostPoolPatchProperties": { + "type": "object", + "description": "Properties of HostPool.", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "personalDesktopAssignmentType": { + "$ref": "#/definitions/PersonalDesktopAssignmentType", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "loadBalancerType": { + "$ref": "#/definitions/LoadBalancerType", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfoPatch", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "$ref": "#/definitions/SSOSecretType", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "$ref": "#/definitions/PreferredAppGroupType", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "publicNetworkAccess": { + "$ref": "#/definitions/HostpoolPublicNetworkAccess", + "description": "Enabled to allow this resource to be access from the public network" + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdatePatchProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "managedPrivateUDP": { + "$ref": "#/definitions/ManagedPrivateUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "directUDP": { + "$ref": "#/definitions/DirectUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "publicUDP": { + "$ref": "#/definitions/PublicUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "relayUDP": { + "$ref": "#/definitions/RelayUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "allowRDPShortPathWithPrivateLink": { + "$ref": "#/definitions/AllowRDPShortPathWithPrivateLink", + "description": "Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes." + } + } + }, + "HostPoolProperties": { + "type": "object", + "description": "Properties of HostPool.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of HostPool. (internal use)", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of HostPool." + }, + "description": { + "type": "string", + "description": "Description of HostPool." + }, + "hostPoolType": { + "$ref": "#/definitions/HostPoolType", + "description": "HostPool type for desktop." + }, + "personalDesktopAssignmentType": { + "$ref": "#/definitions/PersonalDesktopAssignmentType", + "description": "PersonalDesktopAssignment type for HostPool." + }, + "customRdpProperty": { + "type": "string", + "description": "Custom rdp property of HostPool." + }, + "maxSessionLimit": { + "type": "integer", + "format": "int32", + "description": "The max session limit of HostPool." + }, + "loadBalancerType": { + "$ref": "#/definitions/LoadBalancerType", + "description": "The type of the load balancer." + }, + "ring": { + "type": "integer", + "format": "int32", + "description": "The ring number of HostPool." + }, + "validationEnvironment": { + "type": "boolean", + "description": "Is validation environment." + }, + "registrationInfo": { + "$ref": "#/definitions/RegistrationInfo", + "description": "The registration info of HostPool." + }, + "vmTemplate": { + "type": "string", + "description": "VM template for sessionhosts configuration within hostpool." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "appAttachPackageReferences": { + "type": "array", + "description": "List of App Attach Package links.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ssoadfsAuthority": { + "type": "string", + "description": "URL to customer ADFS server for signing WVD SSO certificates." + }, + "ssoClientId": { + "type": "string", + "description": "ClientId for the registered Relying Party used to issue WVD SSO certificates." + }, + "ssoClientSecretKeyVaultPath": { + "type": "string", + "description": "Path to Azure KeyVault storing the secret used for communication to ADFS." + }, + "ssoSecretType": { + "$ref": "#/definitions/SSOSecretType", + "description": "The type of single sign on Secret Type." + }, + "preferredAppGroupType": { + "$ref": "#/definitions/PreferredAppGroupType", + "description": "The type of preferred application group type, default to Desktop Application Group" + }, + "startVMOnConnect": { + "type": "boolean", + "description": "The flag to turn on/off StartVMOnConnect feature." + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/HostpoolPublicNetworkAccess", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints" + }, + "agentUpdate": { + "$ref": "#/definitions/AgentUpdateProperties", + "description": "The session host configuration for updating agent, monitoring agent, and stack component." + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connection associated with the specified resource", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "managedPrivateUDP": { + "$ref": "#/definitions/ManagedPrivateUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "directUDP": { + "$ref": "#/definitions/DirectUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "publicUDP": { + "$ref": "#/definitions/PublicUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "relayUDP": { + "$ref": "#/definitions/RelayUDP", + "description": "Default: AVD-wide settings are used to determine connection availability, Enabled: UDP will attempt this connection type when making connections. This means that this connection is possible, but is not guaranteed, as there are other factors that may prevent this connection type, Disabled: UDP will not attempt this connection type when making connections" + }, + "managementType": { + "$ref": "#/definitions/ManagementType", + "description": "The type of management for this hostpool, Automated or Standard. The default value is Automated." + }, + "deploymentScope": { + "$ref": "#/definitions/DeploymentScope", + "description": "DeploymentScope type for HostPool." + }, + "oboTenantId": { + "type": "string", + "description": "Tenant that the resource is being requested on behalf of." + }, + "allowRDPShortPathWithPrivateLink": { + "$ref": "#/definitions/AllowRDPShortPathWithPrivateLink", + "description": "Controls if the use of RDPShortPath transport is allowed, possibly bypassing Private Link routes." + } + }, + "required": [ + "hostPoolType", + "loadBalancerType", + "preferredAppGroupType" + ] + }, + "HostPoolProvisioningAction": { + "type": "string", + "description": "Action types for controlling hostpool provisioning.", + "enum": [ + "Cancel" + ], + "x-ms-enum": { + "name": "HostPoolProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "Cancel", + "value": "Cancel", + "description": "Cancel the hostpool provisioning." + } + ] + } + }, + "HostPoolProvisioningControlParameter": { + "type": "object", + "description": "Object containing control action for hostpool provisioning.", + "properties": { + "action": { + "$ref": "#/definitions/HostPoolProvisioningAction", + "description": "Action types for controlling hostpool update." + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host.", + "maxLength": 260 + } + }, + "required": [ + "action" + ] + }, + "HostPoolType": { + "type": "string", + "description": "HostPool type for desktop.", + "enum": [ + "Personal", + "Pooled", + "BYODesktop" + ], + "x-ms-enum": { + "name": "HostPoolType", + "modelAsString": true, + "values": [ + { + "name": "Personal", + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + }, + { + "name": "Pooled", + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "name": "BYODesktop", + "value": "BYODesktop", + "description": "Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct." + } + ] + } + }, + "HostPoolUpdateAction": { + "type": "string", + "description": "Action types for controlling hostpool update.", + "enum": [ + "Start", + "Pause", + "Cancel", + "Retry", + "Resume" + ], + "x-ms-enum": { + "name": "HostPoolUpdateAction", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "Start the hostpool update." + }, + { + "name": "Pause", + "value": "Pause", + "description": "Pause the hostpool update." + }, + { + "name": "Cancel", + "value": "Cancel", + "description": "Cancel the hostpool update." + }, + { + "name": "Retry", + "value": "Retry", + "description": "Retry the hostpool update." + }, + { + "name": "Resume", + "value": "Resume", + "description": "Resume the hostpool update" + } + ] + } + }, + "HostPoolUpdateConfigurationPatchProperties": { + "type": "object", + "description": "The configurations of a hostpool update.", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "maxLength": 260 + } + } + }, + "HostPoolUpdateConfigurationProperties": { + "type": "object", + "description": "The configurations of a hostpool update.", + "properties": { + "deleteOriginalVm": { + "type": "boolean", + "description": "Whether not to save original disk. False by default." + }, + "maxVmsRemoved": { + "type": "integer", + "format": "int32", + "description": "The maximum number of virtual machines to be removed during hostpool update.", + "minimum": 1 + }, + "logOffDelayMinutes": { + "type": "integer", + "format": "int32", + "description": "Grace period before logging off users in minutes." + }, + "logOffMessage": { + "type": "string", + "description": "Log off message sent to user for logoff. Default value is an empty string.", + "default": "", + "maxLength": 260 + } + }, + "required": [ + "maxVmsRemoved", + "logOffDelayMinutes" + ] + }, + "HostPoolUpdateControlParameter": { + "type": "object", + "description": "Object containing control action for hostpool update.", + "properties": { + "action": { + "$ref": "#/definitions/HostPoolUpdateAction", + "description": "Action types for controlling hostpool update." + }, + "cancelMessage": { + "type": "string", + "description": "The cancel message sent to the user on the session host. This is can only be specified if the action is 'Cancel'.", + "maxLength": 260 + } + }, + "required": [ + "action" + ] + }, + "HostpoolPublicNetworkAccess": { + "type": "string", + "description": "Enabled to allow this resource to be access from the public network", + "enum": [ + "Enabled", + "Disabled", + "EnabledForSessionHostsOnly", + "EnabledForClientsOnly" + ], + "x-ms-enum": { + "name": "HostpoolPublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Allows this resource to be accessed from the public network" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Prevents this resource from being accessed from the public network" + }, + { + "name": "EnabledForSessionHostsOnly", + "value": "EnabledForSessionHostsOnly", + "description": "Allows SessionHosts to be accessed from the public network" + }, + { + "name": "EnabledForClientsOnly", + "value": "EnabledForClientsOnly", + "description": "Allows Clients to be accessed from the public network" + } + ] + } + }, + "ImageInfoPatchProperties": { + "type": "object", + "description": "Image configurations of session host in a HostPool", + "properties": { + "type": { + "$ref": "#/definitions/type", + "description": "The type of image session hosts use in the hostpool.", + "x-ms-client-name": "imageType" + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoPatchProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoPatchProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + } + }, + "ImageInfoProperties": { + "type": "object", + "description": "Image configurations of session host in a HostPool", + "properties": { + "type": { + "$ref": "#/definitions/type", + "description": "The type of image session hosts use in the hostpool.", + "x-ms-client-name": "imageType" + }, + "marketplaceInfo": { + "$ref": "#/definitions/MarketplaceInfoProperties", + "description": "The values to uniquely identify a marketplace image. Only one should be populated based on the image type." + }, + "customInfo": { + "$ref": "#/definitions/CustomInfoProperties", + "description": "The values to uniquely identify a custom image. Only one should be populated based on the image type." + } + }, + "required": [ + "type" + ] + }, + "ImportPackageInfoRequest": { + "type": "object", + "description": "Information to import app attach package", + "properties": { + "path": { + "type": "string", + "description": "URI to Image" + }, + "packageArchitecture": { + "$ref": "#/definitions/AppAttachPackageArchitectures", + "description": "Possible device architectures that an app attach package can be configured for" + } + } + }, + "KeyVaultCredentialsPatchProperties": { + "type": "object", + "description": "Credentials kept in the keyvault.", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the password is stored in." + } + } + }, + "KeyVaultCredentialsProperties": { + "type": "object", + "description": "Credentials kept in the keyvault.", + "properties": { + "usernameKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the username is stored in." + }, + "passwordKeyVaultSecretUri": { + "type": "string", + "format": "uri", + "description": "The uri to access the secret that the password is stored in." + } + }, + "required": [ + "usernameKeyVaultSecretUri", + "passwordKeyVaultSecretUri" + ] + }, + "LoadBalancerType": { + "type": "string", + "description": "The type of the load balancer.", + "enum": [ + "BreadthFirst", + "DepthFirst", + "Persistent", + "MultiplePersistent" + ], + "x-ms-enum": { + "name": "LoadBalancerType", + "modelAsString": true, + "values": [ + { + "name": "BreadthFirst", + "value": "BreadthFirst", + "description": "Uses BreadthFirst algorithm for load balancing." + }, + { + "name": "DepthFirst", + "value": "DepthFirst", + "description": "Uses DepthFirst algorithm for load balancing." + }, + { + "name": "Persistent", + "value": "Persistent", + "description": "Maintains persistent connections." + }, + { + "name": "MultiplePersistent", + "value": "MultiplePersistent", + "description": "Maintains multiple persistents connections." + } + ] + } + }, + "LogSpecification": { + "type": "object", + "description": "Specifications of the Log for Azure Monitoring", + "properties": { + "name": { + "type": "string", + "description": "Name of the log" + }, + "displayName": { + "type": "string", + "description": "Localized friendly display name of the log" + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of the log" + } + } + }, + "MSIXImageURI": { + "type": "object", + "description": "Represents URI referring to MSIX Image", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "URI to Image" + } + } + }, + "MSIXPackage": { + "type": "object", + "description": "Schema for MSIX Package properties.", + "properties": { + "properties": { + "$ref": "#/definitions/MSIXPackageProperties", + "description": "Detailed properties for MSIX Package", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "MSIXPackageList": { + "type": "object", + "description": "List of MSIX Package definitions.", + "properties": { + "value": { + "type": "array", + "description": "The MSIXPackage items on this page", + "items": { + "$ref": "#/definitions/MSIXPackage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MSIXPackagePatch": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/MSIXPackagePatchProperties", + "description": "Detailed properties for MSIX Package" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "MSIXPackagePatchProperties": { + "type": "object", + "description": "MSIX Package properties that can be patched.", + "properties": { + "isActive": { + "type": "boolean", + "description": "Set a version of the package to be active across hostpool." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Set Registration mode. Regular or Delayed." + }, + "displayName": { + "type": "string", + "description": "Display name for MSIX Package." + } + } + }, + "MSIXPackageProperties": { + "type": "object", + "description": "Schema for MSIX Package properties.", + "properties": { + "imagePath": { + "type": "string", + "description": "VHD/CIM image path on Network Share." + }, + "packageName": { + "type": "string", + "description": "Package Name from appxmanifest.xml." + }, + "packageFamilyName": { + "type": "string", + "description": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name." + }, + "displayName": { + "type": "string", + "description": "User friendly Name to be displayed in the portal." + }, + "packageRelativePath": { + "type": "string", + "description": "Relative Path to the package inside the image." + }, + "isRegularRegistration": { + "type": "boolean", + "description": "Specifies how to register Package in feed." + }, + "isActive": { + "type": "boolean", + "description": "Make this version of the package the active one across the hostpool." + }, + "packageDependencies": { + "type": "array", + "description": "List of package dependencies.", + "items": { + "$ref": "#/definitions/MsixPackageDependencies" + }, + "x-ms-identifiers": [ + "dependencyName" + ] + }, + "version": { + "type": "string", + "description": "Package version found in the appxmanifest.xml." + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Date Package was last updated, found in the appxmanifest.xml." + }, + "packageApplications": { + "type": "array", + "description": "List of package applications.", + "items": { + "$ref": "#/definitions/MsixPackageApplications" + }, + "x-ms-identifiers": [ + "appId" + ] + } + } + }, + "MaintenanceWindowPatchProperties": { + "type": "object", + "description": "Maintenance window starting hour and day of week.", + "properties": { + "hour": { + "type": "integer", + "format": "int32", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of the week." + } + } + }, + "MaintenanceWindowProperties": { + "type": "object", + "description": "Maintenance window starting hour and day of week.", + "properties": { + "hour": { + "type": "integer", + "format": "int32", + "description": "The update start hour of the day. (0 - 23)" + }, + "dayOfWeek": { + "$ref": "#/definitions/DayOfWeek", + "description": "Day of the week." + } + } + }, + "ManagedDiskProperties": { + "type": "object", + "description": "Managed Disk information.", + "properties": { + "type": { + "$ref": "#/definitions/VirtualMachineDiskType", + "description": "Managed Disk information." + } + } + }, + "ManagedPrivateUDP": { + "type": "string", + "description": "Managed Private UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedPrivateUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "ManagementType": { + "type": "string", + "description": "The type of management for the hostpool", + "enum": [ + "Automated", + "Standard" + ], + "x-ms-enum": { + "name": "ManagementType", + "modelAsString": true, + "values": [ + { + "name": "Automated", + "value": "Automated", + "description": "Automated management of the hostpool" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard management of the hostpool" + } + ] + } + }, + "MarketplaceInfoPatchProperties": { + "type": "object", + "description": "Marketplace image information.", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The SKU of the image." + }, + "exactVersion": { + "type": "string", + "description": "The version of the image." + } + } + }, + "MarketplaceInfoProperties": { + "type": "object", + "description": "Marketplace image information.", + "properties": { + "offer": { + "type": "string", + "description": "The offer of the image." + }, + "publisher": { + "type": "string", + "description": "The publisher of the image." + }, + "sku": { + "type": "string", + "description": "The SKU of the image." + }, + "exactVersion": { + "type": "string", + "description": "The version of the image." + } + }, + "required": [ + "offer", + "publisher", + "sku", + "exactVersion" + ] + }, + "MsixPackageApplications": { + "type": "object", + "description": "Schema for MSIX Package Application properties.", + "properties": { + "appId": { + "type": "string", + "description": "Package Application Id, found in appxmanifest.xml." + }, + "description": { + "type": "string", + "description": "Description of Package Application." + }, + "appUserModelID": { + "type": "string", + "description": "Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name." + }, + "iconImageName": { + "type": "string", + "description": "User friendly name." + }, + "rawIcon": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + }, + "rawPng": { + "type": "string", + "format": "byte", + "description": "the icon a 64 bit string as a byte array." + } + } + }, + "MsixPackageDependencies": { + "type": "object", + "description": "Schema for MSIX Package Dependencies properties.", + "properties": { + "dependencyName": { + "type": "string", + "description": "Name of package dependency." + }, + "publisher": { + "type": "string", + "description": "Name of dependency publisher." + }, + "minVersion": { + "type": "string", + "description": "Dependency version required." + } + } + }, + "NetworkInfoPatchProperties": { + "type": "object", + "description": "Network information.", + "properties": { + "subnetId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)." + } + } + }, + "NetworkInfoProperties": { + "type": "object", + "description": "Network information.", + "properties": { + "subnetId": { + "type": "string", + "format": "arm-id", + "description": "The resource ID of the subnet." + }, + "securityGroupId": { + "type": "string", + "description": "The resource ID of the security group. Any allowable/open ports should be specified in the Network Security Group(NSG)." + } + }, + "required": [ + "subnetId" + ] + }, + "OperationProperties": { + "type": "object", + "description": "Properties of the operation", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification payload" + } + } + }, + "PersonalDesktopAssignmentType": { + "type": "string", + "description": "PersonalDesktopAssignment type for HostPool.", + "enum": [ + "Automatic", + "Direct" + ], + "x-ms-enum": { + "name": "PersonalDesktopAssignmentType", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatically assigns an available personal desktop to the user." + }, + { + "name": "Direct", + "value": "Direct", + "description": "Manually assigns a specific personal desktop to the user." + } + ] + } + }, + "PreferredAppGroupType": { + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Internal Use Only" + }, + { + "name": "Desktop", + "value": "Desktop", + "description": "Use Desktop Application Group" + }, + { + "name": "RailApplications", + "value": "RailApplications", + "description": "Use RailApplications (RemoteApp)" + } + ] + } + }, + "PrivateEndpoint": { + "type": "object", + "description": "The private endpoint resource.", + "properties": { + "id": { + "type": "string", + "description": "The ARM identifier for private endpoint.", + "readOnly": true + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "The private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "PrivateEndpointConnectionListResultWithSystemData": { + "type": "object", + "description": "List of private endpoint connection associated with the specified HostPool", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnectionWithSystemData items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionWithSystemData" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of the private endpoint connection.", + "properties": { + "groupIds": { + "type": "array", + "description": "The group ids for the private endpoint resource.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint resource." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource.", + "readOnly": true + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning was successful" + }, + { + "name": "Creating", + "value": "Creating", + "description": "A PrivateEndpointConnection is being created" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "A PrivateEndpointConnection is being deleted" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning failed" + } + ] + }, + "readOnly": true + }, + "PrivateEndpointConnectionWithSystemData": { + "type": "object", + "description": "The Private Endpoint Connection resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Connection is Pending" + }, + { + "name": "Approved", + "value": "Approved", + "description": "Connection was Approved" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Connection was rejected" + } + ] + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A private link resource", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResourceProperties": { + "type": "object", + "description": "Properties of a private link resource.", + "properties": { + "groupId": { + "type": "string", + "description": "The private link resource group id.", + "readOnly": true + }, + "requiredMembers": { + "type": "array", + "description": "The private link resource required member names.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "description": "The private link resource Private link DNS zone name.", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "A collection of information about the state of the connection between service consumer and provider.", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Provisioning", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning Successful" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning in Progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning Failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning was Canceled" + } + ] + }, + "readOnly": true + }, + "ProvisioningStateSHC": { + "type": "string", + "description": "Provisioning state of the Session Host Configuration.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningStateSHC", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning Successful" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning Failed" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning was Canceled" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning in Progress" + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Enabled to allow this resource to be access from the public network", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "This resource is accessible from the public network." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "This resource is not accessible from the public network." + } + ] + } + }, + "PublicUDP": { + "type": "string", + "description": "Public UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "RegistrationInfo": { + "type": "object", + "description": "Represents a RegistrationInfo definition.", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + }, + "registrationTokenOperation": { + "$ref": "#/definitions/RegistrationTokenOperation", + "description": "The type of resetting the token." + } + } + }, + "RegistrationInfoPatch": { + "type": "object", + "description": "Represents a RegistrationInfo definition.", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiration time of registration token." + }, + "registrationTokenOperation": { + "$ref": "#/definitions/RegistrationTokenOperation", + "description": "The type of resetting the token." + } + } + }, + "RegistrationTokenList": { + "type": "object", + "description": "List of RegistrationToken definitions.", + "properties": { + "value": { + "type": "array", + "description": "List of RegistrationToken definitions.", + "items": { + "$ref": "#/definitions/RegistrationTokenMinimal" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "Link to the next page of results.", + "readOnly": true + } + } + }, + "RegistrationTokenMinimal": { + "type": "object", + "description": "Represents a Minimal set of properties for RegistrationToken definition.", + "properties": { + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiration time of registration token." + }, + "token": { + "type": "string", + "description": "The registration token base64 encoded string." + } + } + }, + "RegistrationTokenOperation": { + "type": "string", + "description": "The type of resetting the token.", + "enum": [ + "Delete", + "None", + "Update" + ], + "x-ms-enum": { + "name": "RegistrationTokenOperation", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "Delete operation" + }, + { + "name": "None", + "value": "None", + "description": "No Operation" + }, + { + "name": "Update", + "value": "Update", + "description": "Update Operation" + } + ] + } + }, + "RelayUDP": { + "type": "string", + "description": "Relay UDP Connection Settings", + "enum": [ + "Default", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "RelayUDP", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "AVD-wide settings are used to determine connection availability" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "UDP will attempt this connection type when making connections." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UDP will not attempt this connection type when making connections" + } + ] + } + }, + "RemoteApplicationType": { + "type": "string", + "description": "Resource Type of Application.", + "enum": [ + "InBuilt", + "MsixApplication" + ], + "x-ms-enum": { + "name": "RemoteApplicationType", + "modelAsString": true, + "values": [ + { + "name": "InBuilt", + "value": "InBuilt", + "description": "Built-in applications" + }, + { + "name": "MsixApplication", + "value": "MsixApplication", + "description": "Imported MSIX application packages" + } + ] + } + }, + "ResourceProviderOperation": { + "type": "object", + "description": "Supported operation of this resource provider.", + "properties": { + "name": { + "type": "string", + "description": "Operation name, in format of {provider}/{resource}/{operation}" + }, + "display": { + "$ref": "#/definitions/ResourceProviderOperationDisplay", + "description": "Display metadata associated with the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Is a data action." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of the operation" + } + } + }, + "ResourceProviderOperationDisplay": { + "type": "object", + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Resource provider: Microsoft Desktop Virtualization." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "Type of operation: get, read, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of this operation." + } + } + }, + "ResourceProviderOperationListResult": { + "type": "object", + "description": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceProviderOperation items on this page", + "items": { + "$ref": "#/definitions/ResourceProviderOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SSOSecretType": { + "type": "string", + "description": "The type of single sign on Secret Type.", + "enum": [ + "SharedKey", + "Certificate", + "SharedKeyInKeyVault", + "CertificateInKeyVault" + ], + "x-ms-enum": { + "name": "SSOSecretType", + "modelAsString": true, + "values": [ + { + "name": "SharedKey", + "value": "SharedKey", + "description": "The SSO Secret is a Shared Key." + }, + { + "name": "Certificate", + "value": "Certificate", + "description": "The SSO Secret is a Certificate." + }, + { + "name": "SharedKeyInKeyVault", + "value": "SharedKeyInKeyVault", + "description": "The SSO Secret is a SharedKey that is stored in KeyVault." + }, + { + "name": "CertificateInKeyVault", + "value": "CertificateInKeyVault", + "description": "The SSO Secret is a Certificate that is stored in KeyVault." + } + ] + } + }, + "ScalingHostPoolReference": { + "type": "object", + "description": "Scaling plan reference to hostpool.", + "properties": { + "hostPoolArmPath": { + "type": "string", + "description": "Arm path of referenced hostpool." + }, + "scalingPlanEnabled": { + "type": "boolean", + "description": "Is the scaling plan enabled for this hostpool." + } + } + }, + "ScalingMethodType": { + "type": "string", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool.", + "enum": [ + "PowerManage", + "CreateDeletePowerManage" + ], + "x-ms-enum": { + "name": "ScalingMethodType", + "modelAsString": true, + "values": [ + { + "name": "PowerManage", + "value": "PowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size." + }, + { + "name": "CreateDeletePowerManage", + "value": "CreateDeletePowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, as well as creating and deleting hosts that will change the host pool size. This requires the createDelete property to be set, and the assigned hostpool to have a session host config property." + } + ] + } + }, + "ScalingPlan": { + "type": "object", + "description": "Represents a scaling plan definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanProperties", + "description": "Detailed properties for scaling plan.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "ScalingPlanList": { + "type": "object", + "description": "List of scaling plan definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ScalingPlan items on this page", + "items": { + "$ref": "#/definitions/ScalingPlan" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScalingPlanPatch": { + "type": "object", + "description": "Scaling plan properties that can be patched.", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ScalingPlanPatchProperties", + "description": "Detailed properties for scaling plan" + } + } + }, + "ScalingPlanPatchProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + }, + "x-ms-identifiers": [ + "hostPoolArmPath" + ] + } + } + }, + "ScalingPlanPersonalSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPersonalSchedule definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPersonalScheduleProperties", + "description": "Detailed properties for ScalingPlanPersonalSchedule", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ScalingPlanPersonalScheduleList": { + "type": "object", + "description": "List of ScalingPlanPersonalSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ScalingPlanPersonalSchedule items on this page", + "items": { + "$ref": "#/definitions/ScalingPlanPersonalSchedule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScalingPlanPersonalSchedulePatch": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPersonalSchedulePatchProperties", + "description": "Detailed properties for ScalingPlanPersonalSchedule" + } + } + }, + "ScalingPlanPersonalSchedulePatchProperties": { + "type": "object", + "description": "ScalingPlanPersonalSchedule properties that can be patched.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "$ref": "#/definitions/StartupBehavior", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampUpActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.", + "minimum": 0 + }, + "rampUpActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.", + "minimum": 0 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "peakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.", + "minimum": 0 + }, + "peakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.", + "minimum": 0 + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampDownActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.", + "minimum": 0 + }, + "rampDownActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.", + "minimum": 0 + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "offPeakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.", + "minimum": 0 + }, + "offPeakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.", + "minimum": 0 + } + } + }, + "ScalingPlanPersonalScheduleProperties": { + "type": "object", + "description": "A ScalingPlanPersonalSchedule.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpAutoStartHosts": { + "$ref": "#/definitions/StartupBehavior", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool." + }, + "rampUpStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp up phase. If this is disabled, session hosts must be turned on using rampUpAutoStartHosts or by turning them on manually.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampUpActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp up period." + }, + "rampUpMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp up period.", + "minimum": 0 + }, + "rampUpActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp up period." + }, + "rampUpMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp up period.", + "minimum": 0 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "peakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the peak period." + }, + "peakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the peak period.", + "minimum": 0 + }, + "peakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the peak period." + }, + "peakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the peak period.", + "minimum": 0 + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the ramp down phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "rampDownActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the ramp down period." + }, + "rampDownMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the ramp down period.", + "minimum": 0 + }, + "rampDownActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the ramp down period." + }, + "rampDownMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the ramp down period.", + "minimum": 0 + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakStartVMOnConnect": { + "type": "string", + "description": "The desired configuration of Start VM On Connect for the hostpool during the off-peak phase.", + "default": "Enable", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SetStartVMOnConnect", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Start VM on Connect is enabled" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually" + } + ] + } + }, + "offPeakActionOnDisconnect": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a user disconnect during the off-peak period." + }, + "offPeakMinutesToWaitOnDisconnect": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user disconnects during the off-peak period.", + "minimum": 0 + }, + "offPeakActionOnLogoff": { + "$ref": "#/definitions/SessionHandlingOperation", + "description": "Action to be taken after a logoff during the off-peak period." + }, + "offPeakMinutesToWaitOnLogoff": { + "type": "integer", + "format": "int32", + "description": "The time in minutes to wait before performing the desired session handling action when a user logs off during the off-peak period.", + "minimum": 0 + } + } + }, + "ScalingPlanPooledSchedule": { + "type": "object", + "description": "Represents a ScalingPlanPooledSchedule definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPooledScheduleProperties", + "description": "Detailed properties for ScalingPlanPooledSchedule", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "ScalingPlanPooledScheduleList": { + "type": "object", + "description": "List of ScalingPlanPooledSchedule definitions.", + "properties": { + "value": { + "type": "array", + "description": "The ScalingPlanPooledSchedule items on this page", + "items": { + "$ref": "#/definitions/ScalingPlanPooledSchedule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ScalingPlanPooledSchedulePatch": { + "type": "object", + "description": "ScalingPlanPooledSchedule properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/ScalingPlanPooledSchedulePatchProperties", + "description": "Detailed properties for ScalingPlanPooledSchedule" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "ScalingPlanPooledSchedulePatchProperties": { + "type": "object", + "description": "A ScalingPlanPooledSchedule that can be patched.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule", + "readOnly": true + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "scalingMethod": { + "$ref": "#/definitions/ScalingMethodType", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool." + }, + "createDelete": { + "$ref": "#/definitions/CreateDeleteProperties", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts." + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp up period.", + "minimum": 0, + "maximum": 100 + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp up period.", + "minimum": 1, + "maximum": 100 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp down period.", + "minimum": 0, + "maximum": 100 + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp down period.", + "minimum": 1, + "maximum": 100 + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "$ref": "#/definitions/StopHostsWhen", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanPooledScheduleProperties": { + "type": "object", + "description": "A ScalingPlanPooledSchedule.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule", + "readOnly": true + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "scalingMethod": { + "type": "string", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool.", + "default": "PowerManage", + "enum": [ + "PowerManage", + "CreateDeletePowerManage" + ], + "x-ms-enum": { + "name": "ScalingMethodType", + "modelAsString": true, + "values": [ + { + "name": "PowerManage", + "value": "PowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size." + }, + { + "name": "CreateDeletePowerManage", + "value": "CreateDeletePowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, as well as creating and deleting hosts that will change the host pool size. This requires the createDelete property to be set, and the assigned hostpool to have a session host config property." + } + ] + } + }, + "createDelete": { + "$ref": "#/definitions/CreateDeleteProperties", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts." + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp up period.", + "minimum": 0, + "maximum": 100 + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp up period.", + "minimum": 1, + "maximum": 100 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp down period.", + "minimum": 0, + "maximum": 100 + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp down period.", + "minimum": 1, + "maximum": 100 + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "$ref": "#/definitions/StopHostsWhen", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "ScalingPlanProperties": { + "type": "object", + "description": "Scaling plan properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of scaling plan. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of scaling plan." + }, + "friendlyName": { + "type": "string", + "description": "User friendly name of scaling plan." + }, + "timeZone": { + "type": "string", + "description": "Timezone of the scaling plan." + }, + "hostPoolType": { + "type": "string", + "description": "HostPool type for desktop.", + "default": "Pooled", + "enum": [ + "Pooled", + "Personal" + ], + "x-ms-enum": { + "name": "ScalingHostPoolType", + "modelAsString": true, + "values": [ + { + "name": "Pooled", + "value": "Pooled", + "description": "Users get a new (random) SessionHost every time it connects to the HostPool." + }, + { + "name": "Personal", + "value": "Personal", + "description": "Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost." + } + ] + } + }, + "exclusionTag": { + "type": "string", + "description": "Exclusion tag for scaling plan." + }, + "schedules": { + "type": "array", + "description": "List of ScalingPlanPooledSchedule definitions.", + "items": { + "$ref": "#/definitions/ScalingSchedule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostPoolReferences": { + "type": "array", + "description": "List of ScalingHostPoolReference definitions.", + "items": { + "$ref": "#/definitions/ScalingHostPoolReference" + }, + "x-ms-identifiers": [ + "hostPoolArmPath" + ] + } + }, + "required": [ + "timeZone" + ] + }, + "ScalingSchedule": { + "type": "object", + "description": "A ScalingPlanPooledSchedule.", + "properties": { + "name": { + "type": "string", + "description": "Name of the ScalingPlanPooledSchedule." + }, + "daysOfWeek": { + "type": "array", + "description": "Set of days of the week on which this schedule is active.", + "items": { + "$ref": "#/definitions/DayOfWeek" + } + }, + "scalingMethod": { + "type": "string", + "description": "The desired scaling method to be used to scale the hosts in the assigned host pool.", + "default": "PowerManage", + "enum": [ + "PowerManage", + "CreateDeletePowerManage" + ], + "x-ms-enum": { + "name": "ScalingMethodType", + "modelAsString": true, + "values": [ + { + "name": "PowerManage", + "value": "PowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, but will not change the host pool size." + }, + { + "name": "CreateDeletePowerManage", + "value": "CreateDeletePowerManage", + "description": "Scaling will manage hosts in the host pool by power managing the hosts, as well as creating and deleting hosts that will change the host pool size. This requires the createDelete property to be set, and the assigned hostpool to have a session host config property." + } + ] + } + }, + "createDelete": { + "$ref": "#/definitions/CreateDeleteProperties", + "description": "The properties that control how Scaling will manage the size of the hostpool by creating and deleting hosts." + }, + "rampUpStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp up period." + }, + "rampUpLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp up period." + }, + "rampUpMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp up period.", + "minimum": 0, + "maximum": 100 + }, + "rampUpCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp up period.", + "minimum": 1, + "maximum": 100 + }, + "peakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for peak period." + }, + "peakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for peak period." + }, + "rampDownStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for ramp down period." + }, + "rampDownLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for ramp down period." + }, + "rampDownMinimumHostsPct": { + "type": "integer", + "format": "int32", + "description": "Minimum host percentage for ramp down period.", + "minimum": 0, + "maximum": 100 + }, + "rampDownCapacityThresholdPct": { + "type": "integer", + "format": "int32", + "description": "Capacity threshold for ramp down period.", + "minimum": 1, + "maximum": 100 + }, + "rampDownForceLogoffUsers": { + "type": "boolean", + "description": "Should users be logged off forcefully from hosts." + }, + "rampDownStopHostsWhen": { + "$ref": "#/definitions/StopHostsWhen", + "description": "Specifies when to stop hosts during ramp down period." + }, + "rampDownWaitTimeMinutes": { + "type": "integer", + "format": "int32", + "description": "Number of minutes to wait to stop hosts during ramp down period." + }, + "rampDownNotificationMessage": { + "type": "string", + "description": "Notification message for users during ramp down period." + }, + "offPeakStartTime": { + "$ref": "#/definitions/Time", + "description": "Starting time for off-peak period." + }, + "offPeakLoadBalancingAlgorithm": { + "$ref": "#/definitions/SessionHostLoadBalancingAlgorithm", + "description": "Load balancing algorithm for off-peak period." + } + } + }, + "SecurityInfoPatchProperties": { + "type": "object", + "description": "Security Information.", + "properties": { + "type": { + "$ref": "#/definitions/VirtualMachineSecurityType", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard." + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTpm on the virtual machine." + } + } + }, + "SecurityInfoProperties": { + "type": "object", + "description": "Security Information.", + "properties": { + "type": { + "type": "string", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard.", + "default": "Standard", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot and vTpm" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + } + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Whether to use secureBoot on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Whether to use vTpm on the virtual machine." + } + } + }, + "SendMessage": { + "type": "object", + "description": "Represents message sent to a UserSession.", + "properties": { + "messageTitle": { + "type": "string", + "description": "Title of message." + }, + "messageBody": { + "type": "string", + "description": "Body of message." + } + } + }, + "ServiceSpecification": { + "type": "object", + "description": "Service specification payload", + "properties": { + "logSpecifications": { + "type": "array", + "description": "Specifications of the Log for Azure Monitoring", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "SessionHandlingOperation": { + "type": "string", + "description": "Action to be taken after a user disconnect during the ramp up period.", + "enum": [ + "None", + "Deallocate", + "Hibernate" + ], + "x-ms-enum": { + "name": "SessionHandlingOperation", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No action will be taken after disconnect" + }, + { + "name": "Deallocate", + "value": "Deallocate", + "description": "Session Host will be deallocated after disconnect" + }, + { + "name": "Hibernate", + "value": "Hibernate", + "description": "Session Host will hibernate after disconnect" + } + ] + } + }, + "SessionHost": { + "type": "object", + "description": "Represents a SessionHost definition.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostProperties", + "description": "Detailed properties for SessionHost", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "SessionHostComponentUpdateType": { + "type": "string", + "description": "The type of maintenance for session host components.", + "enum": [ + "Default", + "Scheduled" + ], + "x-ms-enum": { + "name": "SessionHostComponentUpdateType", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "TenantAdmin have opted in for Scheduled Component Update feature." + } + ] + } + }, + "SessionHostConfiguration": { + "type": "object", + "description": "Schema for SessionHostConfiguration properties.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostConfigurationProperties", + "description": "Detailed properties for SessionHostConfiguration", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "SessionHostConfigurationList": { + "type": "object", + "description": "List of SessionHostConfiguration definitions.", + "properties": { + "value": { + "type": "array", + "description": "The SessionHostConfiguration items on this page", + "items": { + "$ref": "#/definitions/SessionHostConfiguration" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionHostConfigurationPatch": { + "type": "object", + "description": "SessionHostConfiguration properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostConfigurationPatchProperties", + "description": "Detailed properties for SessionHostConfiguration" + } + } + }, + "SessionHostConfigurationPatchProperties": { + "type": "object", + "description": "Session host configurations of HostPool.", + "properties": { + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "vmTags": { + "type": "object", + "description": "Hashtable that lists key/value pair tags to apply to the VMs", + "additionalProperties": { + "type": "string" + } + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3].", + "items": { + "type": "integer", + "format": "int32" + } + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoPatchProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk Information" + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoPatchProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoPatchProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoPatchProperties", + "description": "Security Information" + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsPatchProperties", + "description": "Local Admin credentials for session hosts.\"" + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoPatchProperties", + "description": "Boot Diagnostics Information" + } + } + }, + "SessionHostConfigurationProperties": { + "type": "object", + "description": "Session host configurations of HostPool.", + "properties": { + "version": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "friendlyName": { + "type": "string", + "description": "Friendly name to describe this version of the SessionHostConfiguration.", + "maxLength": 260 + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateSHC", + "description": "Provisioning state of the Session Host Configuration.", + "readOnly": true + }, + "vmTags": { + "type": "object", + "description": "Hashtable that lists key/value pair tags to apply to the VMs", + "additionalProperties": { + "type": "string" + } + }, + "vmLocation": { + "type": "string", + "description": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided" + }, + "vmResourceGroup": { + "type": "string", + "description": "The ResourceGroup for the session hosts to be created in. It will default to the ResourceGroup of the hostpool if not provided." + }, + "vmNamePrefix": { + "type": "string", + "description": "The prefix that should be associated with session host names", + "maxLength": 11 + }, + "availabilityZones": { + "type": "array", + "description": "Value for availability zones to be used by the session host. Should be from [1,2,3].", + "items": { + "type": "integer", + "format": "int32" + } + }, + "networkInfo": { + "$ref": "#/definitions/NetworkInfoProperties", + "description": "Network information." + }, + "vmSizeId": { + "type": "string", + "description": "The id of the size of a virtual machine connected to a hostpool. Example: Standard_D2as_v6" + }, + "diskInfo": { + "$ref": "#/definitions/DiskInfoProperties", + "description": "Disk Information" + }, + "customConfigurationScriptUrl": { + "type": "string", + "format": "uri", + "description": "The uri to the storage blob containing the arm template to be run on the virtual machine after provisioning." + }, + "imageInfo": { + "$ref": "#/definitions/ImageInfoProperties", + "description": "Image configurations of HostPool." + }, + "domainInfo": { + "$ref": "#/definitions/DomainInfoProperties", + "description": "Domain configurations of session hosts." + }, + "securityInfo": { + "$ref": "#/definitions/SecurityInfoProperties", + "description": "Security Information" + }, + "vmAdminCredentials": { + "$ref": "#/definitions/KeyVaultCredentialsProperties", + "description": "Local Admin credentials for session hosts.\"" + }, + "bootDiagnosticsInfo": { + "$ref": "#/definitions/BootDiagnosticsInfoProperties", + "description": "Boot Diagnostics Information" + } + }, + "required": [ + "vmNamePrefix", + "networkInfo", + "vmSizeId", + "diskInfo", + "imageInfo", + "domainInfo", + "vmAdminCredentials" + ] + }, + "SessionHostHealthCheckFailureDetails": { + "type": "object", + "description": "Contains details on the failure.", + "properties": { + "message": { + "type": "string", + "description": "Failure message: hints on what is wrong and how to recover.", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int32", + "description": "Error code corresponding for the failure.", + "readOnly": true + }, + "lastHealthCheckDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + } + } + }, + "SessionHostHealthCheckReport": { + "type": "object", + "description": "The report for session host information.", + "properties": { + "healthCheckName": { + "$ref": "#/definitions/HealthCheckName", + "description": "Represents the name of the health check operation performed.", + "readOnly": true + }, + "healthCheckResult": { + "$ref": "#/definitions/HealthCheckResult", + "description": "Represents the Health state of the health check we performed.", + "readOnly": true + }, + "additionalFailureDetails": { + "$ref": "#/definitions/SessionHostHealthCheckFailureDetails", + "description": "Additional detailed information on the failure.", + "readOnly": true + } + } + }, + "SessionHostList": { + "type": "object", + "description": "List of SessionHost definitions.", + "properties": { + "value": { + "type": "array", + "description": "The SessionHost items on this page", + "items": { + "$ref": "#/definitions/SessionHost" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionHostLoadBalancingAlgorithm": { + "type": "string", + "description": "Load balancing algorithm for ramp up period.", + "enum": [ + "BreadthFirst", + "DepthFirst" + ], + "x-ms-enum": { + "name": "SessionHostLoadBalancingAlgorithm", + "modelAsString": true, + "values": [ + { + "name": "BreadthFirst", + "value": "BreadthFirst", + "description": "Breadth First Algorithm for Load Balancing" + }, + { + "name": "DepthFirst", + "value": "DepthFirst", + "description": "Depth First Algorithm for Load Balancing" + } + ] + } + }, + "SessionHostManagement": { + "type": "object", + "description": "Schema for SessionHostManagement properties.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostManagementProperties", + "description": "Detailed properties for SessionHostManagement", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "SessionHostManagementList": { + "type": "object", + "description": "List of SessionHostManagement definitions.", + "properties": { + "value": { + "type": "array", + "description": "The SessionHostManagement items on this page", + "items": { + "$ref": "#/definitions/SessionHostManagement" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SessionHostManagementOperationProgress": { + "type": "object", + "description": "SessionHostManagement Operation Progress information.", + "properties": { + "executionStartTime": { + "type": "string", + "format": "date-time", + "description": "Time that the sessionHostManagement operation was created." + }, + "totalSessionHosts": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts to be started in the sessionHostManagement operation." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement operation" + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement operation." + }, + "sessionHostsRollbackFailed": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts rollback failed in the sessionHostManagement operation." + } + } + }, + "SessionHostManagementPatch": { + "type": "object", + "description": "SessionHostManagement properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostManagementPatchProperties", + "description": "Detailed properties for SessionHostManagement" + } + } + }, + "SessionHostManagementPatchProperties": { + "type": "object", + "description": "Represents a SessionHostManagementPatch definition.", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "Parameters for a hostpool update." + }, + "provisioning": { + "$ref": "#/definitions/SessionHostProvisioningConfigurationPatchProperties", + "description": "Parameters that apply when session hosts are provisioned." + }, + "failedSessionHostCleanupPolicy": { + "$ref": "#/definitions/FailedSessionHostCleanupPolicySHC", + "description": "The policy that should be applied when the Session Host provisioning operation fails." + } + } + }, + "SessionHostManagementProperties": { + "type": "object", + "description": "Session Host Managements of HostPool.", + "properties": { + "scheduledDateTimeZone": { + "type": "string", + "description": "Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationProperties", + "description": "Parameters for a hostpool update." + }, + "provisioning": { + "$ref": "#/definitions/SessionHostProvisioningConfigurationProperties", + "description": "Parameters that apply when session hosts are provisioned." + }, + "failedSessionHostCleanupPolicy": { + "$ref": "#/definitions/FailedSessionHostCleanupPolicySHC", + "description": "The policy that should be applied when the Session Host provisioning operation fails." + } + }, + "required": [ + "scheduledDateTimeZone", + "update" + ] + }, + "SessionHostManagementProvisioningOperationProgress": { + "type": "object", + "description": "SessionHostManagement Provisioning Operation Progress information.", + "properties": { + "executionStartTime": { + "type": "string", + "format": "date-time", + "description": "Time that the sessionHostManagement operation was created." + }, + "sessionHostsInProgress": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts in progress in the sessionHostManagement provisioning operation" + }, + "sessionHostsCompleted": { + "type": "integer", + "format": "int32", + "description": "The number of sessionHosts completed in the sessionHostManagement provisioning operation." + }, + "finalSessionHostsCount": { + "type": "integer", + "format": "int32", + "description": "The final instance count of the host pool for this provisioning operation." + }, + "initialSessionHostsCount": { + "type": "integer", + "format": "int32", + "description": "The initial instance count of the host pool for this provisioning operation." + } + } + }, + "SessionHostManagementProvisioningOperationStatus": { + "type": "string", + "description": "Operation status for SessionHostManagementUpdate.", + "enum": [ + "Scheduled", + "ValidatingSessionHostProvisioning", + "Cancelling", + "ProvisioningSessionHosts", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "SessionHostManagementProvisioningOperationStatus", + "modelAsString": true, + "values": [ + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The operation is scheduled." + }, + { + "name": "ValidatingSessionHostProvisioning", + "value": "ValidatingSessionHostProvisioning", + "description": "The operation is currently validating the provisioning." + }, + { + "name": "Cancelling", + "value": "Cancelling", + "description": "Canceling the operation." + }, + { + "name": "ProvisioningSessionHosts", + "value": "ProvisioningSessionHosts", + "description": "The operation is currently provisioning session hosts." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation is canceled." + } + ] + }, + "readOnly": true + }, + "SessionHostManagementProvisioningStatus": { + "type": "object", + "description": "Schema for SessionHostManagementUpdateStatus properties.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ID for the async operation." + }, + "name": { + "type": "string", + "description": "Name of the async operation." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation." + }, + "error": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "description": "If present, details of the operation error." + }, + "status": { + "$ref": "#/definitions/SessionHostManagementProvisioningOperationStatus", + "description": "Operation status." + }, + "properties": { + "$ref": "#/definitions/SessionHostManagementProvisioningStatusProperties", + "description": "The custom properties of the SessionHost Provisioning Status." + } + }, + "required": [ + "status" + ] + }, + "SessionHostManagementProvisioningStatusProperties": { + "type": "object", + "description": "Properties bag for sessionHostManagement Provisioning Statuses.", + "properties": { + "correlationId": { + "type": "string", + "description": "The correlation Id for Log Analytics." + }, + "progress": { + "$ref": "#/definitions/SessionHostManagementProvisioningOperationProgress", + "description": "Progress information on the sessionHostManagement operation." + }, + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "$ref": "#/definitions/SessionHostManagement", + "description": "SessionHostManagement properties used for the operation." + } + } + }, + "SessionHostManagementUpdateStatus": { + "type": "object", + "description": "Schema for SessionHostManagementUpdateStatus properties.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ID for the async operation." + }, + "name": { + "type": "string", + "description": "Name of the async operation." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation." + }, + "error": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorDetail", + "description": "If present, details of the operation error." + }, + "status": { + "$ref": "#/definitions/updateStatus", + "description": "Operation status. Current defined values are < Error | Scheduled | UpdatingSessionHosts | ValidatingSessionHostUpdate | Paused | Pausing | Cancelling > | Succeeded | Failed | Canceled" + }, + "properties": { + "$ref": "#/definitions/SessionHostManagementUpdateStatusProperties", + "description": "Properties bag for sessionHostManagement Update Statuses." + } + }, + "required": [ + "status" + ] + }, + "SessionHostManagementUpdateStatusProperties": { + "type": "object", + "description": "The current status of the session host update async operation.", + "properties": { + "correlationId": { + "type": "string", + "description": "The correlation Id for Log Analytics.." + }, + "progress": { + "$ref": "#/definitions/SessionHostManagementOperationProgress", + "description": "Progress information on the sessionHostManagement operation." + }, + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update is scheduled for." + }, + "sessionHostManagement": { + "$ref": "#/definitions/SessionHostManagement", + "description": "SessionHostManagement properties used for the operation." + } + } + }, + "SessionHostPatch": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "properties": { + "properties": { + "$ref": "#/definitions/SessionHostPatchProperties", + "description": "Detailed properties for SessionHost" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "SessionHostPatchProperties": { + "type": "object", + "description": "SessionHost properties that can be patched.", + "properties": { + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + } + } + }, + "SessionHostProperties": { + "type": "object", + "description": "Schema for SessionHost properties.", + "properties": { + "activeSessions": { + "type": "integer", + "format": "int32", + "description": "Number of active sessions on SessionHost." + }, + "disconnectedSessions": { + "type": "integer", + "format": "int32", + "description": "Number of disconnected sessions on SessionHost." + }, + "pendingSessions": { + "type": "integer", + "format": "int32", + "description": "Number of pending sessions on SessionHost." + }, + "objectId": { + "type": "string", + "description": "ObjectId of SessionHost. (internal use)", + "readOnly": true + }, + "lastHeartBeat": { + "type": "string", + "format": "date-time", + "description": "Last heart beat from SessionHost." + }, + "sessions": { + "type": "integer", + "format": "int32", + "description": "Number of sessions on SessionHost." + }, + "agentVersion": { + "type": "string", + "description": "Version of agent on SessionHost." + }, + "allowNewSession": { + "type": "boolean", + "description": "Allow a new session." + }, + "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "assignedUser": { + "type": "string", + "description": "User assigned to SessionHost." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of SessionHost" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "Status for a SessionHost." + }, + "statusTimestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the status.", + "readOnly": true + }, + "osVersion": { + "type": "string", + "description": "The version of the OS on the session host." + }, + "sxSStackVersion": { + "type": "string", + "description": "The version of the side by side stack on the session host." + }, + "updateState": { + "$ref": "#/definitions/UpdateState", + "description": "Update state of a SessionHost." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last update.", + "readOnly": true + }, + "updateErrorMessage": { + "type": "string", + "description": "The error message." + }, + "lastSessionHostUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The last time update was completed.", + "readOnly": true + }, + "sessionHostConfiguration": { + "type": "string", + "description": "SessionHostConfiguration version reference at the time the update is initiated, in the format of date time. Example: 2024-04-26T04:56:45Z", + "readOnly": true + }, + "sessionHostHealthCheckResults": { + "type": "array", + "description": "List of SessionHostHealthCheckReports", + "items": { + "$ref": "#/definitions/SessionHostHealthCheckReport" + }, + "readOnly": true, + "x-ms-identifiers": [ + "healthCheckName" + ] + } + } + }, + "SessionHostProvisioningConfigurationPatchProperties": { + "type": "object", + "description": "The configuration for session host provisioning operations.", + "properties": { + "setDrainMode": { + "type": "boolean", + "description": "Whether the session host should be set in drain mode following provisioning." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts to exist in the Host Pool.", + "minimum": 1 + }, + "canaryPolicy": { + "$ref": "#/definitions/CanaryPolicy", + "description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation." + } + } + }, + "SessionHostProvisioningConfigurationProperties": { + "type": "object", + "description": "The configuration for session host provisioning operations.", + "properties": { + "setDrainMode": { + "type": "boolean", + "description": "Whether the session host should be set in drain mode following provisioning." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of session hosts to exist in the Host Pool.", + "minimum": 1 + }, + "canaryPolicy": { + "$ref": "#/definitions/CanaryPolicy", + "description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation." + } + } + }, + "SessionState": { + "type": "string", + "description": "State of user session.", + "enum": [ + "Unknown", + "Active", + "Disconnected", + "Pending", + "LogOff", + "UserProfileDiskMounted" + ], + "x-ms-enum": { + "name": "SessionState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "SessionState is unknown" + }, + { + "name": "Active", + "value": "Active", + "description": "Session is active" + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "Session is disconnected" + }, + { + "name": "Pending", + "value": "Pending", + "description": "Session is pending connection" + }, + { + "name": "LogOff", + "value": "LogOff", + "description": "Session is logging off" + }, + { + "name": "UserProfileDiskMounted", + "value": "UserProfileDiskMounted", + "description": "Session has mounted user profile disk" + } + ] + } + }, + "StartMenuItem": { + "type": "object", + "description": "Represents a StartMenuItem definition.", + "properties": { + "properties": { + "$ref": "#/definitions/StartMenuItemProperties", + "description": "Detailed properties for StartMenuItem" + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Resource" + } + ] + }, + "StartMenuItemList": { + "type": "object", + "description": "List of StartMenuItem definitions.", + "properties": { + "value": { + "type": "array", + "description": "The StartMenuItem items on this page", + "items": { + "$ref": "#/definitions/StartMenuItem" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StartMenuItemProperties": { + "type": "object", + "description": "Schema for StartMenuItem properties.", + "properties": { + "appAlias": { + "type": "string", + "description": "Alias of StartMenuItem." + }, + "filePath": { + "type": "string", + "description": "Path to the file of StartMenuItem." + }, + "commandLineArguments": { + "type": "string", + "description": "Command line arguments for StartMenuItem." + }, + "iconPath": { + "type": "string", + "description": "Path to the icon." + }, + "iconIndex": { + "type": "integer", + "format": "int32", + "description": "Index of the icon." + } + } + }, + "StartupBehavior": { + "type": "string", + "description": "The desired startup behavior during the ramp up period for personal vms in the hostpool.", + "enum": [ + "None", + "WithAssignedUser", + "All" + ], + "x-ms-enum": { + "name": "StartupBehavior", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Session hosts will not be started by the service. This setting depends on Start VM on Connect to be enabled to start the session hosts." + }, + { + "name": "WithAssignedUser", + "value": "WithAssignedUser", + "description": "Session hosts with an assigned user will be started during Ramp Up" + }, + { + "name": "All", + "value": "All", + "description": "All personal session hosts in the hostpool will be started during ramp up." + } + ] + } + }, + "Status": { + "type": "string", + "description": "Status for a SessionHost.", + "enum": [ + "Available", + "Unavailable", + "Shutdown", + "Disconnected", + "Upgrading", + "UpgradeFailed", + "NoHeartbeat", + "NotJoinedToDomain", + "DomainTrustRelationshipLost", + "SxSStackListenerNotReady", + "FSLogixNotHealthy", + "NeedsAssistance" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "Available", + "description": "Session Host has passed all the health checks and is available to handle connections." + }, + { + "name": "Unavailable", + "value": "Unavailable", + "description": "Session Host is either turned off or has failed critical health checks which is causing service not to be able to route connections to this session host. Note this replaces previous 'NoHeartBeat' status." + }, + { + "name": "Shutdown", + "value": "Shutdown", + "description": "Session Host is shutdown - RD Agent reported session host to be stopped or deallocated." + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "The Session Host is unavailable because it is currently disconnected." + }, + { + "name": "Upgrading", + "value": "Upgrading", + "description": "Session Host is unavailable because currently an upgrade of RDAgent/side-by-side stack is in progress. Note: this state will be removed once the upgrade completes and the host is able to accept connections." + }, + { + "name": "UpgradeFailed", + "value": "UpgradeFailed", + "description": "Session Host is unavailable because the critical component upgrade (agent, side-by-side stack, etc.) failed." + }, + { + "name": "NoHeartbeat", + "value": "NoHeartbeat", + "description": "The Session Host is not heart beating." + }, + { + "name": "NotJoinedToDomain", + "value": "NotJoinedToDomain", + "description": "SessionHost is not joined to domain." + }, + { + "name": "DomainTrustRelationshipLost", + "value": "DomainTrustRelationshipLost", + "description": "SessionHost's domain trust relationship lost" + }, + { + "name": "SxSStackListenerNotReady", + "value": "SxSStackListenerNotReady", + "description": "SxS stack installed on the SessionHost is not ready to receive connections." + }, + { + "name": "FSLogixNotHealthy", + "value": "FSLogixNotHealthy", + "description": "FSLogix is in an unhealthy state on the session host." + }, + { + "name": "NeedsAssistance", + "value": "NeedsAssistance", + "description": "New status to inform admins that the health on their endpoint needs to be fixed. The connections might not fail, as these issues are not fatal." + } + ] + } + }, + "StopHostsWhen": { + "type": "string", + "description": "Specifies when to stop hosts during ramp down period.", + "enum": [ + "ZeroSessions", + "ZeroActiveSessions" + ], + "x-ms-enum": { + "name": "StopHostsWhen", + "modelAsString": true, + "values": [ + { + "name": "ZeroSessions", + "value": "ZeroSessions", + "description": "Zero Total Sessions" + }, + { + "name": "ZeroActiveSessions", + "value": "ZeroActiveSessions", + "description": "Zero Active Sessions" + } + ] + } + }, + "Time": { + "type": "object", + "description": "The time for a scaling action to occur.", + "properties": { + "hour": { + "type": "integer", + "format": "int32", + "description": "The hour.", + "minimum": 0, + "maximum": 23 + }, + "minute": { + "type": "integer", + "format": "int32", + "description": "The minute.", + "minimum": 0, + "maximum": 59 + } + }, + "required": [ + "hour", + "minute" + ] + }, + "UpdateSessionHostsRequestBody": { + "type": "object", + "description": "Object containing the definition for properties to be used for a sessionHostUpdate operation.", + "properties": { + "scheduledDateTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp that the update validation is scheduled for. If none is provided, the update will be executed immediately" + }, + "scheduledDateTimeZone": { + "type": "string", + "description": "The timeZone as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid." + }, + "update": { + "$ref": "#/definitions/HostPoolUpdateConfigurationPatchProperties", + "description": "settings for management information for the hostpool update operation. If none is provided the update will use the settings saved in the sessionHostManagement object." + } + } + }, + "UpdateState": { + "type": "string", + "description": "Update state of a SessionHost.", + "enum": [ + "Initial", + "Pending", + "Started", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "UpdateState", + "modelAsString": true, + "values": [ + { + "name": "Initial", + "value": "Initial", + "description": "Update is initializing" + }, + { + "name": "Pending", + "value": "Pending", + "description": "Update is pending" + }, + { + "name": "Started", + "value": "Started", + "description": "Update has started" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Update has succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Update has failed" + } + ] + }, + "readOnly": true + }, + "UserSession": { + "type": "object", + "description": "Represents a UserSession definition.", + "properties": { + "properties": { + "$ref": "#/definitions/UserSessionProperties", + "description": "Detailed properties for UserSession", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "UserSessionList": { + "type": "object", + "description": "List of UserSession definitions.", + "properties": { + "value": { + "type": "array", + "description": "The UserSession items on this page", + "items": { + "$ref": "#/definitions/UserSession" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "UserSessionProperties": { + "type": "object", + "description": "Schema for UserSession properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of user session. (internal use)", + "readOnly": true + }, + "userPrincipalName": { + "type": "string", + "description": "The user principal name." + }, + "applicationType": { + "$ref": "#/definitions/ApplicationType", + "description": "Application type of application." + }, + "sessionState": { + "$ref": "#/definitions/SessionState", + "description": "State of user session." + }, + "activeDirectoryUserName": { + "type": "string", + "description": "The active directory user name." + }, + "createTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the user session create." + } + } + }, + "VirtualMachineDiskType": { + "type": "string", + "description": "The disk type used by virtual machine in hostpool session host.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "x-ms-enum": { + "name": "VirtualMachineDiskType", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + } + ] + } + }, + "VirtualMachineSecurityType": { + "type": "string", + "description": "The security type used by virtual machine in hostpool session host. Default is Standard.", + "enum": [ + "Standard", + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "VirtualMachineSecurityType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard security protocol. No additional parameters" + }, + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch allows for secure boot and vTpm" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential Virtual Machine security protocol" + } + ] + } + }, + "Workspace": { + "type": "object", + "description": "Represents a Workspace definition.", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "Detailed properties for Workspace", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "etag": { + "type": "string", + "description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", + "pattern": "^[-\\w\\._,\\(\\)]+$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "managedBy": { + "type": "string", + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "plan": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Plan", + "description": "Details of the resource plan." + }, + "sku": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", + "description": "The SKU (Stock Keeping Unit) assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "WorkspaceList": { + "type": "object", + "description": "List of Workspace definitions.", + "properties": { + "value": { + "type": "array", + "description": "The Workspace items on this page", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WorkspacePatch": { + "type": "object", + "description": "Workspace properties that can be patched.A patch model", + "properties": { + "tags": { + "type": "object", + "description": "tags to be updated", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/WorkspacePatchProperties", + "description": "Detailed properties for Workspace" + } + } + }, + "WorkspacePatchProperties": { + "type": "object", + "description": "Workspace properties that can be patched.", + "properties": { + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup links.", + "items": { + "type": "string" + } + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Enabled to allow this resource to be access from the public network" + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "Schema for Workspace properties.", + "properties": { + "objectId": { + "type": "string", + "description": "ObjectId of Workspace. (internal use)", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of Workspace." + }, + "friendlyName": { + "type": "string", + "description": "Friendly name of Workspace." + }, + "applicationGroupReferences": { + "type": "array", + "description": "List of applicationGroup resource Ids.", + "items": { + "type": "string" + } + }, + "cloudPcResource": { + "type": "boolean", + "description": "Is cloud pc resource.", + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints" + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connection associated with the specified resource", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "oboTenantId": { + "type": "string", + "description": "Tenant that the resource is being requested on behalf of." + } + } + }, + "failHealthCheckOnStagingFailure": { + "type": "string", + "description": "Parameter indicating how the health check should behave if this package fails staging", + "enum": [ + "Unhealthy", + "NeedsAssistance", + "DoNotFail" + ], + "x-ms-enum": { + "name": "failHealthCheckOnStagingFailure", + "modelAsString": true, + "values": [ + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Health Check will report unhealthy" + }, + { + "name": "NeedsAssistance", + "value": "NeedsAssistance", + "description": "Health Check will report NeedsAssistance" + }, + { + "name": "DoNotFail", + "value": "DoNotFail", + "description": "Health Check will not report failure" + } + ] + } + }, + "packageTimestamped": { + "type": "string", + "description": "Is package timestamped so it can ignore the certificate expiry date", + "enum": [ + "Timestamped", + "NotTimestamped" + ], + "x-ms-enum": { + "name": "packageTimestamped", + "modelAsString": true, + "values": [ + { + "name": "Timestamped", + "value": "Timestamped", + "description": "Package is timestamped" + }, + { + "name": "NotTimestamped", + "value": "NotTimestamped", + "description": "Package is not timestamped, use certificate expiry date" + } + ] + } + }, + "type": { + "type": "string", + "description": "The type of image session hosts use in the hostpool.", + "enum": [ + "Marketplace", + "Custom" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "name": "Marketplace", + "value": "Marketplace", + "description": "Using default marketplace images offered by Azure Marketplace." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Using a custom image." + } + ] + } + }, + "updateStatus": { + "type": "string", + "description": "Operation status for SessionHostManagementUpdate.", + "enum": [ + "Error", + "Scheduled", + "UpdatingSessionHosts", + "ValidatingSessionHostUpdate", + "Paused", + "Pausing", + "Cancelling", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "updateStatus", + "modelAsString": true, + "values": [ + { + "name": "Error", + "value": "Error", + "description": "The operation has an error." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The operation is scheduled." + }, + { + "name": "UpdatingSessionHosts", + "value": "UpdatingSessionHosts", + "description": "The operation is currently updating Session Hosts." + }, + { + "name": "ValidatingSessionHostUpdate", + "value": "ValidatingSessionHostUpdate", + "description": "The operation is validating the update." + }, + { + "name": "Paused", + "value": "Paused", + "description": "The operation is paused." + }, + { + "name": "Pausing", + "value": "Pausing", + "description": "The operation is pausing." + }, + { + "name": "Cancelling", + "value": "Cancelling", + "description": "Canceling the operation." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation failed." + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "The operation is canceled" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ActiveSessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ActiveSessionHostConfigurations_Get.json new file mode 100644 index 000000000000..b2987cca9f4e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ActiveSessionHostConfigurations_Get.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "ActiveSessionHostConfigurations_Get", + "title": "ActiveSessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..07d8e3be9a94 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ActiveSessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/activeSessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/activeSessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "ActiveSessionHostConfigurations_ListByHostPool", + "title": "ActiveSessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackageInfo_Import.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackageInfo_Import.json new file mode 100644 index 000000000000..643a6ef64da2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackageInfo_Import.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "importPackageInfoRequest": { + "path": "https://url.com/imagePath", + "packageArchitecture": "x64" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "" + } + } + ] + } + } + }, + "operationId": "AppAttachPackageInfo_Import", + "title": "AppAttachPackageInfo_Import" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_CreateOrUpdate.json new file mode 100644 index 000000000000..3aa2f925236f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_CreateOrUpdate.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2025-09-01-preview", + "appAttachPackage": { + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + } + }, + "appAttachPackageName": "msixpackagefullname", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + }, + "201": { + "body": { + "name": "packageName", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "location": "southcentralus", + "properties": { + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "hostPoolReferences": [], + "image": { + "certificateExpiry": "2023-01-02T17:18:19.1234567Z", + "certificateName": "certName", + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageAlias": "msixpackagealias", + "packageApplications": [ + { + "description": "PackageApplicationDescription", + "appId": "AppId", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "minVersion": "packageDep_version", + "publisher": "MsixPackage_Dependency_Publisher" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "packageName": "MsixPackageName", + "packageRelativePath": "packagerelativepath", + "version": "packageversion" + }, + "keyVaultURL": "" + }, + "systemData": { + "createdAt": "2023-09-28T23:44:56.13Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User" + }, + "tags": {} + } + } + }, + "operationId": "AppAttachPackage_CreateOrUpdate", + "title": "AppAttachPackage_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Delete.json new file mode 100644 index 000000000000..32ec4e8e4d12 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Delete.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + "204": {} + }, + "operationId": "AppAttachPackage_Delete", + "title": "AppAttachPackage_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Get.json new file mode 100644 index 000000000000..dedd797843ef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Get", + "title": "AppAttachPackage_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_ListByResourceGroup.json new file mode 100644 index 000000000000..2713d750c96c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_ListByResourceGroup.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListByResourceGroup", + "title": "AppAttachPackage_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_ListBySubscription.json new file mode 100644 index 000000000000..66b3e7132b37 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_ListBySubscription.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "$filter": "HostPoolName eq 'hostpool1'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + }, + { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + ] + } + } + }, + "operationId": "AppAttachPackage_ListBySubscription", + "title": "AppAttachPackage_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Update.json new file mode 100644 index 000000000000..43d58ea9ecb9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/AppAttachPackage_Update.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "appAttachPackageName": "msixpackagefullname", + "appAttachPackagePatch": { + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [ + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp1", + "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/hostPool/hp2" + ], + "keyVaultURL": "url", + "failHealthCheckOnStagingFailure": "DoNotFail" + } + } + }, + "responses": { + "200": { + "body": { + "name": "packageName", + "id": "/subscriptions/d15725f7-6577-4a8c-95f1-3da903b42364/resourcegroups/charlesk-southcentralus/providers/Microsoft.DesktopVirtualization/appattachpackages/ModifierPackage", + "type": "Microsoft.DesktopVirtualization/appattachpackages", + "location": "southcentralus", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2023-09-28T23:44:56.13Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-09T01:43:31.07Z" + }, + "properties": { + "image": { + "packageAlias": "msixpackagealias", + "imagePath": "imagepath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "certificateName": "certName", + "certificateExpiry": "2023-01-02T17:18:19.1234567Z" + }, + "hostPoolReferences": [], + "failHealthCheckOnStagingFailure": "NeedsAssistance", + "keyVaultURL": "", + "customData": "", + "packageOwnerName": "App Attach" + } + } + } + }, + "operationId": "AppAttachPackage_Update", + "title": "AppAttachPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..1eea56e5a62f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2025-09-01-preview", + "applicationGroup": { + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "showInFeed": true, + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "applicationGroupName": "applicationGroup1", + "resourceGroupName": "resourceGroup1", + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "201": { + "body": { + "name": "applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "location": "centralus", + "properties": { + "description": "des1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "showInFeed": true, + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1" + }, + "systemData": { + "createdAt": "2020-01-01T17:18:19.1234567Z", + "createdBy": "user1", + "createdByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User" + }, + "tags": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "operationId": "ApplicationGroups_CreateOrUpdate", + "title": "ApplicationGroup_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Delete.json new file mode 100644 index 000000000000..0b429c22c3cc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Delete.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + "204": {} + }, + "operationId": "ApplicationGroups_Delete", + "title": "ApplicationGroups_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Get.json new file mode 100644 index 000000000000..58b6c774e4f2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Get", + "title": "ApplicationGroup_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..06ead236ae6b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_ListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListByResourceGroup", + "title": "ApplicationGroup_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_ListBySubscription.json new file mode 100644 index 000000000000..db141adb5291 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_ListBySubscription.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "$filter": "applicationGroupType eq 'RailApplication'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + }, + { + "name": "applicationGroup2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + ] + } + } + }, + "operationId": "ApplicationGroups_ListBySubscription", + "title": "ApplicationGroup_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Update.json new file mode 100644 index 000000000000..a581685cafa9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ApplicationGroups_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview", + "applicationGroup": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "showInFeed": true + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", + "type": "Microsoft.DesktopVirtualization/applicationGroups", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "applicationGroupType": "RemoteApp", + "cloudPcResource": false, + "showInFeed": true + } + } + } + }, + "operationId": "ApplicationGroups_Update", + "title": "ApplicationGroup_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_CreateOrUpdate.json new file mode 100644 index 000000000000..b993b5e5ded9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_CreateOrUpdate.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1 + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "201": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_CreateOrUpdate", + "title": "Applications_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Delete.json new file mode 100644 index 000000000000..38ee2fe4562c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Delete.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + "204": {} + }, + "operationId": "Applications_Delete", + "title": "Applications_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Get.json new file mode 100644 index 000000000000..23b78736f079 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Get", + "title": "Applications_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_List.json new file mode 100644 index 000000000000..4f0ab23909ce --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_List.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + }, + { + "name": "applicationGroup1/application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des2", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + ] + } + } + }, + "operationId": "Applications_List", + "title": "Applications_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Update.json new file mode 100644 index 000000000000..ccbdd744fcbf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Applications_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "applicationName": "application1", + "api-version": "2025-09-01-preview", + "application": { + "properties": { + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "filePath": "path", + "commandLineSetting": "Allow", + "commandLineArguments": "arguments", + "showInPortal": true, + "iconPath": "icon", + "iconIndex": 1, + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "applicationType": "InBuilt", + "msixPackageFamilyName": null, + "msixPackageApplicationId": null + } + } + } + }, + "operationId": "Applications_Update", + "title": "Applications_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_Get.json new file mode 100644 index 000000000000..decaa3e0ff68 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Get", + "title": "Desktops_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_List.json new file mode 100644 index 000000000000..08b998c37b37 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + ] + } + } + }, + "operationId": "Desktops_List", + "title": "Desktops_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_Update.json new file mode 100644 index 000000000000..b70e20668355 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Desktops_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "desktopName": "SessionDesktop", + "api-version": "2025-09-01-preview", + "desktop": { + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "applicationGroup1/SessionDesktop", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/desktops/SessionDesktop", + "type": "Microsoft.DesktopVirtualization/applicationGroups/desktops", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", + "iconContent": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + } + } + }, + "operationId": "Desktops_Update", + "title": "Desktops_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPool_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPool_CreateOrUpdate.json new file mode 100644 index 000000000000..1ff9c494a17f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPool_CreateOrUpdate.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPool": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + }, + "201": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2020-10-01T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "deploymentScope": "Geographical" + } + } + } + }, + "operationId": "HostPools_CreateOrUpdate", + "title": "HostPools_CreateOrUpdate" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPool_Lists.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPool_Lists.json new file mode 100644 index 000000000000..37b9349dae3d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPool_Lists.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + ] + } + } + }, + "operationId": "HostPools_List", + "title": "HostPool_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Delete.json new file mode 100644 index 000000000000..e408380eab20 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Delete.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "deploymentScope": "Geographical" + } + }, + "204": {} + }, + "operationId": "HostPools_Delete", + "title": "HostPools_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Get.json new file mode 100644 index 000000000000..68c08ef1647a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Get.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + }, + "default": { + "body": { + "error": { + "code": "hostPoolDoesNotExist", + "message": "Host Pool Does Not Exist" + } + } + } + }, + "operationId": "HostPools_Get", + "title": "HostPools_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_ListByResourceGroup.json new file mode 100644 index 000000000000..f2303122bce1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_ListByResourceGroup.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + }, + { + "name": "hostPool2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool2", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Default", + "directUDP": "Default", + "publicUDP": "Default", + "relayUDP": "Default", + "deploymentScope": "Geographical", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + ] + } + } + }, + "operationId": "HostPools_ListByResourceGroup", + "title": "HostPools_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_ListRegistrationTokens.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_ListRegistrationTokens.json new file mode 100644 index 000000000000..f336002cb839 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_ListRegistrationTokens.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token" + } + ] + } + } + }, + "operationId": "HostPools_ListRegistrationTokens", + "title": "HostPools_ListRegistrationTokens" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_RetrieveRegistrationToken.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_RetrieveRegistrationToken.json new file mode 100644 index 000000000000..f1f6423347ed --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_RetrieveRegistrationToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + } + } + }, + "operationId": "HostPools_RetrieveRegistrationToken", + "title": "HostPools_RetrieveRegistrationToken" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Update.json new file mode 100644 index 000000000000..a6b0923df7e9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/HostPools_Update.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPool": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "friendlyName": "friendly", + "description": "des1", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "personalDesktopAssignmentType": "Automatic", + "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "startVMOnConnect": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled", + "allowRDPShortPathWithPrivateLink": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "type": "/Microsoft.DesktopVirtualization/hostPools", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "friendlyName": "friendly", + "description": "des1", + "hostPoolType": "Pooled", + "personalDesktopAssignmentType": "Automatic", + "customRdpProperty": null, + "maxSessionLimit": 999999, + "loadBalancerType": "BreadthFirst", + "validationEnvironment": null, + "ring": null, + "registrationInfo": { + "expirationTime": "2008-09-22T14:01:54.9571247Z", + "token": "token", + "registrationTokenOperation": "Update" + }, + "vmTemplate": "{json:json}", + "managementType": "Automated", + "ssoadfsAuthority": "https://adfs", + "ssoClientId": "client", + "ssoClientSecretKeyVaultPath": "https://keyvault/secret", + "ssoSecretType": "SharedKey", + "preferredAppGroupType": "Desktop", + "startVMOnConnect": false, + "cloudPcResource": false, + "agentUpdate": { + "type": "Scheduled", + "useSessionHostLocalTime": false, + "maintenanceWindowTimeZone": "Alaskan Standard Time", + "maintenanceWindows": [ + { + "hour": 7, + "dayOfWeek": "Friday" + }, + { + "hour": 8, + "dayOfWeek": "Saturday" + } + ] + }, + "managedPrivateUDP": "Enabled", + "directUDP": "Enabled", + "publicUDP": "Enabled", + "relayUDP": "Enabled" + } + } + } + }, + "operationId": "HostPools_Update", + "title": "HostPools_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_CreateOrUpdate.json new file mode 100644 index 000000000000..11cd1ee64f41 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_CreateOrUpdate.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "imagePath": "imagepath", + "isActive": false, + "isRegularRegistration": false, + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "description": "application-desc", + "appId": "ApplicationId", + "appUserModelID": "AppUserModelId", + "friendlyName": "friendlyname", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ], + "packageDependencies": [ + { + "dependencyName": "MsixTest_Dependency_Name", + "minVersion": "version", + "publisher": "PublishedName" + } + ], + "packageFamilyName": "MsixPackage_FamilyName", + "packageName": "MsixPackage_name", + "packageRelativePath": "packagerelativepath", + "version": "version" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + }, + "201": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_CreateOrUpdate", + "title": "MSIXPackages_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Delete.json new file mode 100644 index 000000000000..3e5de29b9aef --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Delete.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + "204": {} + }, + "operationId": "MSIXPackages_Delete", + "title": "MSIXPackages_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Get.json new file mode 100644 index 000000000000..22187846db61 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "packagefullname" + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Get", + "title": "MSIXPackages_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_List.json new file mode 100644 index 000000000000..f64ba9aff56e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_List.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/MsixPackageFullName2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName2", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath2", + "packageName": "MsixPackage_Name2", + "packageFamilyName": "MsixPackage_FamilyName2", + "displayName": "dis2", + "packageRelativePath": "MsixPackage_RelativePackageRoot2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name2", + "publisher": "MsixPackage_Dependency_Publisher2", + "minVersion": "packageDep_version2" + } + ], + "version": "version2", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id2", + "description": "desc2", + "appUserModelID": "Application_ModelID2", + "friendlyName": "fri2", + "iconImageName": "Apptile2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MSIXPackages_List", + "title": "MSIXPackages_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Update.json new file mode 100644 index 000000000000..1e04a29ff5dc --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MSIXPackages_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixPackageFullName": "msixpackagefullname", + "msixPackage": { + "properties": { + "displayName": "displayname", + "isActive": true, + "isRegularRegistration": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostpool1/MsixPackageFullName", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourcegroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/msixpackages/msixPackageFullName", + "type": "Microsoft.DesktopVirtualization/hostpools/msixpackages", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "imagePath": "imagepath", + "packageName": "MsixPackage_Name", + "packageFamilyName": "MsixPackage_FamilyName", + "displayName": "dis", + "packageRelativePath": "MsixPackage_RelativePackageRoot", + "isRegularRegistration": false, + "isActive": true, + "packageDependencies": [ + { + "dependencyName": "MsixPackage_Dependency_Name", + "publisher": "MsixPackage_Dependency_Publisher", + "minVersion": "packageDep_version" + } + ], + "version": "version", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "Application_Id", + "description": "desc", + "appUserModelID": "Application_ModelID", + "friendlyName": "fri", + "iconImageName": "Apptile", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + } + }, + "operationId": "MSIXPackages_Update", + "title": "MSIXPackage_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MsixImages_Expand.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MsixImages_Expand.json new file mode 100644 index 000000000000..eedda85243aa --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/MsixImages_Expand.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostpool1", + "api-version": "2025-09-01-preview", + "msixImageURI": { + "uri": "https://url.com/imagePath" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/imagepath", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName", + "packageFamilyName": "MsixPackage_FamilyName", + "packageFullName": "MsixPackage_FullName", + "displayName": "displayname", + "packageRelativePath": "packagerelativepath", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId", + "description": "PackageApplicationDescription", + "appUserModelID": "AppUserModelId", + "friendlyName": "FriendlyName", + "iconImageName": "Iconimagename", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + }, + { + "name": "hostpool1/expandmsiximage", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourcegroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostpool1/expandmsiximage/msixImageURI", + "type": "Microsoft.DesktopVirtualization/hostpools/expandmsiximage", + "properties": { + "packageAlias": "msixpackagealias2", + "imagePath": "https://url.com/imagePath", + "packageName": "MsixPackageName2", + "packageFamilyName": "MsixPackage_FamilyName2", + "packageFullName": "MsixPackage_FullName2", + "displayName": "displayname2", + "packageRelativePath": "packagerelativepath2", + "isRegularRegistration": false, + "isActive": false, + "packageDependencies": [ + { + "dependencyName": "MsixPackageDependency1", + "publisher": "PublisherName1", + "minVersion": "ver1" + }, + { + "dependencyName": "MsixPackageDependency2", + "publisher": "PublisherName2", + "minVersion": "ver2" + } + ], + "version": "packageversion", + "lastUpdated": "2008-09-22T14:01:54.9571247Z", + "packageApplications": [ + { + "appId": "AppId1", + "description": "PackageApplicationDescription1", + "appUserModelID": "AppUserModelId1", + "friendlyName": "FriendlyName1", + "iconImageName": "Iconimagename1", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + }, + { + "appId": "AppId2", + "description": "PackageApplicationDescription2", + "appUserModelID": "AppUserModelId2", + "friendlyName": "FriendlyName2", + "iconImageName": "Iconimagename2", + "rawIcon": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo", + "rawPng": "VGhpcyBpcyBhIHN0cmluZyB0byBoYXNo" + } + ] + } + } + ] + } + } + }, + "operationId": "MsixImages_Expand", + "title": "MsixImages_Expand" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Operations_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..54b8546cfa04 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "operationId": "Operations_List", + "title": "List Provider Operations", + "parameters": { + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DesktopVirtualization/services/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.DesktopVirtualization", + "resource": "services", + "operation": "Lists services", + "description": "Lists registered services" + } + } + ] + } + } + } +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_DeleteByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_DeleteByHostPool.json new file mode 100644 index 000000000000..d1a5a35cb0b8 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_DeleteByHostPool.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByHostPool", + "title": "PrivateEndpointConnections_DeleteByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_DeleteByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_DeleteByWorkspace.json new file mode 100644 index 000000000000..9d8858e9246e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_DeleteByWorkspace.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "PrivateEndpointConnections_DeleteByWorkspace", + "title": "PrivateEndpointConnections_DeleteByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_GetByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_GetByHostPool.json new file mode 100644 index 000000000000..2aa766ce6d97 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_GetByHostPool.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByHostPool", + "title": "PrivateEndpointConnections_GetByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_GetByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_GetByWorkspace.json new file mode 100644 index 000000000000..db7f8c4ec953 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_GetByWorkspace.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_GetByWorkspace", + "title": "PrivateEndpointConnections_GetByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_ListByHostPool.json new file mode 100644 index 000000000000..78aa4e75924d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_ListByHostPool.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByHostPool", + "title": "PrivateEndpointConnections_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_ListByWorkspace.json new file mode 100644 index 000000000000..d7bd501ea918 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_ListByWorkspace.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + }, + "operationId": "PrivateEndpointConnections_ListByWorkspace", + "title": "PrivateEndpointConnections_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_UpdateByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_UpdateByHostPool.json new file mode 100644 index 000000000000..d71025f5abc4 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_UpdateByHostPool.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "privateEndpointConnectionName": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateEndpointConnections/hostPool1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/hostpools/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByHostPool", + "title": "PrivateEndpointConnections_UpdateByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_UpdateByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_UpdateByWorkspace.json new file mode 100644 index 000000000000..73cac14c1aea --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateEndpointConnections_UpdateByWorkspace.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "privateEndpointConnectionName": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "api-version": "2025-09-01-preview", + "connection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateEndpointConnections/workspace1.377103f1-5179-4bdf-8556-4cdd3207cc5b", + "type": "Microsoft.DesktopVirtualization/workspaces/privateEndpointConnections", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup2/providers/Microsoft.Network/privateEndpoints/endpointName1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by admin@consoto.com", + "actionsRequired": "None" + } + } + } + } + }, + "operationId": "PrivateEndpointConnections_UpdateByWorkspace", + "title": "PrivateEndpointConnections_UpdateByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateLinkResources_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateLinkResources_ListByHostPool.json new file mode 100644 index 000000000000..d7632a8367d0 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateLinkResources_ListByHostPool.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hostpool", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostpools/hostPool1/privateLinkResources/hostpool", + "type": "Microsoft.DesktopVirtualization/hostpools/privateLinkResources", + "properties": { + "groupId": "hostpool", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByHostPool", + "title": "PrivateLinkResources_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateLinkResources_ListByWorkspace.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateLinkResources_ListByWorkspace.json new file mode 100644 index 000000000000..f46df5f8863d --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/PrivateLinkResources_ListByWorkspace.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1/privateLinkResources/workspace", + "type": "Microsoft.DesktopVirtualization/workspaces/privateLinkResources", + "properties": { + "groupId": "workspace", + "requiredMembers": [ + "rdbroker", + "rddiagnostics", + "rdweb", + "rdgateway" + ], + "requiredZoneNames": [ + "privatelink.wvd.microsoft.com" + ] + } + } + ] + } + } + }, + "operationId": "PrivateLinkResources_ListByWorkspace", + "title": "PrivateLinkResources_ListByWorkspace" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Create.json new file mode 100644 index 000000000000..23d03226f5af --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Create.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Create", + "title": "ScalingPlanPersonalSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Delete.json new file mode 100644 index 000000000000..68511bc119d1 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPersonalSchedules_Delete", + "title": "ScalingPlanPersonalSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Get.json new file mode 100644 index 000000000000..d90a310ff6f9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Get.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "PersonalScalingPlan1", + "scalingPlanScheduleName": "PersonalScalingPlanSchedule", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "PersonalScalingPlanSchedule", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/PersonalScalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Get", + "title": "ScalingPlanPersonalSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_List.json new file mode 100644 index 000000000000..2e970e810178 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_List.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekday", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + }, + { + "name": "scalingPlanScheduleWeekend", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 10, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "Deallocate", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 14, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "Deallocate", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 16, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Enable", + "offPeakActionOnDisconnect": "Deallocate", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + ] + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_List", + "title": "ScalingPlanPersonalSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Update.json new file mode 100644 index 000000000000..265b957ea621 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPersonalSchedules_Update.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/personalSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/personalSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpAutoStartHosts": "All", + "rampUpStartVMOnConnect": "Enable", + "rampUpActionOnDisconnect": "None", + "rampUpMinutesToWaitOnDisconnect": 10, + "rampUpActionOnLogoff": "None", + "rampUpMinutesToWaitOnLogoff": 10, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakStartVMOnConnect": "Enable", + "peakActionOnDisconnect": "None", + "peakMinutesToWaitOnDisconnect": 10, + "peakActionOnLogoff": "Deallocate", + "peakMinutesToWaitOnLogoff": 10, + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownStartVMOnConnect": "Enable", + "rampDownActionOnDisconnect": "None", + "rampDownMinutesToWaitOnDisconnect": 10, + "rampDownActionOnLogoff": "Deallocate", + "rampDownMinutesToWaitOnLogoff": 10, + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakStartVMOnConnect": "Disable", + "offPeakActionOnDisconnect": "None", + "offPeakMinutesToWaitOnDisconnect": 10, + "offPeakActionOnLogoff": "Deallocate", + "offPeakMinutesToWaitOnLogoff": 10 + } + } + } + }, + "operationId": "ScalingPlanPersonalSchedules_Update", + "title": "ScalingPlanPersonalSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Create.json new file mode 100644 index 000000000000..568a36c74de9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Create.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json new file mode 100644 index 000000000000..79982489429c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_CreateUsingCreateDelete.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + }, + "201": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "scalingMethod": "CreateDeletePowerManage", + "createDelete": { + "rampUpMaximumHostPoolSize": 10, + "rampUpMinimumHostPoolSize": 5, + "rampDownMaximumHostPoolSize": 7, + "rampDownMinimumHostPoolSize": 2 + }, + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Create", + "title": "ScalingPlanPooledSchedules_CreateUsingCreateDelete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Delete.json new file mode 100644 index 000000000000..68d69652f209 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + }, + "operationId": "ScalingPlanPooledSchedules_Delete", + "title": "ScalingPlanPooledSchedules_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Get.json new file mode 100644 index 000000000000..de9eff9b47c2 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Get", + "title": "ScalingPlanPooledSchedules_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_List.json new file mode 100644 index 000000000000..78dbec34e08c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_List.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + }, + { + "name": "scalingPlanScheduleWeekends1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekends1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Saturday", + "Sunday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 10, + "rampUpCapacityThresholdPct": 90, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 0, + "rampDownCapacityThresholdPct": 100, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + ] + } + } + }, + "operationId": "ScalingPlanPooledSchedules_List", + "title": "ScalingPlanPooledSchedules_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Update.json new file mode 100644 index 000000000000..3569cb19ebac --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlanPooledSchedules_Update.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "scalingPlanScheduleName": "scalingPlanScheduleWeekdays1", + "api-version": "2025-09-01-preview", + "scalingPlanSchedule": { + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownWaitTimeMinutes": 30 + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlanScheduleWeekdays1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1/pooledSchedules/scalingPlanScheduleWeekdays1", + "type": "Microsoft.DesktopVirtualization/scalingPlans/pooledSchedules", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + } + } + }, + "operationId": "ScalingPlanPooledSchedules_Update", + "title": "ScalingPlanPooledSchedules_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Create.json new file mode 100644 index 000000000000..f380112e7f5f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Create.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview", + "scalingPlan": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "201": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Create", + "title": "ScalingPlans_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Delete.json new file mode 100644 index 000000000000..0e87a5572aaa --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Delete.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + "204": {} + }, + "operationId": "ScalingPlans_Delete", + "title": "ScalingPlans_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Get.json new file mode 100644 index 000000000000..c4b69662f1a9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Get.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of scaling plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Get", + "title": "ScalingPlans_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListByHostPool.json new file mode 100644 index 000000000000..079dd644c19f --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListByHostPool.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByHostPool", + "title": "ScalingPlans_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListByResourceGroup.json new file mode 100644 index 000000000000..d09afc777730 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListByResourceGroup.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListByResourceGroup", + "title": "ScalingPlans_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListBySubscription.json new file mode 100644 index 000000000000..592bcc978c9c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_ListBySubscription.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + }, + { + "name": "scalingPlan2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan2", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": false, + "rampDownStopHostsWhen": "ZeroActiveSessions", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + ] + } + } + }, + "operationId": "ScalingPlans_ListBySubscription", + "title": "ScalingPlans_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Update.json new file mode 100644 index 000000000000..7ebfd3caf5b5 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/ScalingPlans_Update.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "scalingPlanName": "scalingPlan1", + "api-version": "2025-09-01-preview", + "scalingPlan": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "scalingPlan1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/scalingPlans/scalingPlan1", + "type": "Microsoft.DesktopVirtualization/scalingPlans", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "00000000-0000-0000-0000-000000000000", + "description": "Description of Scaling Plan", + "friendlyName": "Scaling Plan 1", + "timeZone": "Central Standard Time", + "hostPoolType": "Pooled", + "exclusionTag": "value", + "schedules": [ + { + "name": "schedule1", + "daysOfWeek": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "rampUpStartTime": { + "hour": 6, + "minute": 0 + }, + "rampUpLoadBalancingAlgorithm": "DepthFirst", + "rampUpMinimumHostsPct": 20, + "rampUpCapacityThresholdPct": 80, + "peakStartTime": { + "hour": 8, + "minute": 0 + }, + "peakLoadBalancingAlgorithm": "BreadthFirst", + "rampDownStartTime": { + "hour": 18, + "minute": 0 + }, + "rampDownLoadBalancingAlgorithm": "DepthFirst", + "rampDownMinimumHostsPct": 20, + "rampDownCapacityThresholdPct": 50, + "rampDownForceLogoffUsers": true, + "rampDownWaitTimeMinutes": 30, + "rampDownNotificationMessage": "message", + "offPeakStartTime": { + "hour": 20, + "minute": 0 + }, + "offPeakLoadBalancingAlgorithm": "DepthFirst" + } + ], + "hostPoolReferences": [ + { + "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", + "scalingPlanEnabled": true + } + ] + } + } + } + }, + "operationId": "ScalingPlans_Update", + "title": "ScalingPlans_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_CreateOrUpdate.json new file mode 100644 index 000000000000..e7c86a031c04 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_CreateOrUpdate.json @@ -0,0 +1,246 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "InitialConfiguration", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_CreateOrUpdate", + "title": "SessionHostConfigurations_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_Get.json new file mode 100644 index 000000000000..c4bf960585b9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_Get.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + } + }, + "operationId": "SessionHostConfigurations_Get", + "title": "SessionHostConfigurations_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_ListByHostPool.json new file mode 100644 index 000000000000..84566d6e9d1c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_ListByHostPool.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user2", + "createdByType": "User", + "createdAt": "2020-02-01T17:18:19.1234567Z", + "lastModifiedBy": "user3", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "westus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "managedDisk": { + "type": "Standard_LRS" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + ] + } + } + }, + "operationId": "SessionHostConfigurations_ListByHostPool", + "title": "SessionHostConfigurations_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_Update.json new file mode 100644 index 000000000000..749c3dc9416a --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostConfigurations_Update.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostConfiguration": { + "properties": { + "friendlyName": "Second Version, Updated Location", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + } + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "version": "2022-10-21T17:18:19.1234567Z", + "friendlyName": "InitialConfiguration", + "provisioningState": "Provisioning", + "vmTags": { + "Department": "myDepartment", + "Team": "myTeam" + }, + "vmLocation": "eastus2", + "vmResourceGroup": "myResourceGroup", + "vmNamePrefix": "westus2-vm", + "availabilityZones": [ + 1, + 3 + ], + "networkInfo": { + "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1", + "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "vmSizeId": "Standard_D2s_v3", + "diskInfo": { + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + } + }, + "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file", + "imageInfo": { + "type": "Marketplace", + "marketplaceInfo": { + "offer": "Windows-10", + "publisher": "MicrosoftWindowsDesktop", + "sku": "19h2-ent", + "exactVersion": "2019.0.20190115" + }, + "customInfo": { + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName" + } + }, + "domainInfo": { + "joinType": "ActiveDirectory", + "activeDirectoryInfo": { + "domainCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com", + "domainName": "wvdarmtest1.net" + }, + "azureActiveDirectoryInfo": { + "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa" + } + }, + "securityInfo": { + "type": "TrustedLaunch", + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "vmAdminCredentials": { + "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername", + "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname" + }, + "bootDiagnosticsInfo": { + "enabled": true, + "storageUri": "https://myStorageAccountName.blob.core.windows.net" + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default/operationStatuses/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "SessionHostConfigurations_Update", + "title": "SessionHostConfigurations_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagementsUpdateStatus_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagementsUpdateStatus_Get.json new file mode 100644 index 000000000000..0bc7e025d085 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagementsUpdateStatus_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostUpdateStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostManagementsUpdateStatus_Get", + "title": "SessionHostManagementsUpdateStatus_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json new file mode 100644 index 000000000000..0c4392607d76 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ControlSessionHostProvisioning_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPoolProvisioningControlParameter": { + "action": "Cancel", + "cancelMessage": "Cancel host pool provisioning" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostProvisioning_Post", + "title": "SessionHostManagements_ControlSessionHostProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json new file mode 100644 index 000000000000..2b96f4057d25 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ControlSessionHostUpdate_Post.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "hostPoolUpdateControlParameter": { + "action": "Start", + "cancelMessage": "Host pool update started" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d", + "Retry-After": "60" + } + } + }, + "operationId": "ControlSessionHostUpdate_Post", + "title": "SessionHostManagements_ControlSessionHostUpdate_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Create.json new file mode 100644 index 000000000000..a0d1c807032e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_CreateOrUpdate", + "title": "SessionHostManagements_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Get.json new file mode 100644 index 000000000000..b5869586df2e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d" + }, + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Get", + "title": "SessionHostManagements_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ListByHostPool.json new file mode 100644 index 000000000000..471973d2a147 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_ListByHostPool.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + ] + } + } + }, + "operationId": "SessionHostManagements_ListByHostPool", + "title": "SessionHostManagements_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json new file mode 100644 index 000000000000..5203170f3109 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_SessionHostProvisioningStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/sessionHostProvisioningStatuses/default", + "name": "30972f1b-b61d-4fd8-bd34-3dcfa24670f3", + "status": "Failed", + "startTime": "2020-10-26T13:45:39.6554616Z", + "endTime": "2020-10-26T13:45:42.7025301Z", + "percentComplete": 1.0, + "error": { + "code": "BadArgument", + "message": "The provided database 'foo' has an invalid username." + } + } + } + }, + "operationId": "SessionHostProvisioningStatuses_Get", + "title": "SessionHostManagements_SessionHostProvisioningStatuses_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Update.json new file mode 100644 index 000000000000..4854cbc0c044 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "sessionHostManagement": { + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + } + } + }, + "operationId": "SessionHostManagements_Update", + "title": "SessionHostManagements_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json new file mode 100644 index 000000000000..4e7582225f50 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHostManagements_UpdateSessionHosts_Post.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "updateSessionHostsRequestBody": { + "scheduledDateTime": "2008-09-22T14:01:54.9571247Z", + "scheduledDateTimeZone": "Alaskan Standard Time", + "update": { + "deleteOriginalVm": true, + "maxVmsRemoved": 4, + "logOffDelayMinutes": 10, + "logOffMessage": "logging off for hostpool update" + } + } + }, + "responses": { + "204": { + "description": "Operation completed successfully." + } + }, + "operationId": "InitiateSessionHostUpdate_Post", + "title": "SessionHostManagements_UpdateSessionHosts_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHost_RetryProvisioning_Post.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHost_RetryProvisioning_Post.json new file mode 100644 index 000000000000..fa0d793517cb --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHost_RetryProvisioning_Post.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "description": "Operation completed successfully." + } + }, + "operationId": "SessionHosts_RetryProvisioning", + "title": "SessionHosts_RetryProvisioning_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Delete.json new file mode 100644 index 000000000000..7d530543c65e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + "204": {} + }, + "operationId": "SessionHosts_Delete", + "title": "SessionHost_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Get.json new file mode 100644 index 000000000000..103fb6a4455c --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Get", + "title": "SessionHost_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_List.json new file mode 100644 index 000000000000..de994d043b25 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_List.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + }, + { + "name": "sessionHost2.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost2microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2008-09-22T14:01:54.9571247Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user2@microsoft.com", + "status": "Available", + "statusTimestamp": "2008-09-22T14:01:54.9571247Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + ] + } + } + }, + "operationId": "SessionHosts_List", + "title": "SessionHost_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Update.json new file mode 100644 index 000000000000..104a6b29a982 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/SessionHosts_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview", + "force": true, + "sessionHost": { + "properties": { + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sessionHost1.microsoft.com", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionhosts", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "lastHeartBeat": "2019-01-11T19:27:13.6108027Z", + "sessions": 1, + "agentVersion": "1.0.0.1391", + "allowNewSession": true, + "assignedUser": "user1@microsoft.com", + "status": "Available", + "statusTimestamp": "2019-01-24T20:00:08.2893033Z", + "osVersion": "10.0.17763", + "sxSStackVersion": "rdp-sxs190816002", + "updateState": "Succeeded", + "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "lastSessionHostUpdateTime": "2021-01-14T02:09:37.6236843Z", + "sessionHostConfiguration": "2021-01-14T02:09:37.6236843Z", + "friendlyName": "friendly", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1", + "sessionHostHealthCheckResults": [ + { + "healthCheckName": "DomainJoinedCheck", + "healthCheckResult": "HealthCheckSucceeded", + "additionalFailureDetails": { + "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥", + "errorCode": 0, + "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z" + } + } + ] + } + } + } + }, + "operationId": "SessionHosts_Update", + "title": "SessionHost_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/StartMenuItems_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/StartMenuItems_List.json new file mode 100644 index 000000000000..2cb157362d81 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/StartMenuItems_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "applicationGroupName": "applicationGroup1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "application1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application1", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "word", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + }, + { + "name": "application2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/startMenuItem/application2", + "type": "Microsoft.DesktopVirtualization/applicationGroups/startMenuItems", + "properties": { + "appAlias": "excel", + "filePath": "/path/to/file", + "commandLineArguments": "arguments", + "iconPath": "/path/to/icon", + "iconIndex": 1 + } + } + ] + } + } + }, + "operationId": "StartMenuItems_List", + "title": "StartMenuItems_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSession_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSession_Get.json new file mode 100644 index 000000000000..05c73e251cf9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSession_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + } + }, + "operationId": "UserSessions_Get", + "title": "UserSessions_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_Delete.json new file mode 100644 index 000000000000..f96d8cbd149e --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview", + "force": true + }, + "responses": { + "200": { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + "204": {} + }, + "operationId": "UserSessions_Delete", + "title": "UserSession_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_Disconnect.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_Disconnect.json new file mode 100644 index 000000000000..08d820afcaf7 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_Disconnect.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": {} + }, + "operationId": "UserSessions_Disconnect", + "title": "UserSession_Disconnect_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_List.json new file mode 100644 index 000000000000..948c83dbd897 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_List", + "title": "UserSession_List" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_ListByHostPool.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_ListByHostPool.json new file mode 100644 index 000000000000..59d9cc05ba74 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_ListByHostPool.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "api-version": "2025-09-01-preview", + "$filter": "userPrincipalName eq 'user1@microsoft.com' and state eq 'active'", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + }, + { + "name": "2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/2", + "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts/userSessions", + "systemData": { + "createdBy": null, + "createdByType": null, + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": null, + "lastModifiedByType": null, + "lastModifiedAt": null + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "userPrincipalName": "user1@microsoft.com", + "applicationType": "Desktop", + "sessionState": "Active", + "activeDirectoryUserName": "WVDARM\\user1", + "createTime": "2008-09-22T14:01:54.9571247Z" + } + } + ] + } + } + }, + "operationId": "UserSessions_ListByHostPool", + "title": "UserSession_ListByHostPool" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_SendMessage.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_SendMessage.json new file mode 100644 index 000000000000..ee95901eb019 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/UserSessions_SendMessage.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "hostPoolName": "hostPool1", + "sessionHostName": "sessionHost1.microsoft.com", + "userSessionId": "1", + "api-version": "2025-09-01-preview", + "sendMessage": { + "messageTitle": "title", + "messageBody": "body" + } + }, + "responses": { + "200": { + "description": "The request has succeeded." + } + }, + "operationId": "UserSessions_SendMessage", + "title": "UserSession_SendMessage_Post" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_CreateOrUpdate.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_CreateOrUpdate.json new file mode 100644 index 000000000000..24a6f39e9b52 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_CreateOrUpdate.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview", + "workspace": { + "location": "centralus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly", + "oboTenantId": "CD48BF6F-60D9-44CD-AB66-039D89C2E995" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + }, + "201": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_CreateOrUpdate", + "title": "Workspace_Create" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Delete.json new file mode 100644 index 000000000000..49d7585f287b --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Delete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + "204": {} + }, + "operationId": "Workspaces_Delete", + "title": "Workspace_Delete" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Get.json new file mode 100644 index 000000000000..61b13abe55e9 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Get", + "title": "Workspace_Get" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_ListByResourceGroup.json new file mode 100644 index 000000000000..79b8faf9cb62 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListByResourceGroup", + "title": "Workspace_ListByResourceGroup" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_ListBySubscription.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_ListBySubscription.json new file mode 100644 index 000000000000..4bdc93d564bf --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "api-version": "2025-09-01-preview", + "pageSize": 10, + "isDescending": true, + "initialSkip": 0 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + }, + { + "name": "workspace2", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace2", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + ] + } + } + }, + "operationId": "Workspaces_ListBySubscription", + "title": "Workspaces_ListBySubscription" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Update.json new file mode 100644 index 000000000000..2f348ba7f919 --- /dev/null +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/preview/2025-09-01-preview/examples/Workspaces_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "api-version": "2025-09-01-preview", + "workspace": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "des1", + "friendlyName": "friendly" + } + } + }, + "responses": { + "200": { + "body": { + "name": "workspace1", + "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", + "type": "Microsoft.DesktopVirtualization/workspaces", + "location": "centralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325", + "description": "des1", + "friendlyName": "friendly", + "cloudPcResource": false + } + } + } + }, + "operationId": "Workspaces_Update", + "title": "Workspace_Update" +} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/readme.md b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/readme.md index abc2bc710868..5d5172fa50c1 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/readme.md +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/readme.md @@ -26,7 +26,74 @@ These are the global settings for the DesktopVirtualizationClient API. ```yaml openapi-type: arm -tag: package-preview-2025-04-01-preview +tag: package-preview-2025-09-01-preview +``` +### Tag: package-preview-2025-09-01-preview + +These settings apply only when `--tag=package-preview-2025-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-preview-2025-09-01-preview' +input-file: + - preview/2025-09-01-preview/desktopvirtualization.json +suppressions: + - code: RequiredPropertiesMissingInResourceModel + from: desktopvirtualization.json + reason: Discussed in the ARM API office hour and get approved. Even Common type for operation result don't have the related properties. The rule seems conflict with the contract. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/types.json#L270 and also https://github.com/Azure/azure-openapi-validator/pull/767#issuecomment-2732917683. There is a fix for this and is waiting for the rollout. + where: + - $.definitions.ResourceProviderOperationListResult + - code: PutResponseCodes + from: desktopvirtualization.json + reason: Discussed in the ARM API office hour and get approved. Our service are currently returning the 200 status code not 201, and this is already in the stable version. + where: + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}'].* + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}'].* + - code: BodyTopLevelProperties + from: desktopvirtualization.json + reason: Our service design forces this behavior -> The response in this new API aligns with an existing API (/sessionHostManagements/default/sessionHostUpdateStatuses/default). Those 2 APIs are tightly related and will be in the same public version, so we would want to make sure they share a similar pattern. + where: + - $.definitions.SessionHostManagementProvisioningStatus + - code: RequiredPropertiesMissingInResourceModel + from: desktopvirtualization.json + reason: Our service design forces this behavior -> The response in this new API aligns with an existing API (/sessionHostManagements/default/sessionHostUpdateStatuses/default). Those 2 APIs are tightly related and will be in the same public version, so we would want to make sure they share a similar pattern. + where: + - $.definitions.SessionHostManagementProvisioningStatus + - code: DefinitionsPropertiesNamesCamelCase + from: desktopvirtualization.json + reason: Property name follows RDP specification and existing naming conventions in the service. + where: + - $.definitions.HostPoolProperties.properties.allowRDPShortPathWithPrivateLink + - $.definitions.HostPoolPatchProperties.properties.allowRDPShortPathWithPrivateLink +``` + +### Tag: package-preview-2025-08-01-preview + +These settings apply only when `--tag=package-preview-2025-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-preview-2025-08-01-preview' +input-file: + - preview/2025-08-01-preview/desktopvirtualization.json +suppressions: + - code: RequiredPropertiesMissingInResourceModel + from: desktopvirtualization.json + reason: Discussed in the ARM API office hour and get approved. Even Common type for operation result don't have the related properties. The rule seems conflict with the contract. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v5/types.json#L270 and also https://github.com/Azure/azure-openapi-validator/pull/767#issuecomment-2732917683. There is a fix for this and is waiting for the rollout. + where: + - $.definitions.ResourceProviderOperationListResult + - code: PutResponseCodes + from: desktopvirtualization.json + reason: Discussed in the ARM API office hour and get approved. Our service are currently returning the 200 status code not 201, and this is already in the stable version. + where: + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}'].* + - $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}'].* + - code: BodyTopLevelProperties + from: desktopvirtualization.json + reason: Our service design forces this behavior -> The response in this new API aligns with an existing API (/sessionHostManagements/default/sessionHostUpdateStatuses/default). Those 2 APIs are tightly related and will be in the same public version, so we would want to make sure they share a similar pattern. + where: + - $.definitions.SessionHostManagementProvisioningStatus + - code: RequiredPropertiesMissingInResourceModel + from: desktopvirtualization.json + reason: Our service design forces this behavior -> The response in this new API aligns with an existing API (/sessionHostManagements/default/sessionHostUpdateStatuses/default). Those 2 APIs are tightly related and will be in the same public version, so we would want to make sure they share a similar pattern. + where: + - $.definitions.SessionHostManagementProvisioningStatus ``` ### Tag: package-preview-2025-04-01-preview diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/tspconfig.yaml b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/tspconfig.yaml index a5a327f5579a..3ed686b0093c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/tspconfig.yaml +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/DesktopVirtualization/tspconfig.yaml @@ -8,7 +8,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{version-status}/{version}/desktopvirtualization.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" linter: extends: diff --git a/specification/devcenter/DevCenter.Management/back-compatible.tsp b/specification/devcenter/DevCenter.Management/back-compatible.tsp index 718916f3f2a9..7bf8bd8ae487 100644 --- a/specification/devcenter/DevCenter.Management/back-compatible.tsp +++ b/specification/devcenter/DevCenter.Management/back-compatible.tsp @@ -166,3 +166,68 @@ using Microsoft.DevCenter; "IdentityType", "python,javascript" ); + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AllowedEnvironmentType.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AttachedNetworkConnection.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Catalog.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CustomizationTask.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DevBoxDefinition.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DevCenterEncryptionSet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DevCenter.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EnvironmentDefinition.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EnvironmentType.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Gallery.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(HealthCheckStatusDetails.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ImageDefinitionBuild.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ImageDefinition.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Image.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ImageVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NetworkConnection.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Pool.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProjectEnvironmentType.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProjectPolicy.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Project.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Schedule.properties, + "autorest" +); diff --git a/specification/devcenter/DevCenter.Management/models.tsp b/specification/devcenter/DevCenter.Management/models.tsp index 8c3089e7ea20..a8a7aa471275 100644 --- a/specification/devcenter/DevCenter.Management/models.tsp +++ b/specification/devcenter/DevCenter.Management/models.tsp @@ -733,9 +733,9 @@ model DevCenterUpdate is TrackedResourceUpdate { @doc("Managed identity properties.") identity?: Azure.ResourceManager.CommonTypes.ManagedServiceIdentity; - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a Dev Center to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DevCenterUpdateProperties; } @@ -785,9 +785,9 @@ model KeyEncryptionKeyIdentity { @doc("The devcenter encryption set resource for partial updates. Properties not provided in the update request will not be changed.") model EncryptionSetUpdate is TrackedResourceUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a Dev Center encryption set to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DevCenterEncryptionSetUpdateProperties; @doc("Managed identity properties") @@ -833,9 +833,9 @@ model ResourcePolicy { @doc("The project policy properties for partial update. Properties not provided in the update request will not be changed.") model ProjectPolicyUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of an project policy to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ProjectPolicyUpdateProperties; } @@ -983,9 +983,9 @@ model AssignedGroup { @doc("The project properties for partial update. Properties not provided in the update request will not be changed.") model ProjectUpdate is TrackedResourceUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a project to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ProjectUpdateProperties; @doc("Managed identity properties.") @@ -1265,9 +1265,9 @@ model GitCatalog { @doc("The catalog's properties for partial update. Properties not provided in the update request will not be changed.") model CatalogUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Catalog properties for update.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: CatalogUpdateProperties; } @@ -1511,9 +1511,9 @@ model EnvironmentTypeUpdateProperties { @doc("The environment type for partial update. Properties not provided in the update request will not be changed.") model EnvironmentTypeUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of an environment type to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: EnvironmentTypeUpdateProperties; #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Correct representation for resource tags." @@ -1596,9 +1596,9 @@ model UserRoleAssignment { @doc("The project environment type for partial update. Properties not provided in the update request will not be changed.") model ProjectEnvironmentTypeUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties to configure an environment type.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ProjectEnvironmentTypeUpdateProperties; #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Correct representation for resource tags." @@ -1672,9 +1672,9 @@ model DevBoxDefinitionUpdateProperties { @doc("Partial update of a Dev Box definition resource.") model DevBoxDefinitionUpdate is TrackedResourceUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a Dev Box definition to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DevBoxDefinitionUpdateProperties; } @@ -2142,9 +2142,9 @@ model ActiveHoursConfiguration { @doc("The pool properties for partial update. Properties not provided in the update request will not be changed.") model PoolUpdate is TrackedResourceUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a pool to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: PoolUpdateProperties; } @@ -2177,9 +2177,9 @@ model ScheduleUpdateProperties is TrackedResourceUpdate { @doc("The schedule properties for partial update. Properties not provided in the update request will not be changed.") model ScheduleUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a schedule resource to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ScheduleUpdateProperties; } @@ -2224,9 +2224,9 @@ model NetworkConnectionUpdateProperties { @doc("The network connection properties for partial update. Properties not provided in the update request will not be changed.") model NetworkConnectionUpdate is TrackedResourceUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Legacy" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Legacy" @doc("Properties of a network connection resource to be updated.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: NetworkConnectionUpdateProperties; } diff --git a/specification/devcenter/DevCenter.Management/tspconfig.yaml b/specification/devcenter/DevCenter.Management/tspconfig.yaml index 5d0b8104aa16..f077b62a5fde 100644 --- a/specification/devcenter/DevCenter.Management/tspconfig.yaml +++ b/specification/devcenter/DevCenter.Management/tspconfig.yaml @@ -11,7 +11,7 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/DevCenterRP.json" emit-lro-options: "all" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + use-read-only-status-schema: true "@azure-tools/typespec-csharp": namespace: "Azure.ResourceManager.DevCenter" diff --git a/specification/deviceregistry/DeviceRegistry.Management/back-compatible.tsp b/specification/deviceregistry/DeviceRegistry.Management/back-compatible.tsp new file mode 100644 index 000000000000..ef415fbcd328 --- /dev/null +++ b/specification/deviceregistry/DeviceRegistry.Management/back-compatible.tsp @@ -0,0 +1,56 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Microsoft.DeviceRegistry; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AssetEndpointProfile.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Asset.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BillingContainer.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Credential.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DiscoveredAssetEndpointProfile.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DiscoveredAsset.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamespaceAsset.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamespaceDevice.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamespaceDiscoveredAsset.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NamespaceDiscoveredDevice.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Namespace.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Policy.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Schema.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SchemaRegistry.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SchemaVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/deviceregistry/DeviceRegistry.Management/main.tsp b/specification/deviceregistry/DeviceRegistry.Management/main.tsp index 1e83b95cd3da..1d13624ba71c 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/main.tsp +++ b/specification/deviceregistry/DeviceRegistry.Management/main.tsp @@ -9,6 +9,7 @@ import "./discoveredAssets.tsp"; import "./discoveredAssetEndpointProfiles.tsp"; import "./namespaces.tsp"; import "./ns_credential.tsp"; +import "./back-compatible.tsp"; import "./ns_policy.tsp"; import "./ns_assets.tsp"; import "./ns_devices.tsp"; diff --git a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml index 3900d668ab85..3d1d54d191ab 100644 --- a/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml +++ b/specification/deviceregistry/DeviceRegistry.Management/tspconfig.yaml @@ -8,8 +8,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/deviceregistry.json" use-read-only-status-schema: true omit-unreachable-types: true diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/back-compatible.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/back-compatible.tsp new file mode 100644 index 000000000000..abc153ee3f3e --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/back-compatible.tsp @@ -0,0 +1,21 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.DevOpsInfrastructure; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ImageVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Pool.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ResourceDetailsObject.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Microsoft.DevOpsInfrastructure.ResourceSku.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp index 6aa724bdd8da..e89fb150c8de 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp @@ -1,4 +1,5 @@ import "@typespec/http"; +import "./back-compatible.tsp"; import "@typespec/openapi"; import "@typespec/rest"; import "@azure-tools/typespec-azure-core"; diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml index 4bcd3f3da22c..c5e4b9dbebc1 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml @@ -13,8 +13,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/devopsinfrastructure.json" omit-unreachable-types: true "@azure-tools/typespec-python": diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/GalleryImage.tsp b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/GalleryImage.tsp index ff872c4c597b..be7516108d39 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/GalleryImage.tsp +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/GalleryImage.tsp @@ -28,8 +28,8 @@ model GalleryImage extends Resource { /** * The properties of the resource. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties: GalleryImageProperties; } diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/models.tsp b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/models.tsp index 8243a839ac46..d766c14be50b 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/models.tsp +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/models.tsp @@ -1608,8 +1608,8 @@ model LabVirtualMachineCreationParameter { /** * The properties of the resource. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: LabVirtualMachineCreationParameterProperties; /** @@ -1982,8 +1982,8 @@ model ScheduleCreationParameter { /** * The properties of the schedule. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ScheduleCreationParameterProperties; /** @@ -2736,8 +2736,8 @@ model ApplicableSchedule extends Resource { /** * The properties of the resource. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties: ApplicableScheduleProperties; } diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/tspconfig.yaml b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/tspconfig.yaml index 1d51afc81520..bf1f407e52ab 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/tspconfig.yaml +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/DevTestLabs/tspconfig.yaml @@ -10,7 +10,7 @@ options: output-file: "{version-status}/{version}/DTL.json" azure-resource-provider-folder: "resource-manager" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" "@azure-tools/typespec-csharp": flavor: azure diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/models.tsp b/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/models.tsp index 749ce5a161f7..c3993f74afb4 100644 --- a/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/models.tsp +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/models.tsp @@ -382,8 +382,8 @@ model ForwardingRulePatch { /** * Updatable properties of the forwarding rule. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ForwardingRulePatchProperties; } @@ -438,8 +438,8 @@ model VirtualNetworkLinkPatch { /** * Updatable properties of the virtual network link. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualNetworkLinkPatchProperties; } @@ -477,8 +477,8 @@ model VirtualNetworkDnsForwardingRuleset { /** * Properties of the virtual network link sub-resource reference. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: VirtualNetworkLinkSubResourceProperties; } @@ -585,8 +585,8 @@ model DnsSecurityRulePatch { /** * Updatable properties of the DNS security rule. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DnsSecurityRulePatchProperties; /** @@ -693,8 +693,8 @@ model DnsResolverDomainListPatch { /** * Updatable properties of the DNS resolver domain list. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: DnsResolverDomainListPatchProperties; /** @@ -722,8 +722,8 @@ model DnsResolverDomainListBulk { /** * Properties of the DNS resolver domain list upload or download request. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties: DnsResolverDomainListBulkProperties; } diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/readme.md b/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/readme.md index cb7e2cef1d56..9b11164e8790 100644 --- a/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/readme.md +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/readme.md @@ -35,7 +35,7 @@ tag: package-preview-2025-10 These settings apply only when `--tag=package-preview-2025-10` is specified on the command line. -```yaml $(tag) == 'package-2025-10' +```yaml $(tag) == 'package-preview-2025-10' input-file: - preview/2025-10-01-preview/openapi.json ``` diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/tspconfig.yaml b/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/tspconfig.yaml index 6fabaf95941e..66feb27119a5 100644 --- a/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/tspconfig.yaml +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/DnsResolver/tspconfig.yaml @@ -11,14 +11,8 @@ options: output-file: "{version-status}/{version}/openapi.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + emit-lro-options: "all" - "@azure-tools/typespec-csharp": - flavor: azure - clear-output-folder: true - model-namespace: true - namespace: "Azure.ResourceManager.DnsResolver" - emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" "@azure-tools/typespec-python": package-dir: "azure-mgmt-dnsresolver" namespace: "azure.mgmt.dnsresolver" diff --git a/specification/durabletask/DurableTask.Management/client.tsp b/specification/durabletask/DurableTask.Management/client.tsp index 0ee9348a5844..070d67a09b91 100644 --- a/specification/durabletask/DurableTask.Management/client.tsp +++ b/specification/durabletask/DurableTask.Management/client.tsp @@ -12,20 +12,32 @@ using Microsoft.DurableTask; @@clientName(Microsoft.DurableTask, "DurableTaskManagementClient", "java"); // csharp -@@clientName(Scheduler, "Scheduler", "csharp"); -@@clientName(SchedulerProperties, "SchedulerProperties", "csharp"); -@@clientName(TaskHub, "SchedulerTaskHub", "csharp"); -@@clientName(TaskHubProperties, "SchedulerTaskHubProperties", "csharp"); -@@clientName(ProvisioningState, "ProvisioningState", "csharp"); -@@clientName(SchedulerUpdate, "SchedulerPatch", "csharp"); -@@clientName(SchedulerPropertiesUpdate, "SchedulerPatchProperties", "csharp"); -@@clientName(SchedulerSku, "SchedulerSku", "csharp"); -@@clientName(SchedulerSkuUpdate, "SchedulerSkuUpdate", "csharp"); -@@clientName(RedundancyState, "ResourceRedundancyState", "csharp"); +@@clientName(Scheduler, "DurableTaskScheduler", "csharp"); +@@clientName(SchedulerProperties, "DurableTaskSchedulerProperties", "csharp"); +@@clientName(TaskHub, "DurableTaskHub", "csharp"); +@@clientName(TaskHubProperties, "DurableTaskHubProperties", "csharp"); +@@clientName(ProvisioningState, "DurableTaskProvisioningState", "csharp"); +@@clientName(SchedulerUpdate, "DurableTaskSchedulerPatch", "csharp"); +@@clientName(SchedulerPropertiesUpdate, + "DurableTaskSchedulerPatchProperties", + "csharp" +); +@@clientName(SchedulerSku, "DurableTaskSchedulerSku", "csharp"); +@@clientName(SchedulerSkuName, "DurableTaskSchedulerSkuName", "csharp"); +@@clientName(SchedulerSkuUpdate, "DurableTaskSchedulerSkuUpdate", "csharp"); +@@clientName(RedundancyState, "DurableTaskResourceRedundancyState", "csharp"); @@clientName(PurgeableOrchestrationState, - "PurgeableOrchestrationState", + "DurableTaskPurgeableOrchestrationState", + "csharp" +); +@@clientName(RetentionPolicyDetails, + "DurableTaskRetentionPolicyDetails", + "csharp" +); +@@clientName(RetentionPolicy, "DurableTaskRetentionPolicy", "csharp"); +@@clientName(RetentionPolicyProperties, + "DurableTaskRetentionPolicyProperties", "csharp" ); -@@clientName(RetentionPolicyDetails, "RetentionPolicyDetails", "csharp"); -@@clientName(RetentionPolicy, "RetentionPolicy", "csharp"); -@@clientName(RetentionPolicyProperties, "RetentionPolicyProperties", "csharp"); +@@clientName(SchedulerProperties.ipAllowlist, "IPAllowlist", "csharp"); +@@clientName(SchedulerPropertiesUpdate.ipAllowlist, "IPAllowlist", "csharp"); diff --git a/specification/durabletask/DurableTask.Management/tspconfig.yaml b/specification/durabletask/DurableTask.Management/tspconfig.yaml index a01798456e23..bb0605b883ad 100644 --- a/specification/durabletask/DurableTask.Management/tspconfig.yaml +++ b/specification/durabletask/DurableTask.Management/tspconfig.yaml @@ -30,12 +30,9 @@ options: generate-fakes: true head-as-boolean: true inject-spans: true - "@azure-tools/typespec-csharp": - emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" - flavor: azure - clear-output-folder: true - model-namespace: false + "@azure-typespec/http-client-csharp-mgmt": namespace: "Azure.ResourceManager.DurableTask" + emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" "@azure-tools/typespec-ts": flavor: azure experimental-extensible-enums: true diff --git a/specification/edgezones/EdgeZones.Management/back-compatible.tsp b/specification/edgezones/EdgeZones.Management/back-compatible.tsp new file mode 100644 index 000000000000..c14274b0bd05 --- /dev/null +++ b/specification/edgezones/EdgeZones.Management/back-compatible.tsp @@ -0,0 +1,8 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Microsoft.EdgeZones; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExtendedZone.properties, + "autorest" +); diff --git a/specification/edgezones/EdgeZones.Management/main.tsp b/specification/edgezones/EdgeZones.Management/main.tsp index 58a482194d0a..8869d355dde2 100644 --- a/specification/edgezones/EdgeZones.Management/main.tsp +++ b/specification/edgezones/EdgeZones.Management/main.tsp @@ -1,4 +1,5 @@ import "@typespec/http"; +import "./back-compatible.tsp"; import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; diff --git a/specification/edgezones/EdgeZones.Management/tspconfig.yaml b/specification/edgezones/EdgeZones.Management/tspconfig.yaml index faa2b335147e..849405f22630 100644 --- a/specification/edgezones/EdgeZones.Management/tspconfig.yaml +++ b/specification/edgezones/EdgeZones.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true use-read-only-status-schema: true emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/edgezones.json" diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/client.tsp b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/client.tsp index 68a6361bab0d..bcd8eba7a8ef 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/client.tsp +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/client.tsp @@ -72,3 +72,5 @@ using Azure.Core; @@clientLocation(Microsoft.ElasticSan.restoreVolume, "Management", "go"); @@clientName(Microsoft.ElasticSan, "ElasticSanMgmtClient", "python"); + +@@clientName(SKUCapability, "SkuCapability", "java"); diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/models.tsp b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/models.tsp index cd8033f8655b..0f3e429376a6 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/models.tsp +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/models.tsp @@ -975,8 +975,8 @@ model PrivateLinkResource extends Azure.ResourceManager.Foundations.Resource { /** * Resource properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: PrivateLinkResourceProperties; } diff --git a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/tspconfig.yaml b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/tspconfig.yaml index 069ef2e67b08..973d55c17f62 100644 --- a/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/tspconfig.yaml +++ b/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/tspconfig.yaml @@ -26,8 +26,9 @@ options: "@azure-tools/typespec-java": emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-elasticsan" namespace: "com.azure.resourcemanager.elasticsan" - service-name: "ElasticSan" # human-readable service name, whitespace allowed + service-name: "ElasticSan" flavor: azure + client-side-validations: true "@azure-tools/typespec-ts": service-dir: "sdk/elasticsans" emitter-output-dir: "{output-dir}/{service-dir}/arm-elasticsan" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index 628890c15da0..f7f68f9a4b59 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -47,6 +47,8 @@ options: emitter-output-dir: "{output-dir}/{service-dir}/azsystemevents" slice-elements-byval: true flavor: "azure" + # executes any go:generate commands in build.go, which generates the system events enumeration. + go-generate: build.go "@azure-tools/typespec-java": emitter-output-dir: "{output-dir}/{service-dir}/azure-messaging-eventgrid-systemevents" namespace: com.azure.messaging.eventgrid.systemevents diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/Eventhub/tspconfig.yaml b/specification/eventhub/resource-manager/Microsoft.EventHub/Eventhub/tspconfig.yaml index 539d60809b05..3d6b03a2ca1b 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/Eventhub/tspconfig.yaml +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/Eventhub/tspconfig.yaml @@ -12,7 +12,7 @@ options: arm-types-dir: "{project-root}/../../../../common-types/resource-management" emit-lro-options: "all" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + "@azure-tools/typespec-csharp": emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" flavor: azure diff --git a/specification/ews/SecretSyncController.Management/back-compatible.tsp b/specification/ews/SecretSyncController.Management/back-compatible.tsp new file mode 100644 index 000000000000..9001e9e3a96f --- /dev/null +++ b/specification/ews/SecretSyncController.Management/back-compatible.tsp @@ -0,0 +1,15 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.SecretSyncController; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AzureKeyVaultSecretProviderClass.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SecretSync.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/ews/SecretSyncController.Management/main.tsp b/specification/ews/SecretSyncController.Management/main.tsp index f9697a330b5d..a49d30d5ccb4 100644 --- a/specification/ews/SecretSyncController.Management/main.tsp +++ b/specification/ews/SecretSyncController.Management/main.tsp @@ -1,4 +1,5 @@ import "@typespec/http"; +import "./back-compatible.tsp"; import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; diff --git a/specification/ews/SecretSyncController.Management/tspconfig.yaml b/specification/ews/SecretSyncController.Management/tspconfig.yaml index 7e09d3d4f8f9..0f393756a179 100644 --- a/specification/ews/SecretSyncController.Management/tspconfig.yaml +++ b/specification/ews/SecretSyncController.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/secretsynccontroller.json" use-read-only-status-schema: true emit-common-types-schema: never - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true "@azure-tools/typespec-csharp": flavor: azure clear-output-folder: true diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/back-compatible.tsp b/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/back-compatible.tsp new file mode 100644 index 000000000000..6b4fbe14a248 --- /dev/null +++ b/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/back-compatible.tsp @@ -0,0 +1,14 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Microsoft.Fabric; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(FabricCapacity.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/main.tsp b/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/main.tsp index 20ce2d063bc5..346f6ac78795 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/main.tsp +++ b/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/main.tsp @@ -4,6 +4,7 @@ import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; import "./capacity.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Versioning; using Azure.ResourceManager; diff --git a/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/tspconfig.yaml b/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/tspconfig.yaml index 85cabbeb7659..554f3065a2d7 100644 --- a/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/tspconfig.yaml +++ b/specification/fabric/resource-manager/Microsoft.Fabric/Fabric/tspconfig.yaml @@ -10,8 +10,6 @@ options: azure-resource-provider-folder: "resource-manager" arm-types-dir: "{project-root}/../../../../common-types/resource-management" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{version-status}/{version}/fabric.json" "@azure-tools/typespec-csharp": emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json deleted file mode 100644 index daa33d9609b1..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateAutoscaleCluster.json +++ /dev/null @@ -1,354 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "Trino", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2 - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "Trino", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateClusterPool.json deleted file mode 100644 index 9254f96ab85b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateClusterPool.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateSparkCluster.json deleted file mode 100644 index d7539c71112c..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/CreateSparkCluster.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "sparkProfile": {}, - "sshProfile": { - "count": 2 - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "spark", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/DeleteCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/DeleteCluster.json deleted file mode 100644 index 142c97810fcb..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/DeleteCluster.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "rg1", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "description": "Successful.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "202": { - "description": "Cluster delete request accepted.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/DeleteClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/DeleteClusterPool.json deleted file mode 100644 index f42610f4b2f0..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/DeleteClusterPool.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "rg1", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "description": "Successful.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "202": { - "description": "Cluster Pool delete request accepted.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json deleted file mode 100644 index 9eaad022d260..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetCluster.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetClusterInstanceView.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetClusterInstanceView.json deleted file mode 100644 index a4944fd08cb1..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetClusterInstanceView.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2023-06-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "name": "default", - "properties": { - "status": { - "ready": "True", - "reason": "", - "message": "" - }, - "serviceStatuses": [ - { - "kind": "ZooKeeper", - "ready": "true", - "message": "" - } - ] - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetClusterPool.json deleted file mode 100644 index 1d6a2f638f7b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetClusterPool.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetOperations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetOperations.json deleted file mode 100644 index 3ee35d68c9ab..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/GetOperations.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "resourceGroup1", - "api-version": "2023-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.HDInsight/clusterpool/read", - "isDataAction": false, - "display": { - "provider": "HDInsight on AKS", - "resource": "Cluster Pool.", - "operation": "Get Cluster Pool Operation result.", - "description": "Get any cluster pool." - }, - "origin": "user, system" - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListAvailableClusterPoolVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListAvailableClusterPoolVersions.json deleted file mode 100644 index d3d68ee90e4f..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListAvailableClusterPoolVersions.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "location": "westus2", - "api-version": "2023-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.0", - "name": "1.0", - "properties": { - "clusterPoolVersion": "1.0", - "aksVersion": "1.24", - "isPreview": false - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.1", - "name": "1.1", - "properties": { - "clusterPoolVersion": "1.1", - "aksVersion": "1.25", - "isPreview": false - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.2", - "name": "1.2", - "properties": { - "clusterPoolVersion": "1.2", - "aksVersion": "1.26", - "isPreview": true - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListAvailableClusterVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListAvailableClusterVersions.json deleted file mode 100644 index b1da94fb829b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListAvailableClusterVersions.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "location": "westus2", - "api-version": "2023-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/flink_1.16.0-1.0.4", - "name": "flink_1.16.0-1.0.4", - "properties": { - "clusterType": "Flink", - "clusterVersion": "1.0.4", - "ossVersion": "1.16.0", - "clusterPoolVersion": "1.0", - "isPreview": false, - "components": [ - { - "name": "TaskManager", - "version": "1.16.0" - }, - { - "name": "JobManager", - "version": "1.16.0" - } - ] - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/spark_3.3.1-1.0.4", - "name": "spark_3.3.1-1.0.4", - "properties": { - "clusterType": "Spark", - "clusterVersion": "1.0.4", - "ossVersion": "3.3.1", - "clusterPoolVersion": "1.0", - "isPreview": false, - "components": [ - { - "name": "Hadoop", - "version": "3.2.3" - }, - { - "name": "Hive", - "version": "3.1.4" - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterInstanceViews.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterInstanceViews.json deleted file mode 100644 index 6af3c1e01ab1..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterInstanceViews.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2023-06-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "default", - "properties": { - "status": { - "ready": "True", - "reason": "", - "message": "" - }, - "serviceStatuses": [ - { - "kind": "ZooKeeper", - "ready": "true", - "message": "" - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterJobs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterJobs.json deleted file mode 100644 index da809a7418da..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterJobs.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourcegroup", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterPool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/jobs/flink-job-1", - "properties": { - "jobType": "FlinkJob", - "jobName": "flink-job-1", - "jobJarDirectory": "jobJarDirectory1", - "jarName": "job.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.ExampleJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "savepoint-directory" - }, - "jobId": "362b911137dfefc2e55784666f4d4253", - "status": "STOP-FAILED", - "jobOutput": "job-output", - "actionResult": "SUCCESS" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterPools.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterPools.json deleted file mode 100644 index 3870d11dee67..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterPools.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourcegroup", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterPoolsSubscription.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterPoolsSubscription.json deleted file mode 100644 index d6be9c963a9d..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterPoolsSubscription.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-06-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterServiceConfigs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterServiceConfigs.json deleted file mode 100644 index 66a6c3e67bde..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClusterServiceConfigs.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2023-06-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "serviceName": "hadoop-service", - "componentName": "hadoop-component", - "fileName": "capacity-scheduler.xml", - "content": "" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json deleted file mode 100644 index 903f8f90bdec..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ListClustersByClusterPoolName.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/LocationsNameAvailability.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/LocationsNameAvailability.json deleted file mode 100644 index 1d7bd9a43853..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/LocationsNameAvailability.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-06-01-preview", - "location": "southeastasia", - "NameAvailabilityParameters": { - "name": "contosemember1", - "type": "Microsoft.HDInsight/clusterPools/clusters" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "nameAvailable": false, - "reason": "AlreadyExists" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json deleted file mode 100644 index f43f807874e3..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchCluster.json +++ /dev/null @@ -1,456 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterPatchRequest": { - "location": "West US 2", - "properties": { - "clusterProfile": { - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "sshProfile": { - "count": 2 - }, - "authorizationProfile": { - "userIds": [ - "Testuser1", - "Testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2023-06-01-preview" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchClusterPool.json deleted file mode 100644 index bf3e334d8cec..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/PatchClusterPool.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterPoolTags": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json deleted file mode 100644 index acdc0d83e062..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/ResizeCluster.json +++ /dev/null @@ -1,143 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterResizeRequest": { - "location": "West US 2", - "properties": { - "targetWorkerNodeCount": 5 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 5 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-06-01-preview" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/RunClusterJob.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/RunClusterJob.json deleted file mode 100644 index 40db47287c4e..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/examples/RunClusterJob.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-06-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterJob": { - "properties": { - "jobType": "FlinkJob", - "jobName": "flink-job-name", - "action": "START", - "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", - "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" - } - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "properties": { - "jobType": "FlinkJob", - "jobName": "flink-job-name", - "action": "START", - "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", - "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" - } - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/hdinsight.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/hdinsight.json deleted file mode 100644 index 9177666a80ca..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-06-01-preview/hdinsight.json +++ /dev/null @@ -1,3148 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsight on AKS Management Client", - "description": "The HDInsight on AKS Management Client.", - "version": "2023-06-01-preview" - }, - "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.HDInsight/clusterpools/{clusterPoolName}": { - "get": { - "description": "Gets a cluster pool.", - "operationId": "ClusterPools_Get", - "x-ms-examples": { - "ClusterPoolGet": { - "$ref": "./examples/GetClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusterpool details.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Creates or updates a cluster pool.", - "operationId": "ClusterPools_CreateOrUpdate", - "x-ms-examples": { - "ClusterPoolPut": { - "$ref": "./examples/CreateClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "ClusterPool", - "description": "The Cluster Pool to create.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPool" - } - } - ], - "responses": { - "201": { - "description": "ClusterPool is created.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "200": { - "description": "Update successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing Cluster Pool Tags.", - "operationId": "ClusterPools_UpdateTags", - "x-ms-examples": { - "ClusterPoolsPatchTags": { - "$ref": "./examples/PatchClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "clusterPoolTags", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TagsObject" - }, - "description": "Parameters supplied to update tags." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "description": "Deletes a Cluster Pool.", - "operationId": "ClusterPools_Delete", - "x-ms-examples": { - "ClusterPoolDelete": { - "$ref": "./examples/DeleteClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Accepted response definition.", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No content - The Cluster Pool doesn't exist." - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusterpools": { - "get": { - "operationId": "ClusterPools_ListBySubscription", - "x-ms-examples": { - "ClusterPoolsListBySubscription": { - "$ref": "./examples/ListClusterPoolsSubscription.json" - } - }, - "description": "Gets the list of Cluster Pools within a Subscription.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Pools successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools": { - "get": { - "operationId": "ClusterPools_ListByResourceGroup", - "x-ms-examples": { - "ClusterPoolsListByResourceGroup": { - "$ref": "./examples/ListClusterPools.json" - } - }, - "description": "Lists the HDInsight cluster pools under a resource group.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Pools successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters": { - "get": { - "operationId": "Clusters_ListByClusterPoolName", - "description": "Lists the HDInsight cluster pools under a resource group.", - "x-ms-examples": { - "HDInsightClustersListByClusterPoolName": { - "$ref": "./examples/ListClustersByClusterPoolName.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusters successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/resize": { - "post": { - "description": "Resize an existing Cluster.", - "operationId": "Clusters_Resize", - "x-ms-examples": { - "HDInsightClusterResize": { - "$ref": "./examples/ResizeCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterResizeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterResizeData" - }, - "description": "Resize a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Cluster resize request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}": { - "get": { - "operationId": "Clusters_Get", - "description": "Gets a HDInsight cluster.", - "x-ms-examples": { - "HDInsightClusterGet": { - "$ref": "./examples/GetCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Cluster details.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "operationId": "Clusters_Create", - "description": "Creates a cluster.", - "x-ms-examples": { - "HDInsightClusterPut": { - "$ref": "./examples/CreateAutoscaleCluster.json" - }, - "HDInsightSparkClusterPut": { - "$ref": "./examples/CreateSparkCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "HDInsightCluster", - "in": "body", - "required": true, - "description": "The cluster to create.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - ], - "responses": { - "201": { - "description": "Cluster is created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "200": { - "description": "Update successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing Cluster.", - "operationId": "Clusters_Update", - "x-ms-examples": { - "HDInsightClustersPatchTags": { - "$ref": "./examples/PatchCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterPatchRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPatch" - }, - "description": "Patch a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "operationId": "Clusters_Delete", - "description": "Deletes a cluster.", - "x-ms-examples": { - "HDInsightClustersDelete": { - "$ref": "./examples/DeleteCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Cluster delete request accepted.", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No content - The Cluster doesn't exist." - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/runJob": { - "post": { - "operationId": "ClusterJobs_RunJob", - "description": "Operations on jobs of HDInsight on AKS cluster.", - "x-ms-examples": { - "RunClusterJob": { - "$ref": "./examples/RunClusterJob.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterJob", - "description": "The Cluster job.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterJob" - } - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterJob" - } - }, - "202": { - "description": "Run cluster job action request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/jobs": { - "get": { - "operationId": "ClusterJobs_List", - "description": "Get jobs of HDInsight on AKS cluster.", - "x-ms-examples": { - "ListClusterJobs": { - "$ref": "./examples/ListClusterJobs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Cluster job details.", - "schema": { - "$ref": "#/definitions/ClusterJobList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/serviceConfigs": { - "get": { - "operationId": "Clusters_ListServiceConfigs", - "description": "Lists the config dump of all services running in cluster.", - "x-ms-examples": { - "HDInsightClusterGetServiceConfigs": { - "$ref": "./examples/ListClusterServiceConfigs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceConfigListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability": { - "post": { - "description": "Check the availability of the resource name.", - "operationId": "Locations_CheckNameAvailability", - "x-ms-examples": { - "LocationsNameAvailability": { - "$ref": "./examples/LocationsNameAvailability.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "name": "NameAvailabilityParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - }, - "description": "The name and type of the resource." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/NameAvailabilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews": { - "get": { - "operationId": "Clusters_ListInstanceViews", - "x-ms-examples": { - "HDInsightClusterGetInstanceViews": { - "$ref": "./examples/ListClusterInstanceViews.json" - } - }, - "description": "Lists the lists of instance views", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClusterInstanceViewsResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews/default": { - "get": { - "operationId": "Clusters_GetInstanceView", - "description": "Gets the status of a cluster instance.", - "x-ms-examples": { - "HDInsightClusterGetInstanceView": { - "$ref": "./examples/GetClusterInstanceView.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClusterInstanceViewResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.HDInsight/operations": { - "get": { - "description": "Returns list of operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/GetOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation details.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterPoolVersions": { - "get": { - "description": "Returns a list of available cluster pool versions.", - "operationId": "AvailableClusterPoolVersions_ListByLocation", - "x-ms-examples": { - "ClusterPoolVersionListResult": { - "$ref": "./examples/ListAvailableClusterPoolVersions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster pool versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolVersionsListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterVersions": { - "get": { - "description": "Returns a list of available cluster versions.", - "operationId": "AvailableClusterVersions_ListByLocation", - "x-ms-examples": { - "ClusterVersionListResult": { - "$ref": "./examples/ListAvailableClusterVersions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterVersionsListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ClusterPoolListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClusterPool" - }, - "description": "The list of cluster pools." - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - }, - "description": "The list cluster pools operation response." - }, - "ClusterPoolProfile": { - "type": "object", - "description": "Cluster pool profile.", - "required": [ - "clusterPoolVersion" - ], - "properties": { - "clusterPoolVersion": { - "$ref": "#/definitions/ClusterPoolVersionPattern" - } - } - }, - "ClusterPoolComputeProfile": { - "type": "object", - "description": "Cluster pool compute profile.", - "required": [ - "vmSize" - ], - "properties": { - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - }, - "count": { - "description": "The number of virtual machines.", - "type": "integer", - "format": "int32", - "readOnly": true - } - } - }, - "ClusterPoolNetworkProfile": { - "type": "object", - "description": "Cluster pool networking configuration.", - "required": [ - "subnetId" - ], - "properties": { - "subnetId": { - "type": "string", - "description": "Cluster pool subnet resource id.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.Network/virtualNetworks/subnets" - } - ] - } - } - } - }, - "ClusterPoolLogAnalyticsProfile": { - "type": "object", - "description": "Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "True if log analytics is enabled for cluster pool, otherwise false." - }, - "workspaceId": { - "type": "string", - "description": "Log analytics workspace to associate with the OMS agent.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.OperationalInsights/workspaces" - } - ] - } - } - } - }, - "AksClusterProfile": { - "type": "object", - "description": "Properties of the cluster pool underlying AKS cluster.", - "properties": { - "aksClusterResourceId": { - "type": "string", - "description": "ARM Resource ID of the AKS cluster", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ContainerService/managedClusters" - } - ] - } - }, - "aksClusterAgentPoolIdentityProfile": { - "description": "Identity properties of the AKS cluster agentpool MSI", - "allOf": [ - { - "$ref": "#/definitions/IdentityProfile" - } - ] - }, - "aksVersion": { - "type": "string", - "description": "AKS control plane and default node pool version of this ClusterPool", - "readOnly": true - } - } - }, - "ClusterPoolResourceProperties": { - "type": "object", - "required": [ - "computeProfile" - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "type": "string", - "enum": [ - "Accepted", - "Succeeded", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "readOnly": true - }, - "deploymentId": { - "type": "string", - "description": "A unique id generated by the RP to identify the resource.", - "example": "45cd32aead6e4a91b079a0cdbfac8c36", - "readOnly": true - }, - "managedResourceGroupName": { - "type": "string", - "description": "A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.", - "minLength": 1, - "maxLength": 40, - "example": "hdi-45cd32aead6e4a91b079a0cdbfac8c36" - }, - "aksManagedResourceGroupName": { - "type": "string", - "description": "A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}", - "readOnly": true, - "example": "MC_hdi-45cd32aead6e4a91b079a0cdbfac8c36_test-pool_eastus" - }, - "clusterPoolProfile": { - "description": "CLuster pool profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolProfile" - } - ] - }, - "computeProfile": { - "description": "CLuster pool compute profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolComputeProfile" - } - ] - }, - "aksClusterProfile": { - "description": "Properties of underlying AKS cluster.", - "readOnly": true, - "allOf": [ - { - "$ref": "#/definitions/AksClusterProfile" - } - ] - }, - "networkProfile": { - "description": "Cluster pool network profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolNetworkProfile" - } - ] - }, - "logAnalyticsProfile": { - "description": "Cluster pool log analytics profile to enable OMS agent for AKS cluster.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolLogAnalyticsProfile" - } - ] - }, - "status": { - "type": "string", - "description": "Business status of the resource.", - "example": "Running", - "readOnly": true - } - }, - "description": "Cluster pool resource properties." - }, - "ClusterPool": { - "type": "object", - "description": "Cluster pool.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster pool specific properties.", - "$ref": "#/definitions/ClusterPoolResourceProperties" - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "SystemData of cluster pool.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "TagsObject": { - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "description": "Tags object for patch operations." - }, - "ClusterListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The list of clusters." - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - }, - "description": "The list cluster operation response." - }, - "ClusterLogAnalyticsProfile": { - "type": "object", - "description": "Cluster log analytics profile to enable or disable OMS agent for cluster.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "True if log analytics is enabled for the cluster, otherwise false." - }, - "applicationLogs": { - "$ref": "#/definitions/ClusterLogAnalyticsApplicationLogs" - }, - "metricsEnabled": { - "type": "boolean", - "description": "True if metrics are enabled, otherwise false." - } - } - }, - "ClusterLogAnalyticsApplicationLogs": { - "type": "object", - "description": "Collection of logs to be enabled or disabled for log analytics.", - "properties": { - "stdOutEnabled": { - "type": "boolean", - "description": "True if stdout is enabled, otherwise false." - }, - "stdErrorEnabled": { - "type": "boolean", - "description": "True if stderror is enabled, otherwise false." - } - } - }, - "ClusterPrometheusProfile": { - "type": "object", - "description": "Cluster Prometheus profile.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable Prometheus for cluster or not.", - "default": false - } - } - }, - "IdentityProfile": { - "type": "object", - "description": "Identity Profile with details of an MSI.", - "required": [ - "msiResourceId", - "msiClientId", - "msiObjectId" - ], - "properties": { - "msiResourceId": { - "type": "string", - "description": "ResourceId of the MSI.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ManagedIdentity/userAssignedIdentities" - } - ] - } - }, - "msiClientId": { - "type": "string", - "description": "ClientId of the MSI.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - }, - "msiObjectId": { - "type": "string", - "description": "ObjectId of the MSI.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - } - } - }, - "AuthorizationProfile": { - "type": "object", - "description": "Authorization profile with details of AAD user Ids and group Ids authorized for data plane access.", - "properties": { - "userIds": { - "type": "array", - "description": "AAD user Ids authorized for data plane access.", - "items": { - "type": "string" - } - }, - "groupIds": { - "type": "array", - "description": "AAD group Ids authorized for data plane access.", - "items": { - "type": "string" - } - } - } - }, - "SecretReference": { - "type": "object", - "description": "Secret reference and corresponding properties of a key vault secret.", - "required": [ - "referenceName", - "type", - "keyVaultObjectName" - ], - "properties": { - "referenceName": { - "type": "string", - "description": "Reference name of the secret to be used in service configs." - }, - "type": { - "type": "string", - "description": "Type of key vault object: secret, key or certificate.", - "enum": [ - "Key", - "Secret", - "Certificate" - ], - "x-ms-enum": { - "name": "KeyVaultObjectType", - "modelAsString": true - } - }, - "version": { - "type": "string", - "description": "Version of the secret in key vault." - }, - "keyVaultObjectName": { - "type": "string", - "description": "Object identifier name of the secret in key vault.", - "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,126}$" - } - } - }, - "SecretsProfile": { - "type": "object", - "description": "The cluster secret profile.", - "required": [ - "keyVaultResourceId" - ], - "properties": { - "keyVaultResourceId": { - "type": "string", - "description": "Name of the user Key Vault where all the cluster specific user secrets are stored.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.KeyVault/vaults" - } - ] - } - }, - "secrets": { - "type": "array", - "description": "Properties of Key Vault secret.", - "items": { - "$ref": "#/definitions/SecretReference" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterConfigFile": { - "type": "object", - "description": "Cluster configuration files.", - "required": [ - "fileName" - ], - "properties": { - "fileName": { - "type": "string", - "description": "Configuration file name.", - "example": "hive-conf.xml." - }, - "content": { - "type": "string", - "description": "Free form content of the entire configuration file." - }, - "encoding": { - "type": "string", - "description": "This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text.", - "enum": [ - "Base64", - "None" - ], - "x-ms-enum": { - "name": "ContentEncoding", - "modelAsString": true - } - }, - "path": { - "type": "string", - "description": "Path of the config file if content is specified." - }, - "values": { - "type": "object", - "description": "List of key value pairs\nwhere key represents a valid service configuration name and value represents the value of the config.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ClusterServiceConfig": { - "type": "object", - "description": "Cluster configs per component.", - "required": [ - "component", - "files" - ], - "properties": { - "component": { - "type": "string", - "description": "Name of the component the config files should apply to." - }, - "files": { - "type": "array", - "description": "List of Config Files.", - "items": { - "$ref": "#/definitions/ClusterConfigFile" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterServiceConfigsProfile": { - "type": "object", - "description": "Cluster service configs.", - "required": [ - "serviceName", - "configs" - ], - "properties": { - "serviceName": { - "type": "string", - "description": "Name of the service the configurations should apply to." - }, - "configs": { - "type": "array", - "description": "List of service configs.", - "items": { - "$ref": "#/definitions/ClusterServiceConfig" - }, - "x-ms-identifiers": [] - } - } - }, - "ConnectivityProfile": { - "type": "object", - "description": "Cluster connectivity profile.", - "required": [ - "web" - ], - "properties": { - "web": { - "description": "Web connectivity endpoint details.", - "allOf": [ - { - "$ref": "#/definitions/WebConnectivityEndpoint" - } - ] - }, - "ssh": { - "type": "array", - "description": "List of SSH connectivity endpoints.", - "items": { - "$ref": "#/definitions/SshConnectivityEndpoint" - }, - "x-ms-identifiers": [] - } - }, - "readOnly": true - }, - "WebConnectivityEndpoint": { - "type": "object", - "description": "Web connectivity endpoint details.", - "required": [ - "fqdn" - ], - "properties": { - "fqdn": { - "type": "string", - "description": "Web connectivity endpoint.", - "example": "clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net" - } - }, - "readOnly": true - }, - "SshConnectivityEndpoint": { - "type": "object", - "description": "SSH connectivity endpoint details.", - "required": [ - "endpoint" - ], - "properties": { - "endpoint": { - "type": "string", - "description": "SSH connectivity endpoint.", - "example": "clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" - } - } - }, - "ClusterProfile": { - "type": "object", - "required": [ - "identityProfile", - "authorizationProfile", - "clusterVersion", - "ossVersion" - ], - "properties": { - "clusterVersion": { - "$ref": "#/definitions/ThreeOrFourPartVersionPattern" - }, - "ossVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "components": { - "$ref": "#/definitions/ClusterComponents" - }, - "identityProfile": { - "$ref": "#/definitions/IdentityProfile" - }, - "authorizationProfile": { - "$ref": "#/definitions/AuthorizationProfile" - }, - "secretsProfile": { - "$ref": "#/definitions/SecretsProfile" - }, - "serviceConfigsProfiles": { - "type": "array", - "description": "The service configs profiles.", - "items": { - "$ref": "#/definitions/ClusterServiceConfigsProfile" - }, - "x-ms-identifiers": [] - }, - "connectivityProfile": { - "$ref": "#/definitions/ConnectivityProfile" - }, - "logAnalyticsProfile": { - "$ref": "#/definitions/ClusterLogAnalyticsProfile" - }, - "prometheusProfile": { - "$ref": "#/definitions/ClusterPrometheusProfile" - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile" - }, - "autoscaleProfile": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "kafkaProfile": { - "type": "object", - "description": "Kafka cluster profile.", - "additionalProperties": true - }, - "trinoProfile": { - "$ref": "#/definitions/TrinoProfile" - }, - "llapProfile": { - "type": "object", - "description": "LLAP cluster profile.", - "additionalProperties": true - }, - "flinkProfile": { - "$ref": "#/definitions/FlinkProfile" - }, - "sparkProfile": { - "$ref": "#/definitions/SparkProfile" - }, - "stubProfile": { - "type": "object", - "description": "Stub cluster profile.", - "additionalProperties": true - }, - "scriptActionProfiles": { - "$ref": "#/definitions/ScriptActionProfiles" - } - }, - "description": "Cluster profile." - }, - "SshProfile": { - "type": "object", - "description": "Ssh profile for the cluster.", - "required": [ - "count" - ], - "properties": { - "count": { - "type": "integer", - "description": "Number of ssh pods per cluster.", - "format": "int32", - "maximum": 5.0, - "minimum": 0.0 - }, - "podPrefix": { - "type": "string", - "description": "Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //-", - "readOnly": true - } - } - }, - "AutoscaleProfile": { - "type": "object", - "description": "This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "This indicates whether auto scale is enabled on HDInsight on AKS cluster." - }, - "gracefulDecommissionTimeout": { - "type": "integer", - "format": "int32", - "description": "This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout." - }, - "autoscaleType": { - "type": "string", - "description": "User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based.", - "enum": [ - "ScheduleBased", - "LoadBased" - ], - "x-ms-enum": { - "name": "AutoscaleType", - "modelAsString": true - } - }, - "scheduleBasedConfig": { - "description": "Profiles of schedule based Autoscale.", - "$ref": "#/definitions/ScheduleBasedConfig" - }, - "loadBasedConfig": { - "description": "Profiles of load based Autoscale.", - "$ref": "#/definitions/LoadBasedConfig" - } - } - }, - "ScheduleBasedConfig": { - "type": "object", - "description": "Profile of schedule based Autoscale.", - "required": [ - "timeZone", - "defaultCount", - "schedules" - ], - "properties": { - "timeZone": { - "type": "string", - "description": "User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration." - }, - "defaultCount": { - "type": "integer", - "format": "int32", - "description": "Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down)" - }, - "schedules": { - "type": "array", - "description": "This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end).", - "items": { - "$ref": "#/definitions/Schedule" - }, - "x-ms-identifiers": [] - } - } - }, - "Schedule": { - "type": "object", - "description": "Schedule definition.", - "required": [ - "days", - "startTime", - "endTime", - "count" - ], - "properties": { - "startTime": { - "type": "string", - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "description": "User has to set the start time of current schedule configuration, format like 10:30 (HH:MM)." - }, - "endTime": { - "type": "string", - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "description": "User has to set the end time of current schedule configuration, format like 10:30 (HH:MM)." - }, - "count": { - "type": "integer", - "format": "int32", - "description": "User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer." - }, - "days": { - "type": "array", - "description": "User has to set the days where schedule has to be set for autoscale operation.", - "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "ScheduleDay", - "modelAsString": true - } - } - } - } - }, - "LoadBasedConfig": { - "type": "object", - "description": "Profile of load based Autoscale.", - "required": [ - "minNodes", - "maxNodes", - "scalingRules" - ], - "properties": { - "minNodes": { - "type": "integer", - "format": "int32", - "description": "User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." - }, - "maxNodes": { - "type": "integer", - "format": "int32", - "description": "User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." - }, - "pollInterval": { - "type": "integer", - "format": "int32", - "description": "User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation." - }, - "cooldownPeriod": { - "type": "integer", - "format": "int32", - "description": "This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds." - }, - "scalingRules": { - "type": "array", - "description": "The scaling rules.", - "items": { - "$ref": "#/definitions/ScalingRule" - }, - "x-ms-identifiers": [] - } - } - }, - "ScalingRule": { - "type": "object", - "description": "The scaling rule.", - "required": [ - "actionType", - "comparisonRule", - "evaluationCount", - "scalingMetric" - ], - "properties": { - "actionType": { - "type": "string", - "description": "The action type.", - "enum": [ - "scaleup", - "scaledown" - ], - "x-ms-enum": { - "name": "ScaleActionType", - "modelAsString": true - } - }, - "evaluationCount": { - "type": "integer", - "format": "int32", - "description": "This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered." - }, - "scalingMetric": { - "type": "string", - "description": "Metrics name for individual workloads. For example: cpu" - }, - "comparisonRule": { - "$ref": "#/definitions/ComparisonRule" - } - } - }, - "ComparisonRule": { - "type": "object", - "description": "The comparison rule.", - "required": [ - "operator", - "threshold" - ], - "properties": { - "operator": { - "type": "string", - "description": "The comparison operator.", - "enum": [ - "greaterThan", - "greaterThanOrEqual", - "lessThan", - "lessThanOrEqual" - ], - "x-ms-enum": { - "name": "ComparisonOperator", - "modelAsString": true - } - }, - "threshold": { - "type": "number", - "description": "Threshold setting." - } - } - }, - "TrinoProfile": { - "type": "object", - "description": "Trino Cluster profile.", - "properties": { - "catalogOptions": { - "$ref": "#/definitions/CatalogOptions" - }, - "coordinator": { - "$ref": "#/definitions/TrinoCoordinator" - }, - "userPluginsSpec": { - "$ref": "#/definitions/TrinoUserPlugins" - }, - "userTelemetrySpec": { - "$ref": "#/definitions/TrinoUserTelemetry" - }, - "worker": { - "$ref": "#/definitions/TrinoWorker" - } - } - }, - "CatalogOptions": { - "type": "object", - "description": "Trino cluster catalog options.", - "properties": { - "hive": { - "type": "array", - "description": "hive catalog options.", - "items": { - "$ref": "#/definitions/HiveCatalogOption" - }, - "x-ms-identifiers": [] - } - } - }, - "HiveCatalogOption": { - "type": "object", - "description": "Hive Catalog Option", - "required": [ - "catalogName", - "metastoreDbConnectionURL", - "metastoreDbConnectionUserName", - "metastoreDbConnectionPasswordSecret", - "metastoreWarehouseDir" - ], - "properties": { - "catalogName": { - "description": "Name of trino catalog which should use specified hive metastore.", - "minLength": 1, - "type": "string" - }, - "metastoreDbConnectionPasswordSecret": { - "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", - "type": "string" - }, - "metastoreDbConnectionURL": { - "description": "Connection string for hive metastore database.", - "type": "string" - }, - "metastoreDbConnectionUserName": { - "description": "User name for database connection.", - "type": "string" - }, - "metastoreWarehouseDir": { - "description": "Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri", - "type": "string" - } - } - }, - "FlinkCatalogOptions": { - "type": "object", - "description": "Flink cluster catalog options.", - "properties": { - "hive": { - "$ref": "#/definitions/FlinkHiveCatalogOption" - } - } - }, - "FlinkHiveCatalogOption": { - "type": "object", - "description": "Hive Catalog Option for Flink cluster.", - "required": [ - "metastoreDbConnectionURL", - "metastoreDbConnectionUserName", - "metastoreDbConnectionPasswordSecret" - ], - "properties": { - "metastoreDbConnectionPasswordSecret": { - "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", - "type": "string" - }, - "metastoreDbConnectionURL": { - "description": "Connection string for hive metastore database.", - "type": "string" - }, - "metastoreDbConnectionUserName": { - "description": "User name for database connection.", - "type": "string" - } - } - }, - "TrinoCoordinator": { - "type": "object", - "description": "Trino Coordinator.", - "properties": { - "debug": { - "$ref": "#/definitions/TrinoDebugConfig", - "x-ms-client-flatten": true - }, - "highAvailabilityEnabled": { - "type": "boolean", - "description": "The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.", - "default": true - } - } - }, - "TrinoWorker": { - "type": "object", - "description": "Trino worker.", - "properties": { - "debug": { - "$ref": "#/definitions/TrinoDebugConfig", - "x-ms-client-flatten": true - } - } - }, - "TrinoDebugConfig": { - "type": "object", - "description": "Trino debug configuration.", - "properties": { - "enable": { - "type": "boolean", - "description": "The flag that if enable debug or not.", - "default": false - }, - "port": { - "type": "integer", - "format": "int32", - "description": "The debug port.", - "default": 8008 - }, - "suspend": { - "type": "boolean", - "description": "The flag that if suspend debug or not.", - "default": false - } - } - }, - "TrinoUserTelemetry": { - "type": "object", - "description": "User telemetry", - "properties": { - "storage": { - "$ref": "#/definitions/TrinoTelemetryConfig" - } - } - }, - "TrinoTelemetryConfig": { - "type": "object", - "description": "Trino user telemetry definition.", - "properties": { - "hivecatalogName": { - "type": "string", - "description": "Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created.", - "minLength": 1 - }, - "hivecatalogSchema": { - "type": "string", - "description": "Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs.", - "default": "trinologs" - }, - "partitionRetentionInDays": { - "type": "integer", - "description": "Retention period for query log table partitions, this doesn't have any affect on actual data.", - "format": "int32", - "default": 365 - }, - "path": { - "type": "string", - "description": "Azure storage location of the blobs.", - "minLength": 1 - } - } - }, - "TrinoUserPlugins": { - "type": "object", - "description": "Trino user plugins spec", - "properties": { - "plugins": { - "type": "array", - "description": "Trino user plugins.", - "items": { - "$ref": "#/definitions/TrinoUserPlugin" - }, - "x-ms-identifiers": [] - } - } - }, - "TrinoUserPlugin": { - "type": "object", - "description": "Trino user plugin.", - "properties": { - "enabled": { - "type": "boolean", - "description": "Denotes whether the plugin is active or not." - }, - "name": { - "type": "string", - "description": "This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path.", - "minLength": 1 - }, - "path": { - "type": "string", - "description": "Fully qualified path to the folder containing the plugins.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$" - } - } - }, - "SparkProfile": { - "type": "object", - "description": "The spark cluster profile.", - "properties": { - "defaultStorageUrl": { - "type": "string", - "description": "The default storage URL." - }, - "metastoreSpec": { - "$ref": "#/definitions/SparkMetastoreSpec" - }, - "userPluginsSpec": { - "$ref": "#/definitions/SparkUserPlugins" - } - } - }, - "SparkUserPlugins": { - "type": "object", - "description": "Spark user plugins spec", - "properties": { - "plugins": { - "type": "array", - "description": "Spark user plugins.", - "items": { - "$ref": "#/definitions/SparkUserPlugin" - }, - "x-ms-identifiers": [] - } - } - }, - "SparkUserPlugin": { - "type": "object", - "description": "Spark user plugin.", - "required": [ - "path" - ], - "properties": { - "path": { - "type": "string", - "description": "Fully qualified path to the folder containing the plugins.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$" - } - } - }, - "ScriptActionProfiles": { - "type": "array", - "description": "The script action profile list.", - "items": { - "$ref": "#/definitions/ScriptActionProfile" - }, - "x-ms-identifiers": [] - }, - "ScriptActionProfile": { - "type": "object", - "description": "The script action profile.", - "required": [ - "name", - "type", - "url", - "services" - ], - "properties": { - "type": { - "type": "string", - "description": "Type of the script action. Supported type is bash scripts." - }, - "name": { - "type": "string", - "description": "Script name." - }, - "url": { - "type": "string", - "description": "Url of the script file.", - "pattern": "^(https)|(http)|(abfss)|(abfs)|(wasbs)|(wasb)://.*$" - }, - "parameters": { - "type": "string", - "description": "Additional parameters for the script action. It should be space-separated list of arguments required for script execution." - }, - "services": { - "items": { - "type": "string" - }, - "type": "array", - "description": "List of services to apply the script action." - }, - "timeoutInMinutes": { - "type": "integer", - "format": "int32", - "description": "Timeout duration for the script action in minutes." - }, - "shouldPersist": { - "type": "boolean", - "default": true, - "description": "Specify if the script should persist on the cluster." - } - } - }, - "SparkMetastoreSpec": { - "type": "object", - "description": "The metastore specification for Spark cluster.", - "required": [ - "dbServerHost", - "dbName", - "dbUserName", - "dbPasswordSecretName", - "keyVaultId" - ], - "properties": { - "dbServerHost": { - "type": "string", - "description": "The database server host." - }, - "dbName": { - "type": "string", - "description": "The database name." - }, - "dbUserName": { - "type": "string", - "description": "The database user name." - }, - "dbPasswordSecretName": { - "type": "string", - "description": "The secret name which contains the database user password." - }, - "keyVaultId": { - "type": "string", - "description": "The key vault resource id." - }, - "thriftUrl": { - "type": "string", - "description": "The thrift url." - } - } - }, - "FlinkProfile": { - "type": "object", - "description": "The Flink cluster profile.", - "required": [ - "storage", - "jobManager", - "taskManager" - ], - "properties": { - "storage": { - "$ref": "#/definitions/FlinkStorageProfile" - }, - "numReplicas": { - "type": "integer", - "format": "int32", - "description": "The number of task managers." - }, - "jobManager": { - "description": "Job Manager container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "historyServer": { - "description": "History Server container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "taskManager": { - "description": "Task Manager container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "catalogOptions": { - "$ref": "#/definitions/FlinkCatalogOptions" - } - } - }, - "FlinkStorageProfile": { - "type": "object", - "description": "The storage profile", - "required": [ - "storageUri" - ], - "properties": { - "storageUri": { - "type": "string", - "pattern": "^(\\w{4,5})://(.*)@(.*).\\b(blob|dfs)\\b\\.core\\.windows\\.net$", - "description": "Storage account uri which is used for savepoint and checkpoint state." - }, - "storagekey": { - "type": "string", - "description": "Storage key is only required for wasb(s) storage.", - "x-ms-secret": true - } - } - }, - "ComputeResourceDefinition": { - "type": "object", - "description": "The cpu and memory requirement definition.", - "required": [ - "cpu", - "memory" - ], - "properties": { - "cpu": { - "type": "number", - "format": "float", - "description": "The required CPU." - }, - "memory": { - "type": "integer", - "format": "int64", - "description": "The required memory in MB, Container memory will be 110 percentile" - } - } - }, - "ClusterResourceProperties": { - "type": "object", - "required": [ - "clusterType", - "computeProfile", - "clusterProfile" - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "type": "string", - "enum": [ - "Accepted", - "Succeeded", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "readOnly": true - }, - "clusterType": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The type of cluster.", - "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" - }, - "deploymentId": { - "type": "string", - "description": "A unique id generated by the RP to identify the resource.", - "example": "45cd32aead6e4a91b079a0cdbfac8c36", - "readOnly": true - }, - "computeProfile": { - "description": "The compute profile.", - "$ref": "#/definitions/ComputeProfile" - }, - "clusterProfile": { - "$ref": "#/definitions/ClusterProfile" - }, - "status": { - "type": "string", - "description": "Business status of the resource.", - "example": "Running", - "readOnly": true - } - }, - "description": "Cluster resource properties." - }, - "ComputeProfile": { - "type": "object", - "description": "The compute profile.", - "required": [ - "nodes" - ], - "properties": { - "nodes": { - "type": "array", - "description": "The nodes definitions.", - "items": { - "$ref": "#/definitions/NodeProfile" - }, - "x-ms-identifiers": [] - } - } - }, - "NodeProfile": { - "type": "object", - "description": "The node profile.", - "required": [ - "type", - "vmSize", - "count" - ], - "properties": { - "type": { - "type": "string", - "description": "The node type.", - "pattern": "^(head|Head|HEAD|worker|Worker|WORKER)$" - }, - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - }, - "count": { - "description": "The number of virtual machines.", - "type": "integer", - "format": "int32", - "minimum": 1.0 - } - } - }, - "Cluster": { - "type": "object", - "description": "The cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster specific properties.", - "$ref": "#/definitions/ClusterResourceProperties" - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "SystemData of cluster.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterPatch": { - "type": "object", - "description": "The patch for a cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Define cluster patch specific properties.", - "$ref": "#/definitions/ClusterPatchProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterPatchProperties": { - "type": "object", - "description": "Cluster resource patch data.", - "properties": { - "clusterProfile": { - "$ref": "#/definitions/UpdatableClusterProfile" - } - } - }, - "UpdatableClusterProfile": { - "type": "object", - "properties": { - "serviceConfigsProfiles": { - "type": "array", - "description": "The service configs profiles.", - "items": { - "$ref": "#/definitions/ClusterServiceConfigsProfile" - }, - "x-ms-identifiers": [] - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile" - }, - "autoscaleProfile": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "authorizationProfile": { - "$ref": "#/definitions/AuthorizationProfile" - }, - "logAnalyticsProfile": { - "$ref": "#/definitions/ClusterLogAnalyticsProfile" - }, - "prometheusProfile": { - "$ref": "#/definitions/ClusterPrometheusProfile" - }, - "scriptActionProfiles": { - "$ref": "#/definitions/ScriptActionProfiles" - } - }, - "description": "Cluster resource patch properties." - }, - "ClusterResizeData": { - "type": "object", - "description": "The parameters for resizing a cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Sets the properties. Define cluster resize specific properties.", - "$ref": "#/definitions/ClusterResizeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterResizeProperties": { - "type": "object", - "description": "The properties for resizing a cluster.", - "required": [ - "targetWorkerNodeCount" - ], - "properties": { - "targetWorkerNodeCount": { - "type": "integer", - "format": "int32", - "description": "Target node count of worker node." - } - } - }, - "ServiceConfigListResult": { - "type": "object", - "description": "Cluster instance service configs api response.", - "properties": { - "value": { - "type": "array", - "description": "Cluster instance service config array.", - "items": { - "$ref": "#/definitions/ServiceConfigResult" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ServiceConfigResult": { - "type": "object", - "description": "Cluster instance service config.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster instance service config properties.", - "allOf": [ - { - "$ref": "#/definitions/ServiceConfigListResultProperties" - } - ] - } - } - }, - "ServiceConfigListResultProperties": { - "type": "object", - "properties": { - "serviceName": { - "type": "string", - "description": "Service Config Name." - }, - "fileName": { - "type": "string", - "description": "File Name." - }, - "content": { - "type": "string", - "description": "Content in the service config file." - }, - "componentName": { - "type": "string", - "description": "Component Name." - }, - "type": { - "type": "string", - "description": "Config type." - }, - "path": { - "type": "string", - "description": "Config file path." - }, - "customKeys": { - "type": "object", - "description": "The custom keys.", - "additionalProperties": { - "type": "string" - } - }, - "defaultKeys": { - "type": "object", - "description": "The default keys.", - "additionalProperties": { - "$ref": "#/definitions/ServiceConfigListResultValueEntity" - } - } - }, - "required": [ - "serviceName", - "componentName", - "fileName" - ], - "description": "Service config response." - }, - "ServiceConfigListResultValueEntity": { - "type": "object", - "description": "Default config details.", - "properties": { - "value": { - "type": "string", - "description": "Config value." - }, - "description": { - "type": "string", - "description": "Config description." - } - }, - "required": [ - "value" - ] - }, - "ClusterInstanceViewsResult": { - "type": "object", - "properties": { - "value": { - "items": { - "$ref": "#/definitions/ClusterInstanceViewResult" - }, - "type": "array", - "description": "Cluster instance view array.", - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - }, - "description": "The instance view of a HDInsight Cluster." - }, - "ClusterInstanceViewResult": { - "type": "object", - "description": "Cluster Instance View.", - "required": [ - "name", - "properties" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the instance view." - }, - "properties": { - "description": "Properties of the instance view.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ClusterInstanceViewProperties" - } - ] - } - } - }, - "ClusterInstanceViewProperties": { - "type": "object", - "description": "Cluster Instance View Properties.", - "required": [ - "status", - "serviceStatuses" - ], - "properties": { - "status": { - "description": "Status of the instance view.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInstanceViewStatus" - } - ] - }, - "serviceStatuses": { - "type": "array", - "description": "List of statuses of relevant services that make up the HDInsight on aks cluster to surface to the customer.", - "items": { - "$ref": "#/definitions/ServiceStatus" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterInstanceViewStatus": { - "type": "object", - "description": "Status of the instance view.", - "required": [ - "ready" - ], - "properties": { - "ready": { - "type": "string", - "description": "The cluster ready status" - }, - "reason": { - "type": "string", - "description": "The status reason." - }, - "message": { - "type": "string", - "description": "The additional message." - } - } - }, - "ServiceStatus": { - "type": "object", - "description": "Describes the status of a service of a HDInsight on aks cluster.", - "required": [ - "kind", - "ready" - ], - "properties": { - "kind": { - "type": "string", - "description": "Kind of the service. E.g. \"Zookeeper\"." - }, - "ready": { - "type": "string", - "description": "Indicates if the service is ready / healthy. Values can be \"true\", \"false\", \"unknown\" or anything else." - }, - "message": { - "type": "string", - "description": "A message describing the error if any." - } - } - }, - "NameAvailabilityParameters": { - "description": "Details of check name availability request body.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name for checking availability." - }, - "type": { - "type": "string", - "description": "The resource type in Microsoft.HDInsight." - } - } - }, - "NameAvailabilityResult": { - "description": "Result of check name availability.", - "type": "object", - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Indicator of availability of the Microsoft.HDInsight resource name." - }, - "reason": { - "type": "string", - "description": "The reason of unavailability." - }, - "message": { - "type": "string", - "description": "The error message of unavailability." - } - } - }, - "ClusterPoolVersionPattern": { - "type": "string", - "description": "Cluster pool version is a 2-part version.", - "example": "1.2", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" - }, - "ClusterPoolVersionsListResult": { - "type": "object", - "description": "Represents a list of cluster pool versions.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster pool versions.", - "items": { - "$ref": "#/definitions/ClusterPoolVersion" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterPoolVersion": { - "type": "object", - "description": "Available cluster pool version.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster pool version properties.", - "$ref": "#/definitions/ClusterPoolVersionProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterPoolVersionProperties": { - "type": "object", - "description": "Cluster pool version properties.", - "properties": { - "clusterPoolVersion": { - "$ref": "#/definitions/ClusterPoolVersionPattern" - }, - "aksVersion": { - "type": "string", - "description": "AKS version.", - "example": "1.24" - }, - "isPreview": { - "type": "boolean", - "description": "Indicate if this version is in preview or not.", - "default": false - } - } - }, - "ThreePartVersionPattern": { - "type": "string", - "description": "Version with three part.", - "example": "1.0.4", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" - }, - "ThreeOrFourPartVersionPattern": { - "type": "string", - "description": "Version with 3/4 part.", - "example": "1.0.4", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})(?:\\.(0|[1-9][0-9]{0,18}))?$" - }, - "ClusterVersionsListResult": { - "type": "object", - "description": "Represents a list of cluster versions.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster versions.", - "items": { - "$ref": "#/definitions/ClusterVersion" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterVersion": { - "type": "object", - "description": "Available cluster version.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster version properties.", - "$ref": "#/definitions/ClusterVersionProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterVersionProperties": { - "type": "object", - "description": "Cluster version properties.", - "properties": { - "clusterType": { - "type": "string", - "description": "The type of cluster.", - "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" - }, - "clusterVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "ossVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "clusterPoolVersion": { - "type": "string", - "description": "The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string", - "example": "1.0" - }, - "isPreview": { - "type": "boolean", - "description": "Indicate if this version is in preview or not.", - "default": false - }, - "components": { - "$ref": "#/definitions/ClusterComponents" - } - } - }, - "ClusterComponents": { - "type": "array", - "description": "Component list of this cluster type and version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "x-ms-identifiers": [], - "example": [ - { - "name": "HDFS", - "version": "1.2.3" - }, - { - "name": "HIVE", - "version": "1.2.3" - } - ] - }, - "ClusterJobList": { - "description": "Collection of cluster job.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of cluster job.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterJob" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - } - } - }, - "ClusterJob": { - "description": "Cluster job.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterJobProperties" - } - } - }, - "ClusterJobProperties": { - "description": "Properties of cluster job.", - "type": "object", - "properties": { - "jobType": { - "description": "Type of cluster job.", - "enum": [ - "FlinkJob" - ], - "type": "string", - "x-ms-enum": { - "name": "jobType", - "modelAsString": true - } - } - }, - "discriminator": "jobType", - "required": [ - "jobType" - ] - }, - "FlinkJobProperties": { - "description": "Properties of flink job.", - "type": "object", - "required": [ - "jobName" - ], - "allOf": [ - { - "$ref": "#/definitions/ClusterJobProperties" - } - ], - "properties": { - "jobName": { - "description": "Name of job", - "type": "string" - }, - "jobJarDirectory": { - "description": "A string property that specifies the directory where the job JAR is located.", - "type": "string" - }, - "jarName": { - "description": "A string property that represents the name of the job JAR.", - "type": "string" - }, - "entryClass": { - "description": "A string property that specifies the entry class for the Flink job.", - "type": "string" - }, - "args": { - "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", - "type": "string" - }, - "savePointName": { - "description": "A string property that represents the name of the savepoint for the Flink job", - "type": "string" - }, - "action": { - "description": "A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE.", - "type": "string", - "enum": [ - "NEW", - "UPDATE", - "STATELESS_UPDATE", - "STOP", - "START", - "CANCEL", - "SAVEPOINT", - "LIST_SAVEPOINT", - "DELETE" - ], - "x-ms-enum": { - "name": "action", - "modelAsString": true - } - }, - "flinkConfiguration": { - "description": "Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "jobId": { - "description": "Unique id for identifying a job", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of job.", - "type": "string", - "readOnly": true - }, - "jobOutput": { - "description": "Output of job.", - "type": "string", - "readOnly": true - }, - "actionResult": { - "description": "Action result of job.", - "type": "string", - "readOnly": true - }, - "lastSavePoint": { - "description": "The last savepoint.", - "type": "string", - "readOnly": true - } - }, - "x-ms-discriminator-value": "FlinkJob" - } - }, - "parameters": { - "ClusterPoolNameParameter": { - "name": "clusterPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster pool.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the HDInsight cluster.", - "x-ms-parameter-location": "method" - }, - "ClusterTypeNameParameter": { - "name": "clusterTypeName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the HDInsight on aks cluster type.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json deleted file mode 100644 index bda5723d3d02..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateAutoscaleCluster.json +++ /dev/null @@ -1,354 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "Trino", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2 - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "Trino", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json deleted file mode 100644 index 6b62459601aa..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPool.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json deleted file mode 100644 index f8e004e9bfb5..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithPrivateAks.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "enablePrivateApiServer": true - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "enablePrivateApiServer": true - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "enablePrivateApiServer": true - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json deleted file mode 100644 index 6379c0cd473b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateClusterPoolWithUDRAks.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "outboundType": "userDefinedRouting" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "outboundType": "userDefinedRouting" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "outboundType": "userDefinedRouting" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json deleted file mode 100644 index 46cba6645d3f..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateRangerCluster.json +++ /dev/null @@ -1,239 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "ranger", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "ranger", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "ranger", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json deleted file mode 100644 index 9ec97e0386cb..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkCluster.json +++ /dev/null @@ -1,314 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "sparkProfile": {}, - "sshProfile": { - "count": 2 - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "spark", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json deleted file mode 100644 index dc440404470c..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/CreateSparkClusterWithInternalIngress.json +++ /dev/null @@ -1,331 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "sparkProfile": {}, - "sshProfile": { - "count": 2 - }, - "clusterAccessProfile": { - "enableInternalIngress": true - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "spark", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net", - "privateFqdn": "cluster1-int.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "clusterAccessProfile": { - "enableInternalIngress": true, - "privateLinkServiceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/privateLinkServices/testpls" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net", - "privateFqdn": "cluster1-int.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "clusterAccessProfile": { - "enableInternalIngress": true, - "privateLinkServiceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/privateLinkServices/testpls" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json deleted file mode 100644 index dc34dd121621..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteCluster.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "rg1", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": {}, - "202": { - "description": "Cluster delete request accepted.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json deleted file mode 100644 index 226d182b098e..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/DeleteClusterPool.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "rg1", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": {}, - "202": { - "description": "Cluster Pool delete request accepted.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json deleted file mode 100644 index ef3dd6469186..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetCluster.json +++ /dev/null @@ -1,89 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json deleted file mode 100644 index 5e9a1173929b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterInstanceView.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2023-11-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "name": "default", - "properties": { - "status": { - "ready": "True", - "reason": "", - "message": "" - }, - "serviceStatuses": [ - { - "kind": "ZooKeeper", - "ready": "true", - "message": "" - } - ] - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json deleted file mode 100644 index b8b6b322e021..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetClusterPool.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json deleted file mode 100644 index 475a285c9d0c..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/GetOperations.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "resourceGroup1", - "api-version": "2023-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.HDInsight/clusterpool/read", - "isDataAction": false, - "display": { - "provider": "HDInsight on AKS", - "resource": "Cluster Pool.", - "operation": "Get Cluster Pool Operation result.", - "description": "Get any cluster pool." - }, - "origin": "user, system" - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json deleted file mode 100644 index 70e74845dc0a..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterPoolVersions.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "location": "westus2", - "api-version": "2023-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.0", - "name": "1.0", - "properties": { - "clusterPoolVersion": "1.0", - "aksVersion": "1.24", - "isPreview": false - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.1", - "name": "1.1", - "properties": { - "clusterPoolVersion": "1.1", - "aksVersion": "1.25", - "isPreview": false - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.2", - "name": "1.2", - "properties": { - "clusterPoolVersion": "1.2", - "aksVersion": "1.26", - "isPreview": true - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json deleted file mode 100644 index 8237b497a231..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListAvailableClusterVersions.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "location": "westus2", - "api-version": "2023-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/flink_1.16.0-1.0.4", - "name": "flink_1.16.0-1.0.4", - "properties": { - "clusterType": "Flink", - "clusterVersion": "1.0.4", - "ossVersion": "1.16.0", - "clusterPoolVersion": "1.0", - "isPreview": false, - "components": [ - { - "name": "TaskManager", - "version": "1.16.0" - }, - { - "name": "JobManager", - "version": "1.16.0" - } - ] - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/spark_3.3.1-1.0.4", - "name": "spark_3.3.1-1.0.4", - "properties": { - "clusterType": "Spark", - "clusterVersion": "1.0.4", - "ossVersion": "3.3.1", - "clusterPoolVersion": "1.0", - "isPreview": false, - "components": [ - { - "name": "Hadoop", - "version": "3.2.3" - }, - { - "name": "Hive", - "version": "3.1.4" - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json deleted file mode 100644 index 491729ce24af..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterAvailableUpgrades.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/availableUpgrades/AKSPatchUpgrade", - "properties": { - "upgradeType": "AKSPatchUpgrade", - "currentVersion": "1.26.3", - "currentVersionStatus": "Supported", - "latestVersion": "1.26.6" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/availableUpgrades/hotfix1", - "properties": { - "description": "Hotfix for historyserver on version 1.16.0-1.0.6.2", - "sourceClusterVersion": "1.0.6", - "sourceOssVersion": "1.16.0", - "sourceBuildNumber": "2", - "targetClusterVersion": "1.0.6", - "targetOssVersion": "1.16.0", - "targetBuildNumber": "3", - "componentName": "historyserver", - "severity": "low", - "upgradeType": "HotfixUpgrade", - "extendedProperties": "", - "createdTime": "2023-03-29T14:13:12Z" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json deleted file mode 100644 index 34b3d4641df7..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterInstanceViews.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2023-11-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "default", - "properties": { - "status": { - "ready": "True", - "reason": "", - "message": "" - }, - "serviceStatuses": [ - { - "kind": "ZooKeeper", - "ready": "true", - "message": "" - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json deleted file mode 100644 index 4658834c76f2..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterJobs.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourcegroup", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterPool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/jobs/flink-job-1", - "properties": { - "runId": "job-15a-4322-b32c-ea541845e911", - "jobType": "FlinkJob", - "jobName": "flink-job-1", - "jobJarDirectory": "jobJarDirectory1", - "jarName": "job.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.ExampleJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "savepoint-directory" - }, - "jobId": "362b911137dfefc2e55784666f4d4253", - "status": "RUNNING", - "jobOutput": "job-output", - "actionResult": "SUCCESS" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json deleted file mode 100644 index e946df8f116a..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolAvailableUpgrades.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/availableUpgrades/AKSPatchUpgrade", - "properties": { - "upgradeType": "AKSPatchUpgrade", - "currentVersion": "1.26.3", - "currentVersionStatus": "Deprecated", - "latestVersion": "1.26.6" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/availableUpgrades/NodeOsUpgrade", - "properties": { - "upgradeType": "NodeOsUpgrade", - "latestVersion": "AKSCBLMariner-V2gen2-202310.09.0" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json deleted file mode 100644 index 0bfda02428f5..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPools.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourcegroup", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json deleted file mode 100644 index 59447e08b209..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterPoolsSubscription.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json deleted file mode 100644 index c8c2b61ba39a..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClusterServiceConfigs.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2023-11-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "serviceName": "hadoop-service", - "componentName": "hadoop-component", - "fileName": "capacity-scheduler.xml", - "content": "" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json deleted file mode 100644 index 5f3cd6f733db..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ListClustersByClusterPoolName.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json deleted file mode 100644 index 2a2c69d2b1ba..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/LocationsNameAvailability.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2023-11-01-preview", - "location": "southeastasia", - "NameAvailabilityParameters": { - "name": "contosemember1", - "type": "Microsoft.HDInsight/clusterPools/clusters" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "nameAvailable": false, - "reason": "AlreadyExists" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json deleted file mode 100644 index 1a19d9b98aa4..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchCluster.json +++ /dev/null @@ -1,455 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterPatchRequest": { - "properties": { - "clusterProfile": { - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "sshProfile": { - "count": 2 - }, - "authorizationProfile": { - "userIds": [ - "Testuser1", - "Testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2023-11-01-preview" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json deleted file mode 100644 index 2b2de7073b70..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchClusterPool.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterPoolTags": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json deleted file mode 100644 index e9eb705b75cf..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/PatchRangerCluster.json +++ /dev/null @@ -1,231 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterPatchRequest": { - "properties": { - "clusterProfile": { - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "ranger", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2023-11-01-preview" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "ranger", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json deleted file mode 100644 index 0dc302d60775..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/ResizeCluster.json +++ /dev/null @@ -1,143 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterResizeRequest": { - "location": "West US 2", - "properties": { - "targetWorkerNodeCount": 5 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 5 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2023-11-01-preview" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json deleted file mode 100644 index 8691574838dd..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/RunClusterJob.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterJob": { - "properties": { - "jobType": "FlinkJob", - "jobName": "flink-job-name", - "action": "START", - "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", - "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" - } - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "properties": { - "runId": "job-15a-4322-b32c-ea541845e911", - "jobType": "FlinkJob", - "jobName": "flink-job-name", - "action": "START", - "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", - "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" - } - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json deleted file mode 100644 index 9661f5aeae9a..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForCluster.json +++ /dev/null @@ -1,137 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterUpgradeRequest": { - "properties": { - "upgradeType": "AKSPatchUpgrade" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json deleted file mode 100644 index a3c8bb60aca2..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPoolUpgradeRequest": { - "properties": { - "upgradeType": "AKSPatchUpgrade", - "upgradeClusterPool": true, - "upgradeAllClusterNodes": false - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json deleted file mode 100644 index bfb7e74dabde..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeHotfixForCluster.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterUpgradeRequest": { - "properties": { - "upgradeType": "HotfixUpgrade", - "targetOssVersion": "1.16.0", - "targetClusterVersion": "1.0.6", - "targetBuildNumber": "3", - "componentName": "historyserver" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 3 - } - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json deleted file mode 100644 index 7dcdcb1ade3c..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/examples/UpgradeNodeOsForClusterPool.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2023-11-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPoolUpgradeRequest": { - "properties": { - "upgradeType": "NodeOsUpgrade" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json deleted file mode 100644 index 705aa0e3d015..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2023-11-01-preview/hdinsight.json +++ /dev/null @@ -1,4240 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsight on AKS Management Client", - "description": "The HDInsight on AKS Management Client.", - "version": "2023-11-01-preview" - }, - "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.HDInsight/clusterpools/{clusterPoolName}": { - "get": { - "description": "Gets a cluster pool.", - "operationId": "ClusterPools_Get", - "x-ms-examples": { - "ClusterPoolGet": { - "$ref": "./examples/GetClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusterpool details.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Creates or updates a cluster pool.", - "operationId": "ClusterPools_CreateOrUpdate", - "x-ms-examples": { - "ClusterPoolPut": { - "$ref": "./examples/CreateClusterPool.json" - }, - "ClusterPoolPutWithPrivateAks": { - "$ref": "./examples/CreateClusterPoolWithPrivateAks.json" - }, - "ClusterPoolPutWithUDRAks": { - "$ref": "./examples/CreateClusterPoolWithUDRAks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "ClusterPool", - "description": "The Cluster Pool to create.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPool" - } - } - ], - "responses": { - "201": { - "description": "ClusterPool is created.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "200": { - "description": "Update successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing Cluster Pool Tags.", - "operationId": "ClusterPools_UpdateTags", - "x-ms-examples": { - "ClusterPoolsPatchTags": { - "$ref": "./examples/PatchClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "clusterPoolTags", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TagsObject" - }, - "description": "Parameters supplied to update tags." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "description": "Deletes a Cluster Pool.", - "operationId": "ClusterPools_Delete", - "x-ms-examples": { - "ClusterPoolDelete": { - "$ref": "./examples/DeleteClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Accepted response definition.", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No content - The Cluster Pool doesn't exist." - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusterpools": { - "get": { - "operationId": "ClusterPools_ListBySubscription", - "x-ms-examples": { - "ClusterPoolsListBySubscription": { - "$ref": "./examples/ListClusterPoolsSubscription.json" - } - }, - "description": "Gets the list of Cluster Pools within a Subscription.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Pools successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools": { - "get": { - "operationId": "ClusterPools_ListByResourceGroup", - "x-ms-examples": { - "ClusterPoolsListByResourceGroup": { - "$ref": "./examples/ListClusterPools.json" - } - }, - "description": "Lists the HDInsight cluster pools under a resource group.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Pools successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/upgrade": { - "post": { - "description": "Upgrade a cluster pool.", - "operationId": "ClusterPools_Upgrade", - "x-ms-examples": { - "ClusterPoolsUpgradeAKSPatchVersion": { - "$ref": "./examples/UpgradeAKSPatchVersionForClusterPool.json" - }, - "ClusterPoolsUpgradeNodeOs": { - "$ref": "./examples/UpgradeNodeOsForClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "ClusterPoolUpgradeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPoolUpgrade" - }, - "description": "Upgrade a cluster pool." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "202": { - "description": "Cluster Pool Upgrade request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/availableUpgrades": { - "get": { - "description": "List a cluster pool available upgrade.", - "operationId": "ClusterPoolAvailableUpgrades_List", - "x-ms-examples": { - "GetClusterPoolAvailableUpgrade": { - "$ref": "./examples/ListClusterPoolAvailableUpgrades.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusterpool Available Upgrade details.", - "schema": { - "$ref": "#/definitions/ClusterPoolAvailableUpgradeList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters": { - "get": { - "operationId": "Clusters_ListByClusterPoolName", - "description": "Lists the HDInsight cluster pools under a resource group.", - "x-ms-examples": { - "HDInsightClustersListByClusterPoolName": { - "$ref": "./examples/ListClustersByClusterPoolName.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusters successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/upgrade": { - "post": { - "description": "Upgrade a cluster.", - "operationId": "Clusters_Upgrade", - "x-ms-examples": { - "ClustersUpgradeAKSPatchVersion": { - "$ref": "./examples/UpgradeAKSPatchVersionForCluster.json" - }, - "ClustersUpgradeHotfix": { - "$ref": "./examples/UpgradeHotfixForCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterUpgradeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpgrade" - }, - "description": "Upgrade a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Cluster Upgrade request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/availableUpgrades": { - "get": { - "description": "List a cluster available upgrade.", - "operationId": "ClusterAvailableUpgrades_List", - "x-ms-examples": { - "GetClusterAvailableUpgrade": { - "$ref": "./examples/ListClusterAvailableUpgrades.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Available Upgrade details.", - "schema": { - "$ref": "#/definitions/ClusterAvailableUpgradeList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/resize": { - "post": { - "description": "Resize an existing Cluster.", - "operationId": "Clusters_Resize", - "x-ms-examples": { - "HDInsightClusterResize": { - "$ref": "./examples/ResizeCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterResizeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterResizeData" - }, - "description": "Resize a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Cluster resize request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}": { - "get": { - "operationId": "Clusters_Get", - "description": "Gets a HDInsight cluster.", - "x-ms-examples": { - "HDInsightClusterGet": { - "$ref": "./examples/GetCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Cluster details.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "operationId": "Clusters_Create", - "description": "Creates a cluster.", - "x-ms-examples": { - "HDInsightClusterPut": { - "$ref": "./examples/CreateAutoscaleCluster.json" - }, - "HDInsightSparkClusterPut": { - "$ref": "./examples/CreateSparkCluster.json" - }, - "HDInsightSparkClusterPutWithInternalIngress": { - "$ref": "./examples/CreateSparkClusterWithInternalIngress.json" - }, - "HDInsightRangerClusterPut": { - "$ref": "./examples/CreateRangerCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "HDInsightCluster", - "in": "body", - "required": true, - "description": "The cluster to create.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - ], - "responses": { - "201": { - "description": "Cluster is created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "200": { - "description": "Update successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing Cluster.", - "operationId": "Clusters_Update", - "x-ms-examples": { - "HDInsightClustersPatchTags": { - "$ref": "./examples/PatchCluster.json" - }, - "HDInsightRangerClusterPatchTags": { - "$ref": "./examples/PatchRangerCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterPatchRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPatch" - }, - "description": "Patch a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "operationId": "Clusters_Delete", - "description": "Deletes a cluster.", - "x-ms-examples": { - "HDInsightClustersDelete": { - "$ref": "./examples/DeleteCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Cluster delete request accepted.", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No content - The Cluster doesn't exist." - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/runJob": { - "post": { - "operationId": "ClusterJobs_RunJob", - "description": "Operations on jobs of HDInsight on AKS cluster.", - "x-ms-examples": { - "RunClusterJob": { - "$ref": "./examples/RunClusterJob.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterJob", - "description": "The Cluster job.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterJob" - } - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterJob" - } - }, - "202": { - "description": "Run cluster job action request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/jobs": { - "get": { - "operationId": "ClusterJobs_List", - "description": "Get jobs of HDInsight on AKS cluster.", - "x-ms-examples": { - "ListClusterJobs": { - "$ref": "./examples/ListClusterJobs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The system query option to filter job returned in the response. Allowed value is 'jobName eq {jobName}' or 'jarName eq {jarName}'." - } - ], - "responses": { - "200": { - "description": "Cluster job details.", - "schema": { - "$ref": "#/definitions/ClusterJobList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/serviceConfigs": { - "get": { - "operationId": "Clusters_ListServiceConfigs", - "description": "Lists the config dump of all services running in cluster.", - "x-ms-examples": { - "HDInsightClusterGetServiceConfigs": { - "$ref": "./examples/ListClusterServiceConfigs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceConfigListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability": { - "post": { - "description": "Check the availability of the resource name.", - "operationId": "Locations_CheckNameAvailability", - "x-ms-examples": { - "LocationsNameAvailability": { - "$ref": "./examples/LocationsNameAvailability.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "name": "NameAvailabilityParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - }, - "description": "The name and type of the resource." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/NameAvailabilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews": { - "get": { - "operationId": "Clusters_ListInstanceViews", - "x-ms-examples": { - "HDInsightClusterGetInstanceViews": { - "$ref": "./examples/ListClusterInstanceViews.json" - } - }, - "description": "Lists the lists of instance views", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClusterInstanceViewsResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews/default": { - "get": { - "operationId": "Clusters_GetInstanceView", - "description": "Gets the status of a cluster instance.", - "x-ms-examples": { - "HDInsightClusterGetInstanceView": { - "$ref": "./examples/GetClusterInstanceView.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClusterInstanceViewResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.HDInsight/operations": { - "get": { - "description": "Returns list of operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/GetOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation details.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterPoolVersions": { - "get": { - "description": "Returns a list of available cluster pool versions.", - "operationId": "AvailableClusterPoolVersions_ListByLocation", - "x-ms-examples": { - "ClusterPoolVersionListResult": { - "$ref": "./examples/ListAvailableClusterPoolVersions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster pool versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolVersionsListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterVersions": { - "get": { - "description": "Returns a list of available cluster versions.", - "operationId": "AvailableClusterVersions_ListByLocation", - "x-ms-examples": { - "ClusterVersionListResult": { - "$ref": "./examples/ListAvailableClusterVersions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterVersionsListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "ClusterPoolListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClusterPool" - }, - "description": "The list of cluster pools." - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - }, - "description": "The list cluster pools operation response." - }, - "ClusterPoolProfile": { - "type": "object", - "description": "Cluster pool profile.", - "required": [ - "clusterPoolVersion" - ], - "properties": { - "clusterPoolVersion": { - "$ref": "#/definitions/ClusterPoolVersionPattern" - } - } - }, - "ClusterPoolComputeProfile": { - "type": "object", - "description": "Cluster pool compute profile.", - "required": [ - "vmSize" - ], - "properties": { - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - }, - "count": { - "description": "The number of virtual machines.", - "type": "integer", - "format": "int32", - "readOnly": true - } - } - }, - "ClusterPoolNetworkProfile": { - "type": "object", - "description": "Cluster pool networking configuration.", - "required": [ - "subnetId" - ], - "properties": { - "subnetId": { - "type": "string", - "description": "Cluster pool subnet resource id.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.Network/virtualNetworks/subnets" - } - ] - } - }, - "outboundType": { - "type": "string", - "enum": [ - "loadBalancer", - "userDefinedRouting" - ], - "x-ms-enum": { - "name": "outboundType", - "modelAsString": true, - "values": [ - { - "value": "loadBalancer", - "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. " - }, - { - "value": "userDefinedRouting", - "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. " - } - ] - }, - "default": "loadBalancer", - "title": "The outbound (egress) routing method.", - "description": "This can only be set at cluster pool creation time and cannot be changed later. " - }, - "enablePrivateApiServer": { - "type": "boolean", - "description": "ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "apiServerAuthorizedIpRanges": { - "type": "array", - "items": { - "type": "string" - }, - "title": "The IP ranges authorized to access the AKS API server.", - "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don't use it." - } - } - }, - "ClusterPoolLogAnalyticsProfile": { - "type": "object", - "description": "Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "True if log analytics is enabled for cluster pool, otherwise false." - }, - "workspaceId": { - "type": "string", - "description": "Log analytics workspace to associate with the OMS agent.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.OperationalInsights/workspaces" - } - ] - } - } - } - }, - "AksClusterProfile": { - "type": "object", - "description": "Properties of the cluster pool underlying AKS cluster.", - "properties": { - "aksClusterResourceId": { - "type": "string", - "description": "ARM Resource ID of the AKS cluster", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ContainerService/managedClusters" - } - ] - } - }, - "aksClusterAgentPoolIdentityProfile": { - "description": "Identity properties of the AKS cluster agentpool MSI", - "allOf": [ - { - "$ref": "#/definitions/IdentityProfile" - } - ] - }, - "aksVersion": { - "type": "string", - "description": "AKS control plane and default node pool version of this ClusterPool", - "readOnly": true - } - } - }, - "ClusterPoolResourceProperties": { - "type": "object", - "required": [ - "computeProfile" - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "type": "string", - "enum": [ - "Accepted", - "Succeeded", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "readOnly": true - }, - "deploymentId": { - "type": "string", - "description": "A unique id generated by the RP to identify the resource.", - "example": "45cd32aead6e4a91b079a0cdbfac8c36", - "readOnly": true - }, - "managedResourceGroupName": { - "type": "string", - "description": "A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.", - "minLength": 1, - "maxLength": 40, - "example": "hdi-45cd32aead6e4a91b079a0cdbfac8c36" - }, - "aksManagedResourceGroupName": { - "type": "string", - "description": "A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}", - "readOnly": true, - "example": "MC_hdi-45cd32aead6e4a91b079a0cdbfac8c36_test-pool_eastus" - }, - "clusterPoolProfile": { - "description": "CLuster pool profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolProfile" - } - ] - }, - "computeProfile": { - "description": "CLuster pool compute profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolComputeProfile" - } - ] - }, - "aksClusterProfile": { - "description": "Properties of underlying AKS cluster.", - "readOnly": true, - "allOf": [ - { - "$ref": "#/definitions/AksClusterProfile" - } - ] - }, - "networkProfile": { - "description": "Cluster pool network profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolNetworkProfile" - } - ] - }, - "logAnalyticsProfile": { - "description": "Cluster pool log analytics profile to enable OMS agent for AKS cluster.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolLogAnalyticsProfile" - } - ] - }, - "status": { - "type": "string", - "description": "Business status of the resource.", - "example": "Running", - "readOnly": true - } - }, - "description": "Cluster pool resource properties." - }, - "ClusterPool": { - "type": "object", - "description": "Cluster pool.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster pool specific properties.", - "$ref": "#/definitions/ClusterPoolResourceProperties" - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "SystemData of cluster pool.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "TagsObject": { - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "description": "Tags object for patch operations." - }, - "ClusterListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The list of clusters." - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - }, - "description": "The list cluster operation response." - }, - "ClusterLogAnalyticsProfile": { - "type": "object", - "description": "Cluster log analytics profile to enable or disable OMS agent for cluster.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "True if log analytics is enabled for the cluster, otherwise false." - }, - "applicationLogs": { - "$ref": "#/definitions/ClusterLogAnalyticsApplicationLogs" - }, - "metricsEnabled": { - "type": "boolean", - "description": "True if metrics are enabled, otherwise false." - } - } - }, - "ClusterLogAnalyticsApplicationLogs": { - "type": "object", - "description": "Collection of logs to be enabled or disabled for log analytics.", - "properties": { - "stdOutEnabled": { - "type": "boolean", - "description": "True if stdout is enabled, otherwise false." - }, - "stdErrorEnabled": { - "type": "boolean", - "description": "True if stderror is enabled, otherwise false." - } - } - }, - "ClusterPrometheusProfile": { - "type": "object", - "description": "Cluster Prometheus profile.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable Prometheus for cluster or not.", - "default": false - } - } - }, - "IdentityProfile": { - "type": "object", - "description": "Identity Profile with details of an MSI.", - "required": [ - "msiResourceId", - "msiClientId", - "msiObjectId" - ], - "properties": { - "msiResourceId": { - "type": "string", - "description": "ResourceId of the MSI.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ManagedIdentity/userAssignedIdentities" - } - ] - } - }, - "msiClientId": { - "type": "string", - "description": "ClientId of the MSI.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - }, - "msiObjectId": { - "type": "string", - "description": "ObjectId of the MSI.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - } - } - }, - "AuthorizationProfile": { - "type": "object", - "description": "Authorization profile with details of AAD user Ids and group Ids authorized for data plane access.", - "properties": { - "userIds": { - "type": "array", - "description": "AAD user Ids authorized for data plane access.", - "items": { - "type": "string" - } - }, - "groupIds": { - "type": "array", - "description": "AAD group Ids authorized for data plane access.", - "items": { - "type": "string" - } - } - } - }, - "SecretReference": { - "type": "object", - "description": "Secret reference and corresponding properties of a key vault secret.", - "required": [ - "referenceName", - "type", - "keyVaultObjectName" - ], - "properties": { - "referenceName": { - "type": "string", - "description": "Reference name of the secret to be used in service configs." - }, - "type": { - "type": "string", - "description": "Type of key vault object: secret, key or certificate.", - "enum": [ - "Key", - "Secret", - "Certificate" - ], - "x-ms-enum": { - "name": "KeyVaultObjectType", - "modelAsString": true - } - }, - "version": { - "type": "string", - "description": "Version of the secret in key vault." - }, - "keyVaultObjectName": { - "type": "string", - "description": "Object identifier name of the secret in key vault.", - "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,126}$" - } - } - }, - "SecretsProfile": { - "type": "object", - "description": "The cluster secret profile.", - "required": [ - "keyVaultResourceId" - ], - "properties": { - "keyVaultResourceId": { - "type": "string", - "description": "Name of the user Key Vault where all the cluster specific user secrets are stored.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.KeyVault/vaults" - } - ] - } - }, - "secrets": { - "type": "array", - "description": "Properties of Key Vault secret.", - "items": { - "$ref": "#/definitions/SecretReference" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterConfigFile": { - "type": "object", - "description": "Cluster configuration files.", - "required": [ - "fileName" - ], - "properties": { - "fileName": { - "type": "string", - "description": "Configuration file name.", - "example": "hive-conf.xml." - }, - "content": { - "type": "string", - "description": "Free form content of the entire configuration file." - }, - "encoding": { - "type": "string", - "description": "This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text.", - "enum": [ - "Base64", - "None" - ], - "x-ms-enum": { - "name": "ContentEncoding", - "modelAsString": true - } - }, - "path": { - "type": "string", - "description": "Path of the config file if content is specified." - }, - "values": { - "type": "object", - "description": "List of key value pairs\nwhere key represents a valid service configuration name and value represents the value of the config.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ClusterServiceConfig": { - "type": "object", - "description": "Cluster configs per component.", - "required": [ - "component", - "files" - ], - "properties": { - "component": { - "type": "string", - "description": "Name of the component the config files should apply to." - }, - "files": { - "type": "array", - "description": "List of Config Files.", - "items": { - "$ref": "#/definitions/ClusterConfigFile" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterServiceConfigsProfile": { - "type": "object", - "description": "Cluster service configs.", - "required": [ - "serviceName", - "configs" - ], - "properties": { - "serviceName": { - "type": "string", - "description": "Name of the service the configurations should apply to." - }, - "configs": { - "type": "array", - "description": "List of service configs.", - "items": { - "$ref": "#/definitions/ClusterServiceConfig" - }, - "x-ms-identifiers": [] - } - } - }, - "ConnectivityProfile": { - "type": "object", - "description": "Cluster connectivity profile.", - "required": [ - "web" - ], - "properties": { - "web": { - "description": "Web connectivity endpoint details.", - "allOf": [ - { - "$ref": "#/definitions/WebConnectivityEndpoint" - } - ] - }, - "ssh": { - "type": "array", - "description": "List of SSH connectivity endpoints.", - "items": { - "$ref": "#/definitions/SshConnectivityEndpoint" - }, - "x-ms-identifiers": [] - } - }, - "readOnly": true - }, - "ClusterAccessProfile": { - "type": "object", - "description": "Cluster access profile.", - "required": [ - "enableInternalIngress" - ], - "properties": { - "enableInternalIngress": { - "type": "boolean", - "description": "Whether to create cluster using private IP instead of public IP. This property must be set at create time.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "privateLinkServiceId": { - "type": "string", - "readOnly": true, - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.Network/privateLinkServices" - } - ] - }, - "description": "Private link service resource ID. Only when enableInternalIngress is true, this property will be returned." - } - } - }, - "WebConnectivityEndpoint": { - "type": "object", - "description": "Web connectivity endpoint details.", - "required": [ - "fqdn" - ], - "properties": { - "fqdn": { - "type": "string", - "description": "Web connectivity endpoint.", - "example": "clusterName11223344.clusterPoolName55667788.subid.eastus.hdinsightaks.net" - }, - "privateFqdn": { - "type": "string", - "description": "Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.", - "example": "clusterName11223344-int.clusterPoolName55667788.subid.eastus.hdinsightaks.net" - } - }, - "readOnly": true - }, - "SshConnectivityEndpoint": { - "type": "object", - "description": "SSH connectivity endpoint details.", - "required": [ - "endpoint" - ], - "properties": { - "endpoint": { - "type": "string", - "description": "SSH connectivity endpoint.", - "example": "clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" - }, - "privateSshEndpoint": { - "type": "string", - "description": "Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true.", - "example": "clusterName11223344-int.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" - } - } - }, - "ClusterProfile": { - "type": "object", - "required": [ - "authorizationProfile", - "clusterVersion", - "ossVersion" - ], - "properties": { - "clusterVersion": { - "$ref": "#/definitions/ThreeOrFourPartVersionPattern" - }, - "ossVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "components": { - "$ref": "#/definitions/ClusterComponents" - }, - "identityProfile": { - "description": "This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster.", - "$ref": "#/definitions/IdentityProfile" - }, - "authorizationProfile": { - "$ref": "#/definitions/AuthorizationProfile" - }, - "secretsProfile": { - "$ref": "#/definitions/SecretsProfile" - }, - "serviceConfigsProfiles": { - "type": "array", - "description": "The service configs profiles.", - "items": { - "$ref": "#/definitions/ClusterServiceConfigsProfile" - }, - "x-ms-identifiers": [] - }, - "connectivityProfile": { - "$ref": "#/definitions/ConnectivityProfile" - }, - "clusterAccessProfile": { - "$ref": "#/definitions/ClusterAccessProfile" - }, - "logAnalyticsProfile": { - "$ref": "#/definitions/ClusterLogAnalyticsProfile" - }, - "prometheusProfile": { - "$ref": "#/definitions/ClusterPrometheusProfile" - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile" - }, - "autoscaleProfile": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "rangerPluginProfile": { - "$ref": "#/definitions/ClusterRangerPluginProfile" - }, - "kafkaProfile": { - "$ref": "#/definitions/KafkaProfile" - }, - "trinoProfile": { - "$ref": "#/definitions/TrinoProfile" - }, - "llapProfile": { - "type": "object", - "description": "LLAP cluster profile.", - "additionalProperties": true - }, - "flinkProfile": { - "$ref": "#/definitions/FlinkProfile" - }, - "sparkProfile": { - "$ref": "#/definitions/SparkProfile" - }, - "rangerProfile": { - "$ref": "#/definitions/RangerProfile" - }, - "stubProfile": { - "type": "object", - "description": "Stub cluster profile.", - "additionalProperties": true - }, - "scriptActionProfiles": { - "$ref": "#/definitions/ScriptActionProfiles" - } - }, - "description": "Cluster profile." - }, - "SshProfile": { - "type": "object", - "description": "Ssh profile for the cluster.", - "required": [ - "count" - ], - "properties": { - "count": { - "type": "integer", - "description": "Number of ssh pods per cluster.", - "format": "int32", - "maximum": 5.0, - "minimum": 0.0 - }, - "podPrefix": { - "type": "string", - "description": "Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //-", - "readOnly": true - } - } - }, - "AutoscaleProfile": { - "type": "object", - "description": "This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "This indicates whether auto scale is enabled on HDInsight on AKS cluster." - }, - "gracefulDecommissionTimeout": { - "type": "integer", - "format": "int32", - "description": "This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout." - }, - "autoscaleType": { - "type": "string", - "description": "User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based.", - "enum": [ - "ScheduleBased", - "LoadBased" - ], - "x-ms-enum": { - "name": "AutoscaleType", - "modelAsString": true - } - }, - "scheduleBasedConfig": { - "description": "Profiles of schedule based Autoscale.", - "$ref": "#/definitions/ScheduleBasedConfig" - }, - "loadBasedConfig": { - "description": "Profiles of load based Autoscale.", - "$ref": "#/definitions/LoadBasedConfig" - } - } - }, - "ScheduleBasedConfig": { - "type": "object", - "description": "Profile of schedule based Autoscale.", - "required": [ - "timeZone", - "defaultCount", - "schedules" - ], - "properties": { - "timeZone": { - "type": "string", - "description": "User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration." - }, - "defaultCount": { - "type": "integer", - "format": "int32", - "description": "Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down)" - }, - "schedules": { - "type": "array", - "description": "This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end).", - "items": { - "$ref": "#/definitions/Schedule" - }, - "x-ms-identifiers": [] - } - } - }, - "Schedule": { - "type": "object", - "description": "Schedule definition.", - "required": [ - "days", - "startTime", - "endTime", - "count" - ], - "properties": { - "startTime": { - "type": "string", - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "description": "User has to set the start time of current schedule configuration, format like 10:30 (HH:MM)." - }, - "endTime": { - "type": "string", - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "description": "User has to set the end time of current schedule configuration, format like 10:30 (HH:MM)." - }, - "count": { - "type": "integer", - "format": "int32", - "description": "User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer." - }, - "days": { - "type": "array", - "description": "User has to set the days where schedule has to be set for autoscale operation.", - "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "ScheduleDay", - "modelAsString": true - } - } - } - } - }, - "LoadBasedConfig": { - "type": "object", - "description": "Profile of load based Autoscale.", - "required": [ - "minNodes", - "maxNodes", - "scalingRules" - ], - "properties": { - "minNodes": { - "type": "integer", - "format": "int32", - "description": "User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." - }, - "maxNodes": { - "type": "integer", - "format": "int32", - "description": "User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." - }, - "pollInterval": { - "type": "integer", - "format": "int32", - "description": "User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation." - }, - "cooldownPeriod": { - "type": "integer", - "format": "int32", - "description": "This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds." - }, - "scalingRules": { - "type": "array", - "description": "The scaling rules.", - "items": { - "$ref": "#/definitions/ScalingRule" - }, - "x-ms-identifiers": [] - } - } - }, - "ScalingRule": { - "type": "object", - "description": "The scaling rule.", - "required": [ - "actionType", - "comparisonRule", - "evaluationCount", - "scalingMetric" - ], - "properties": { - "actionType": { - "type": "string", - "description": "The action type.", - "enum": [ - "scaleup", - "scaledown" - ], - "x-ms-enum": { - "name": "ScaleActionType", - "modelAsString": true - } - }, - "evaluationCount": { - "type": "integer", - "format": "int32", - "description": "This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered." - }, - "scalingMetric": { - "type": "string", - "description": "Metrics name for individual workloads. For example: cpu" - }, - "comparisonRule": { - "$ref": "#/definitions/ComparisonRule" - } - } - }, - "ComparisonRule": { - "type": "object", - "description": "The comparison rule.", - "required": [ - "operator", - "threshold" - ], - "properties": { - "operator": { - "type": "string", - "description": "The comparison operator.", - "enum": [ - "greaterThan", - "greaterThanOrEqual", - "lessThan", - "lessThanOrEqual" - ], - "x-ms-enum": { - "name": "ComparisonOperator", - "modelAsString": true - } - }, - "threshold": { - "type": "number", - "description": "Threshold setting." - } - } - }, - "TrinoProfile": { - "type": "object", - "description": "Trino Cluster profile.", - "properties": { - "catalogOptions": { - "$ref": "#/definitions/CatalogOptions" - }, - "coordinator": { - "$ref": "#/definitions/TrinoCoordinator" - }, - "userPluginsSpec": { - "$ref": "#/definitions/TrinoUserPlugins" - }, - "userTelemetrySpec": { - "$ref": "#/definitions/TrinoUserTelemetry" - }, - "worker": { - "$ref": "#/definitions/TrinoWorker" - } - } - }, - "CatalogOptions": { - "type": "object", - "description": "Trino cluster catalog options.", - "properties": { - "hive": { - "type": "array", - "description": "hive catalog options.", - "items": { - "$ref": "#/definitions/HiveCatalogOption" - }, - "x-ms-identifiers": [] - } - } - }, - "HiveCatalogOption": { - "type": "object", - "description": "Hive Catalog Option", - "required": [ - "catalogName", - "metastoreDbConnectionURL", - "metastoreWarehouseDir" - ], - "properties": { - "catalogName": { - "description": "Name of trino catalog which should use specified hive metastore.", - "minLength": 1, - "type": "string" - }, - "metastoreDbConnectionAuthenticationMode": { - "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", - "type": "string", - "enum": [ - "SqlAuth", - "IdentityAuth" - ], - "x-ms-enum": { - "name": "MetastoreDbConnectionAuthenticationMode", - "modelAsString": true, - "values": [ - { - "value": "SqlAuth", - "description": "The password-based authentication to connect to your Hive metastore database. " - }, - { - "value": "IdentityAuth", - "description": "The managed-identity-based authentication to connect to your Hive metastore database. " - } - ] - }, - "default": "IdentityAuth" - }, - "metastoreDbConnectionPasswordSecret": { - "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", - "type": "string" - }, - "metastoreDbConnectionURL": { - "description": "Connection string for hive metastore database.", - "type": "string" - }, - "metastoreDbConnectionUserName": { - "description": "User name for database connection.", - "type": "string" - }, - "metastoreWarehouseDir": { - "description": "Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri", - "type": "string" - } - } - }, - "FlinkCatalogOptions": { - "type": "object", - "description": "Flink cluster catalog options.", - "properties": { - "hive": { - "$ref": "#/definitions/FlinkHiveCatalogOption" - } - } - }, - "FlinkHiveCatalogOption": { - "type": "object", - "description": "Hive Catalog Option for Flink cluster.", - "required": [ - "metastoreDbConnectionURL" - ], - "properties": { - "metastoreDbConnectionAuthenticationMode": { - "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", - "type": "string", - "enum": [ - "SqlAuth", - "IdentityAuth" - ], - "x-ms-enum": { - "name": "MetastoreDbConnectionAuthenticationMode", - "modelAsString": true, - "values": [ - { - "value": "SqlAuth", - "description": "The password-based authentication to connect to your Hive metastore database. " - }, - { - "value": "IdentityAuth", - "description": "The managed-identity-based authentication to connect to your Hive metastore database. " - } - ] - }, - "default": "IdentityAuth" - }, - "metastoreDbConnectionPasswordSecret": { - "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", - "type": "string" - }, - "metastoreDbConnectionURL": { - "description": "Connection string for hive metastore database.", - "type": "string" - }, - "metastoreDbConnectionUserName": { - "description": "User name for database connection.", - "type": "string" - } - } - }, - "TrinoCoordinator": { - "type": "object", - "description": "Trino Coordinator.", - "properties": { - "debug": { - "$ref": "#/definitions/TrinoDebugConfig", - "x-ms-client-flatten": true - }, - "highAvailabilityEnabled": { - "type": "boolean", - "description": "The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.", - "default": true - } - } - }, - "TrinoWorker": { - "type": "object", - "description": "Trino worker.", - "properties": { - "debug": { - "$ref": "#/definitions/TrinoDebugConfig", - "x-ms-client-flatten": true - } - } - }, - "TrinoDebugConfig": { - "type": "object", - "description": "Trino debug configuration.", - "properties": { - "enable": { - "type": "boolean", - "description": "The flag that if enable debug or not.", - "default": false - }, - "port": { - "type": "integer", - "format": "int32", - "description": "The debug port.", - "default": 8008 - }, - "suspend": { - "type": "boolean", - "description": "The flag that if suspend debug or not.", - "default": false - } - } - }, - "TrinoUserTelemetry": { - "type": "object", - "description": "User telemetry", - "properties": { - "storage": { - "$ref": "#/definitions/TrinoTelemetryConfig" - } - } - }, - "TrinoTelemetryConfig": { - "type": "object", - "description": "Trino user telemetry definition.", - "properties": { - "hivecatalogName": { - "type": "string", - "description": "Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created.", - "minLength": 1 - }, - "hivecatalogSchema": { - "type": "string", - "description": "Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs.", - "default": "trinologs" - }, - "partitionRetentionInDays": { - "type": "integer", - "description": "Retention period for query log table partitions, this doesn't have any affect on actual data.", - "format": "int32", - "default": 365 - }, - "path": { - "type": "string", - "description": "Azure storage location of the blobs.", - "minLength": 1 - } - } - }, - "TrinoUserPlugins": { - "type": "object", - "description": "Trino user plugins spec", - "properties": { - "plugins": { - "type": "array", - "description": "Trino user plugins.", - "items": { - "$ref": "#/definitions/TrinoUserPlugin" - }, - "x-ms-identifiers": [] - } - } - }, - "TrinoUserPlugin": { - "type": "object", - "description": "Trino user plugin.", - "properties": { - "enabled": { - "type": "boolean", - "description": "Denotes whether the plugin is active or not." - }, - "name": { - "type": "string", - "description": "This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path.", - "minLength": 1 - }, - "path": { - "type": "string", - "description": "Fully qualified path to the folder containing the plugins.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$" - } - } - }, - "SparkProfile": { - "type": "object", - "description": "The spark cluster profile.", - "properties": { - "defaultStorageUrl": { - "type": "string", - "description": "The default storage URL." - }, - "metastoreSpec": { - "$ref": "#/definitions/SparkMetastoreSpec" - }, - "userPluginsSpec": { - "$ref": "#/definitions/SparkUserPlugins" - } - } - }, - "SparkUserPlugins": { - "type": "object", - "description": "Spark user plugins spec", - "properties": { - "plugins": { - "type": "array", - "description": "Spark user plugins.", - "items": { - "$ref": "#/definitions/SparkUserPlugin" - }, - "x-ms-identifiers": [] - } - } - }, - "SparkUserPlugin": { - "type": "object", - "description": "Spark user plugin.", - "required": [ - "path" - ], - "properties": { - "path": { - "type": "string", - "description": "Fully qualified path to the folder containing the plugins.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$" - } - } - }, - "ScriptActionProfiles": { - "type": "array", - "description": "The script action profile list.", - "items": { - "$ref": "#/definitions/ScriptActionProfile" - }, - "x-ms-identifiers": [] - }, - "ScriptActionProfile": { - "type": "object", - "description": "The script action profile.", - "required": [ - "name", - "type", - "url", - "services" - ], - "properties": { - "type": { - "type": "string", - "description": "Type of the script action. Supported type is bash scripts." - }, - "name": { - "type": "string", - "description": "Script name." - }, - "url": { - "type": "string", - "description": "Url of the script file.", - "pattern": "^(https)|(http)://.*$" - }, - "parameters": { - "type": "string", - "description": "Additional parameters for the script action. It should be space-separated list of arguments required for script execution." - }, - "services": { - "items": { - "type": "string" - }, - "type": "array", - "description": "List of services to apply the script action." - }, - "timeoutInMinutes": { - "type": "integer", - "format": "int32", - "description": "Timeout duration for the script action in minutes." - }, - "shouldPersist": { - "type": "boolean", - "default": true, - "description": "Specify if the script should persist on the cluster." - } - } - }, - "SparkMetastoreSpec": { - "type": "object", - "description": "The metastore specification for Spark cluster.", - "required": [ - "dbServerHost", - "dbName" - ], - "properties": { - "dbServerHost": { - "type": "string", - "description": "The database server host." - }, - "dbName": { - "type": "string", - "description": "The database name." - }, - "dbConnectionAuthenticationMode": { - "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", - "type": "string", - "enum": [ - "SqlAuth", - "IdentityAuth" - ], - "x-ms-enum": { - "name": "DbConnectionAuthenticationMode", - "modelAsString": true, - "values": [ - { - "value": "SqlAuth", - "description": "The password-based authentication to connect to your Hive metastore database. " - }, - { - "value": "IdentityAuth", - "description": "The managed-identity-based authentication to connect to your Hive metastore database. " - } - ] - }, - "default": "IdentityAuth" - }, - "dbUserName": { - "type": "string", - "description": "The database user name." - }, - "dbPasswordSecretName": { - "type": "string", - "description": "The secret name which contains the database user password." - }, - "keyVaultId": { - "type": "string", - "description": "The key vault resource id." - }, - "thriftUrl": { - "type": "string", - "description": "The thrift url." - } - } - }, - "FlinkProfile": { - "type": "object", - "description": "The Flink cluster profile.", - "required": [ - "storage", - "jobManager", - "taskManager" - ], - "properties": { - "storage": { - "$ref": "#/definitions/FlinkStorageProfile" - }, - "numReplicas": { - "type": "integer", - "format": "int32", - "description": "The number of task managers." - }, - "jobManager": { - "description": "Job Manager container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "historyServer": { - "description": "History Server container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "taskManager": { - "description": "Task Manager container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "catalogOptions": { - "$ref": "#/definitions/FlinkCatalogOptions" - }, - "deploymentMode": { - "description": "A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session", - "type": "string", - "enum": [ - "Application", - "Session" - ], - "x-ms-enum": { - "name": "deploymentMode", - "modelAsString": true - } - }, - "jobSpec": { - "$ref": "#/definitions/FlinkJobProfile" - } - } - }, - "FlinkJobProfile": { - "type": "object", - "description": "Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.", - "required": [ - "jobJarDirectory", - "jarName", - "upgradeMode" - ], - "properties": { - "jobJarDirectory": { - "description": "A string property that specifies the directory where the job JAR is located.", - "type": "string" - }, - "jarName": { - "description": "A string property that represents the name of the job JAR.", - "type": "string" - }, - "entryClass": { - "description": "A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.", - "type": "string" - }, - "args": { - "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", - "type": "string" - }, - "savePointName": { - "description": "A string property that represents the name of the savepoint for the Flink job", - "type": "string" - }, - "upgradeMode": { - "description": "A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE.", - "type": "string", - "enum": [ - "STATELESS_UPDATE", - "UPDATE", - "LAST_STATE_UPDATE" - ], - "x-ms-enum": { - "name": "upgradeMode", - "modelAsString": true - } - } - } - }, - "FlinkStorageProfile": { - "type": "object", - "description": "The storage profile", - "required": [ - "storageUri" - ], - "properties": { - "storageUri": { - "type": "string", - "pattern": "^(\\w{4,5})://(.*)@(.*).\\b(blob|dfs)\\b.*$", - "description": "Storage account uri which is used for savepoint and checkpoint state." - }, - "storagekey": { - "type": "string", - "description": "Storage key is only required for wasb(s) storage.", - "x-ms-secret": true - } - } - }, - "ClusterRangerPluginProfile": { - "type": "object", - "description": "Cluster Ranger plugin profile.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable Ranger for cluster or not.", - "default": false - } - } - }, - "RangerProfile": { - "type": "object", - "description": "The ranger cluster profile.", - "required": [ - "rangerAdmin", - "rangerUsersync" - ], - "properties": { - "rangerAdmin": { - "$ref": "#/definitions/RangerAdminSpec" - }, - "rangerAudit": { - "$ref": "#/definitions/RangerAuditSpec" - }, - "rangerUsersync": { - "$ref": "#/definitions/RangerUsersyncSpec" - } - } - }, - "RangerAdminSpec": { - "type": "object", - "description": "Specification for the Ranger Admin service.", - "properties": { - "admins": { - "description": "List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users.", - "items": { - "type": "string" - }, - "type": "array" - }, - "database": { - "properties": { - "host": { - "description": "The database URL", - "type": "string" - }, - "name": { - "description": "The database name", - "type": "string" - }, - "passwordSecretRef": { - "description": "Reference for the database password", - "type": "string" - }, - "username": { - "description": "The name of the database user", - "type": "string" - } - }, - "required": [ - "host", - "name" - ], - "type": "object" - } - }, - "required": [ - "admins", - "database" - ] - }, - "RangerAuditSpec": { - "description": "Properties required to describe audit log storage.", - "properties": { - "storageAccount": { - "description": "Azure storage location of the blobs. MSI should have read/write access to this Storage account.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$", - "type": "string" - } - }, - "type": "object" - }, - "RangerUsersyncSpec": { - "description": "Specification for the Ranger Usersync service", - "properties": { - "enabled": { - "description": "Denotes whether usersync service should be enabled", - "type": "boolean", - "default": true - }, - "groups": { - "description": "List of groups that should be synced. These group names should match the object id of the respective AAD groups.", - "items": { - "type": "string" - }, - "type": "array" - }, - "mode": { - "default": "automatic", - "description": "User & groups can be synced automatically or via a static list that's refreshed.", - "type": "string", - "enum": [ - "static", - "automatic" - ], - "x-ms-enum": { - "name": "RangerUsersyncMode", - "modelAsString": true - } - }, - "userMappingLocation": { - "description": "Azure storage location of a mapping file that lists user & group associations.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$", - "type": "string" - }, - "users": { - "description": "List of user names that should be synced. These usernames should match the User principal name of the respective AAD users.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ComputeResourceDefinition": { - "type": "object", - "description": "The cpu and memory requirement definition.", - "required": [ - "cpu", - "memory" - ], - "properties": { - "cpu": { - "type": "number", - "format": "float", - "description": "The required CPU." - }, - "memory": { - "type": "integer", - "format": "int64", - "description": "The required memory in MB, Container memory will be 110 percentile" - } - } - }, - "KafkaProfile": { - "type": "object", - "description": "The Kafka cluster profile.", - "required": [ - "diskStorage" - ], - "properties": { - "enableKRaft": { - "description": "Expose Kafka cluster in KRaft mode.", - "default": true, - "type": "boolean" - }, - "enablePublicEndpoints": { - "description": "Expose worker nodes as public endpoints.", - "default": false, - "type": "boolean" - }, - "remoteStorageUri": { - "description": "Fully qualified path of Azure Storage container used for Tiered Storage.", - "type": "string", - "pattern": "^(https?|abfss?):\\/\\/[^/]+(?:\\/|$)" - }, - "diskStorage": { - "$ref": "#/definitions/DiskStorageProfile" - }, - "clusterIdentity": { - "description": "Identity of the internal service components inside the Kafka cluster.", - "$ref": "#/definitions/IdentityProfile", - "readOnly": true - }, - "connectivityEndpoints": { - "description": "Kafka bootstrap server and brokers related connectivity endpoints.", - "$ref": "#/definitions/KafkaConnectivityEndpoints", - "readOnly": true - } - } - }, - "DiskStorageProfile": { - "type": "object", - "description": "Kafka disk storage profile.", - "required": [ - "dataDiskSize", - "dataDiskType" - ], - "properties": { - "dataDiskSize": { - "description": "Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB.", - "format": "int32", - "type": "integer" - }, - "dataDiskType": { - "description": "Managed Disk Type.", - "type": "string", - "enum": [ - "Standard_HDD_LRS", - "Standard_SSD_LRS", - "Standard_SSD_ZRS", - "Premium_SSD_LRS", - "Premium_SSD_ZRS", - "Premium_SSD_v2_LRS" - ], - "x-ms-enum": { - "name": "DataDiskType", - "modelAsString": true - } - } - } - }, - "KafkaConnectivityEndpoints": { - "type": "object", - "description": "Kafka bootstrap server and broker related connectivity endpoints.", - "properties": { - "bootstrapServerEndpoint": { - "type": "string", - "description": "bootstrap server connectivity endpoint." - }, - "brokerEndpoints": { - "description": "Kafka broker endpoint list.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterResourceProperties": { - "type": "object", - "required": [ - "clusterType", - "computeProfile", - "clusterProfile" - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "type": "string", - "enum": [ - "Accepted", - "Succeeded", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "readOnly": true - }, - "clusterType": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The type of cluster.", - "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" - }, - "deploymentId": { - "type": "string", - "description": "A unique id generated by the RP to identify the resource.", - "example": "45cd32aead6e4a91b079a0cdbfac8c36", - "readOnly": true - }, - "computeProfile": { - "description": "The compute profile.", - "$ref": "#/definitions/ComputeProfile" - }, - "clusterProfile": { - "$ref": "#/definitions/ClusterProfile" - }, - "status": { - "type": "string", - "description": "Business status of the resource.", - "example": "Running", - "readOnly": true - } - }, - "description": "Cluster resource properties." - }, - "ComputeProfile": { - "type": "object", - "description": "The compute profile.", - "required": [ - "nodes" - ], - "properties": { - "nodes": { - "type": "array", - "description": "The nodes definitions.", - "items": { - "$ref": "#/definitions/NodeProfile" - }, - "x-ms-identifiers": [] - } - } - }, - "NodeProfile": { - "type": "object", - "description": "The node profile.", - "required": [ - "type", - "vmSize", - "count" - ], - "properties": { - "type": { - "type": "string", - "description": "The node type.", - "pattern": "^(head|Head|HEAD|worker|Worker|WORKER)$" - }, - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - }, - "count": { - "description": "The number of virtual machines.", - "type": "integer", - "format": "int32", - "minimum": 1 - } - } - }, - "Cluster": { - "type": "object", - "description": "The cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster specific properties.", - "$ref": "#/definitions/ClusterResourceProperties" - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "SystemData of cluster.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterPatch": { - "type": "object", - "description": "The patch for a cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Define cluster patch specific properties.", - "$ref": "#/definitions/ClusterPatchProperties" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - } - } - }, - "ClusterPatchProperties": { - "type": "object", - "description": "Cluster resource patch data.", - "properties": { - "clusterProfile": { - "$ref": "#/definitions/UpdatableClusterProfile" - } - } - }, - "UpdatableClusterProfile": { - "type": "object", - "properties": { - "serviceConfigsProfiles": { - "type": "array", - "description": "The service configs profiles.", - "items": { - "$ref": "#/definitions/ClusterServiceConfigsProfile" - }, - "x-ms-identifiers": [] - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile" - }, - "autoscaleProfile": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "authorizationProfile": { - "$ref": "#/definitions/AuthorizationProfile" - }, - "logAnalyticsProfile": { - "$ref": "#/definitions/ClusterLogAnalyticsProfile" - }, - "prometheusProfile": { - "$ref": "#/definitions/ClusterPrometheusProfile" - }, - "rangerPluginProfile": { - "$ref": "#/definitions/ClusterRangerPluginProfile" - }, - "rangerProfile": { - "$ref": "#/definitions/RangerProfile" - }, - "scriptActionProfiles": { - "$ref": "#/definitions/ScriptActionProfiles" - } - }, - "description": "Cluster resource patch properties." - }, - "ClusterResizeData": { - "type": "object", - "description": "The parameters for resizing a cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Sets the properties. Define cluster resize specific properties.", - "$ref": "#/definitions/ClusterResizeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterResizeProperties": { - "type": "object", - "description": "The properties for resizing a cluster.", - "required": [ - "targetWorkerNodeCount" - ], - "properties": { - "targetWorkerNodeCount": { - "type": "integer", - "format": "int32", - "description": "Target node count of worker node." - } - } - }, - "ServiceConfigListResult": { - "type": "object", - "description": "Cluster instance service configs api response.", - "properties": { - "value": { - "type": "array", - "description": "Cluster instance service config array.", - "items": { - "$ref": "#/definitions/ServiceConfigResult" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ServiceConfigResult": { - "type": "object", - "description": "Cluster instance service config.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster instance service config properties.", - "allOf": [ - { - "$ref": "#/definitions/ServiceConfigListResultProperties" - } - ] - } - } - }, - "ServiceConfigListResultProperties": { - "type": "object", - "properties": { - "serviceName": { - "type": "string", - "description": "Service Config Name." - }, - "fileName": { - "type": "string", - "description": "File Name." - }, - "content": { - "type": "string", - "description": "Content in the service config file." - }, - "componentName": { - "type": "string", - "description": "Component Name." - }, - "type": { - "type": "string", - "description": "Config type." - }, - "path": { - "type": "string", - "description": "Config file path." - }, - "customKeys": { - "type": "object", - "description": "The custom keys.", - "additionalProperties": { - "type": "string" - } - }, - "defaultKeys": { - "type": "object", - "description": "The default keys.", - "additionalProperties": { - "$ref": "#/definitions/ServiceConfigListResultValueEntity" - } - } - }, - "required": [ - "serviceName", - "componentName", - "fileName" - ], - "description": "Service config response." - }, - "ServiceConfigListResultValueEntity": { - "type": "object", - "description": "Default config details.", - "properties": { - "value": { - "type": "string", - "description": "Config value." - }, - "description": { - "type": "string", - "description": "Config description." - } - }, - "required": [ - "value" - ] - }, - "ClusterInstanceViewsResult": { - "type": "object", - "properties": { - "value": { - "items": { - "$ref": "#/definitions/ClusterInstanceViewResult" - }, - "type": "array", - "description": "Cluster instance view array.", - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - }, - "description": "The instance view of a HDInsight Cluster." - }, - "ClusterInstanceViewResult": { - "type": "object", - "description": "Cluster Instance View.", - "required": [ - "name", - "properties" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the instance view." - }, - "properties": { - "description": "Properties of the instance view.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ClusterInstanceViewProperties" - } - ] - } - } - }, - "ClusterInstanceViewProperties": { - "type": "object", - "description": "Cluster Instance View Properties.", - "required": [ - "status", - "serviceStatuses" - ], - "properties": { - "status": { - "description": "Status of the instance view.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInstanceViewStatus" - } - ] - }, - "serviceStatuses": { - "type": "array", - "description": "List of statuses of relevant services that make up the HDInsight on AKS cluster to surface to the customer.", - "items": { - "$ref": "#/definitions/ServiceStatus" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterInstanceViewStatus": { - "type": "object", - "description": "Status of the instance view.", - "required": [ - "ready" - ], - "properties": { - "ready": { - "type": "string", - "description": "The cluster ready status" - }, - "reason": { - "type": "string", - "description": "The status reason." - }, - "message": { - "type": "string", - "description": "The additional message." - } - } - }, - "ServiceStatus": { - "type": "object", - "description": "Describes the status of a service of a HDInsight on AKS cluster.", - "required": [ - "kind", - "ready" - ], - "properties": { - "kind": { - "type": "string", - "description": "Kind of the service. E.g. \"Zookeeper\"." - }, - "ready": { - "type": "string", - "description": "Indicates if the service is ready / healthy. Values can be \"true\", \"false\", \"unknown\" or anything else." - }, - "message": { - "type": "string", - "description": "A message describing the error if any." - } - } - }, - "NameAvailabilityParameters": { - "description": "Details of check name availability request body.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name for checking availability." - }, - "type": { - "type": "string", - "description": "The resource type in Microsoft.HDInsight." - } - } - }, - "NameAvailabilityResult": { - "description": "Result of check name availability.", - "type": "object", - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Indicator of availability of the Microsoft.HDInsight resource name." - }, - "reason": { - "type": "string", - "description": "The reason of unavailability." - }, - "message": { - "type": "string", - "description": "The error message of unavailability." - } - } - }, - "ClusterPoolVersionPattern": { - "type": "string", - "description": "Cluster pool version is a 2-part version.", - "example": "1.2", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" - }, - "ClusterPoolVersionsListResult": { - "type": "object", - "description": "Represents a list of cluster pool versions.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster pool versions.", - "items": { - "$ref": "#/definitions/ClusterPoolVersion" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterPoolVersion": { - "type": "object", - "description": "Available cluster pool version.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster pool version properties.", - "$ref": "#/definitions/ClusterPoolVersionProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterPoolVersionProperties": { - "type": "object", - "description": "Cluster pool version properties.", - "properties": { - "clusterPoolVersion": { - "$ref": "#/definitions/ClusterPoolVersionPattern" - }, - "aksVersion": { - "type": "string", - "description": "AKS version.", - "example": "1.24" - }, - "isPreview": { - "type": "boolean", - "description": "Indicate if this version is in preview or not.", - "default": false - } - } - }, - "ThreePartVersionPattern": { - "type": "string", - "description": "Version with three part.", - "example": "1.0.4", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" - }, - "ThreeOrFourPartVersionPattern": { - "type": "string", - "description": "Version with 3/4 part.", - "example": "1.0.4", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})(?:\\.(0|[1-9][0-9]{0,18}))?$" - }, - "ClusterVersionsListResult": { - "type": "object", - "description": "Represents a list of cluster versions.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster versions.", - "items": { - "$ref": "#/definitions/ClusterVersion" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterVersion": { - "type": "object", - "description": "Available cluster version.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster version properties.", - "$ref": "#/definitions/ClusterVersionProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterVersionProperties": { - "type": "object", - "description": "Cluster version properties.", - "properties": { - "clusterType": { - "type": "string", - "description": "The type of cluster.", - "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" - }, - "clusterVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "ossVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "clusterPoolVersion": { - "type": "string", - "description": "The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string", - "example": "1.0" - }, - "isPreview": { - "type": "boolean", - "description": "Indicate if this version is in preview or not.", - "default": false - }, - "components": { - "$ref": "#/definitions/ClusterComponents" - } - } - }, - "ClusterComponents": { - "type": "array", - "description": "Component list of this cluster type and version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "x-ms-identifiers": [], - "example": [ - { - "name": "HDFS", - "version": "1.2.3" - }, - { - "name": "HIVE", - "version": "1.2.3" - } - ] - }, - "ClusterJobList": { - "description": "Collection of cluster job.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of cluster job.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterJob" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - } - } - }, - "ClusterJob": { - "description": "Cluster job.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterJobProperties" - } - } - }, - "ClusterJobProperties": { - "description": "Properties of cluster job.", - "type": "object", - "properties": { - "jobType": { - "description": "Type of cluster job.", - "enum": [ - "FlinkJob" - ], - "type": "string", - "x-ms-enum": { - "name": "jobType", - "modelAsString": true - } - } - }, - "discriminator": "jobType", - "required": [ - "jobType" - ] - }, - "FlinkJobProperties": { - "description": "Properties of flink job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterJobProperties" - } - ], - "properties": { - "runId": { - "description": "Run id of job", - "type": "string" - }, - "jobName": { - "description": "Name of job", - "type": "string" - }, - "jobJarDirectory": { - "description": "A string property that specifies the directory where the job JAR is located.", - "type": "string" - }, - "jarName": { - "description": "A string property that represents the name of the job JAR.", - "type": "string" - }, - "entryClass": { - "description": "A string property that specifies the entry class for the Flink job.", - "type": "string" - }, - "args": { - "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", - "type": "string" - }, - "savePointName": { - "description": "A string property that represents the name of the savepoint for the Flink job", - "type": "string" - }, - "action": { - "description": "A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE.", - "type": "string", - "enum": [ - "NEW", - "UPDATE", - "STATELESS_UPDATE", - "STOP", - "START", - "CANCEL", - "SAVEPOINT", - "LIST_SAVEPOINT", - "DELETE", - "LAST_STATE_UPDATE", - "RE_LAUNCH" - ], - "x-ms-enum": { - "name": "action", - "modelAsString": true - } - }, - "flinkConfiguration": { - "description": "Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "jobId": { - "description": "Unique id for identifying a job", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of job.", - "type": "string", - "readOnly": true - }, - "jobOutput": { - "description": "Output of job.", - "type": "string", - "readOnly": true - }, - "actionResult": { - "description": "Action result of job.", - "type": "string", - "readOnly": true - }, - "lastSavePoint": { - "description": "The last savepoint.", - "type": "string", - "readOnly": true - } - }, - "x-ms-discriminator-value": "FlinkJob" - }, - "ClusterPoolAvailableUpgradeList": { - "type": "object", - "description": "collection of cluster pool available upgrade.", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of cluster pool available upgrade.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterPoolAvailableUpgrade" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - } - } - }, - "ClusterPoolAvailableUpgrade": { - "type": "object", - "description": "Cluster pool available upgrade.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster pool upgrade specific properties.", - "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterPoolAvailableUpgradeProperties": { - "type": "object", - "description": "Cluster pool available upgrade properties.", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "NodeOsUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterPoolAvailableUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterPoolAvailableUpgradeAksPatchUpgradeProperties": { - "type": "object", - "description": "Cluster pool available AKS patch version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" - } - ], - "properties": { - "currentVersion": { - "description": "Current AKS version.", - "type": "string" - }, - "currentVersionStatus": { - "description": "Current AKS version's status: whether it is deprecated or supported", - "enum": [ - "Deprecated", - "Supported" - ], - "type": "string", - "x-ms-enum": { - "name": "currentClusterPoolAksVersionStatus", - "modelAsString": true - } - }, - "latestVersion": { - "description": "Latest AKS patch version.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterPoolAvailableUpgradeNodeOsUpgradeProperties": { - "type": "object", - "description": "Cluster pool available node OS update.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" - } - ], - "properties": { - "latestVersion": { - "description": "The latest node OS version.", - "type": "string" - } - }, - "x-ms-discriminator-value": "NodeOsUpgrade" - }, - "ClusterAvailableUpgradeList": { - "type": "object", - "description": "Collection of cluster available upgrade.", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of Cluster available upgrade.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterAvailableUpgrade" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The URL of next result page.", - "type": "string" - } - } - }, - "ClusterAvailableUpgrade": { - "type": "object", - "description": "Cluster available upgrade.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster upgrade specific properties.", - "$ref": "#/definitions/ClusterAvailableUpgradeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterAvailableUpgradeProperties": { - "type": "object", - "description": "Cluster available upgrade properties.", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "HotfixUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterAvailableUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterAvailableUpgradeAksPatchUpgradeProperties": { - "type": "object", - "description": "Cluster available AKS patch version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterAvailableUpgradeProperties" - } - ], - "properties": { - "currentVersion": { - "description": "Current node pool version.", - "type": "string" - }, - "currentVersionStatus": { - "description": "Current AKS version's status: whether it is deprecated or supported", - "enum": [ - "Deprecated", - "Supported" - ], - "type": "string", - "x-ms-enum": { - "name": "currentClusterAksVersionStatus", - "modelAsString": true - } - }, - "latestVersion": { - "description": "Latest available version, which should be equal to AKS control plane version if it's not deprecated.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterAvailableUpgradeHotfixUpgradeProperties": { - "type": "object", - "description": "Cluster available hotfix version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterAvailableUpgradeProperties" - } - ], - "properties": { - "description": { - "type": "string", - "description": "Hotfix version upgrade description." - }, - "sourceOssVersion": { - "description": "Source OSS version of current cluster component.", - "type": "string" - }, - "sourceClusterVersion": { - "description": "Source cluster version of current cluster component.", - "type": "string" - }, - "sourceBuildNumber": { - "description": "Source build number of current cluster component.", - "type": "string" - }, - "targetOssVersion": { - "description": "Target OSS version of component to be upgraded.", - "type": "string" - }, - "targetClusterVersion": { - "description": "Target cluster version of component to be upgraded.", - "type": "string" - }, - "targetBuildNumber": { - "description": "Target build number of component to be upgraded.", - "type": "string" - }, - "componentName": { - "description": "Name of component to be upgraded.", - "type": "string" - }, - "severity": { - "description": "Severity of this upgrade.", - "enum": [ - "low", - "medium", - "high", - "critical" - ], - "type": "string", - "x-ms-enum": { - "name": "Severity", - "modelAsString": true - } - }, - "extendedProperties": { - "description": "Extended properties of current available upgrade version", - "type": "string" - }, - "createdTime": { - "description": "Created time of current available upgrade version", - "type": "string", - "format": "date-time" - } - }, - "x-ms-discriminator-value": "HotfixUpgrade" - }, - "ClusterPoolUpgrade": { - "description": "Cluster Pool Upgrade.", - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterPoolUpgradeProperties" - } - } - }, - "ClusterPoolUpgradeProperties": { - "description": "Properties of upgrading cluster pool.", - "type": "object", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "NodeOsUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterPoolUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterPoolAKSPatchVersionUpgradeProperties": { - "description": "Properties of upgrading cluster pool's AKS patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolUpgradeProperties" - } - ], - "properties": { - "upgradeClusterPool": { - "description": "whether upgrade cluster pool or not. If it's true, upgradeAllClusterNodes should be false.", - "type": "boolean", - "default": false - }, - "upgradeAllClusterNodes": { - "description": "whether upgrade all clusters' nodes. If it's true, upgradeClusterPool should be false.", - "type": "boolean", - "default": false - }, - "targetAksVersion": { - "description": "Target AKS version. When it's not set, latest version will be used. When upgradeClusterPool is true and upgradeAllClusterNodes is false, target version should be greater or equal to current version. When upgradeClusterPool is false and upgradeAllClusterNodes is true, target version should be equal to AKS version of cluster pool.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterPoolNodeOsImageUpdateProperties": { - "description": "Properties of upgrading cluster pool's AKS patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolUpgradeProperties" - } - ], - "properties": {}, - "x-ms-discriminator-value": "NodeOsUpgrade" - }, - "ClusterUpgrade": { - "description": "Cluster Upgrade.", - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterUpgradeProperties" - } - } - }, - "ClusterUpgradeProperties": { - "description": "Properties of upgrading cluster.", - "type": "object", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "HotfixUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterAKSPatchVersionUpgradeProperties": { - "description": "Properties of upgrading cluster's AKS patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterUpgradeProperties" - } - ], - "properties": {}, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterHotfixUpgradeProperties": { - "description": "Properties of upgrading cluster's hotfix.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterUpgradeProperties" - } - ], - "properties": { - "targetOssVersion": { - "description": "Target OSS version of component to be upgraded.", - "type": "string" - }, - "targetClusterVersion": { - "description": "Target cluster version of component to be upgraded.", - "type": "string" - }, - "targetBuildNumber": { - "description": "Target build number of component to be upgraded.", - "type": "string" - }, - "componentName": { - "description": "Name of component to be upgraded.", - "type": "string" - } - }, - "x-ms-discriminator-value": "HotfixUpgrade" - } - }, - "parameters": { - "ClusterPoolNameParameter": { - "name": "clusterPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster pool.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the HDInsight cluster.", - "x-ms-parameter-location": "method" - }, - "ClusterTypeNameParameter": { - "name": "clusterTypeName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the HDInsight on AKS cluster type.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ClusterUpgradeRollback.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ClusterUpgradeRollback.json deleted file mode 100644 index 30f37192210d..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ClusterUpgradeRollback.json +++ /dev/null @@ -1,142 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterRollbackUpgradeRequest": { - "properties": { - "upgradeHistory": "/subscriptions/10e32bab-26da-4cc4-a441-52b318f824e6/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterpools/clusterpool1/clusters/cluster1/upgradeHistories/01_11_2024_02_35_03_AM-HotfixUpgrade" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateAutoscaleCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateAutoscaleCluster.json deleted file mode 100644 index c1854357ddce..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateAutoscaleCluster.json +++ /dev/null @@ -1,386 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "Trino", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "vmSize": "Standard_E8as_v5" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_E8as_v5" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "Trino", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPool.json deleted file mode 100644 index fd76d9e50515..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPool.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "availabilityZones": [ - "1", - "2", - "3" - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithPrivateAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithPrivateAks.json deleted file mode 100644 index c13de49280cd..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithPrivateAks.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "enablePrivateApiServer": true - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "enablePrivateApiServer": true - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "enablePrivateApiServer": true - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithUDRAks.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithUDRAks.json deleted file mode 100644 index 9522fe62a2ca..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateClusterPoolWithUDRAks.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPool": { - "location": "West US 2", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "outboundType": "userDefinedRouting" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "outboundType": "userDefinedRouting" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Accepted", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - }, - "networkProfile": { - "subnetId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", - "outboundType": "userDefinedRouting" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateRangerCluster.json deleted file mode 100644 index 5c2aea923bf2..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateRangerCluster.json +++ /dev/null @@ -1,269 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "ranger", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "ranger", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "ranger", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkCluster.json deleted file mode 100644 index 312c941518cd..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkCluster.json +++ /dev/null @@ -1,346 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "vmSize": "Standard_D3_v2" - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "spark", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkClusterWithInternalIngress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkClusterWithInternalIngress.json deleted file mode 100644 index 0da021e3cde6..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/CreateSparkClusterWithInternalIngress.json +++ /dev/null @@ -1,364 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "HDInsightCluster": { - "location": "West US 2", - "properties": { - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "vmSize": "Standard_D3_v2" - }, - "clusterAccessProfile": { - "enableInternalIngress": true - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "spark", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net", - "privateFqdn": "cluster1-int.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - }, - "clusterAccessProfile": { - "enableInternalIngress": true, - "privateLinkServiceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/privateLinkServices/testpls" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Accepted", - "clusterType": "spark", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 4 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "0.0.1", - "ossVersion": "2.2.3", - "components": [ - { - "name": "HDFS", - "version": "2.2.3" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "spark-service", - "configs": [ - { - "component": "spark-config", - "files": [ - { - "fileName": "spark-defaults.conf", - "values": { - "spark.eventLog.enabled": "true" - } - } - ] - } - ] - }, - { - "serviceName": "yarn-service", - "configs": [ - { - "component": "yarn-config", - "files": [ - { - "fileName": "core-site.xml", - "values": { - "fs.defaultFS": "wasb://testcontainer@teststorage.dfs.core.windows.net/", - "storage.name": "teststorage", - "storage.protocol": "wasb", - "storage.key": "test key", - "storage.container": "testcontainer" - } - }, - { - "fileName": "yarn-site.xml", - "values": { - "yarn.webapp.ui2.enable": "false" - } - } - ] - } - ] - } - ], - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net", - "privateFqdn": "cluster1-int.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1", - "privateSshEndpoint": "cluster1-int.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "sparkProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - }, - "clusterAccessProfile": { - "enableInternalIngress": true, - "privateLinkServiceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.Network/privateLinkServices/testpls" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteCluster.json deleted file mode 100644 index b689dd2b0dab..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteCluster.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "rg1", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": {}, - "202": { - "description": "Cluster delete request accepted.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteClusterPool.json deleted file mode 100644 index ba83e73a4e44..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/DeleteClusterPool.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "rg1", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": {}, - "202": { - "description": "Cluster Pool delete request accepted.", - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-asyncoperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetCluster.json deleted file mode 100644 index 6dfcce9d29a8..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetCluster.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterInstanceView.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterInstanceView.json deleted file mode 100644 index 350884ab207e..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterInstanceView.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2024-05-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "name": "default", - "properties": { - "status": { - "ready": "True", - "reason": "", - "message": "" - }, - "serviceStatuses": [ - { - "kind": "ZooKeeper", - "ready": "true", - "message": "" - } - ] - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterPool.json deleted file mode 100644 index dbba4546749d..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetClusterPool.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetOperations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetOperations.json deleted file mode 100644 index 0439980c49d3..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/GetOperations.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "resourceGroup1", - "api-version": "2024-05-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.HDInsight/clusterpool/read", - "isDataAction": false, - "display": { - "provider": "HDInsight on AKS", - "resource": "Cluster Pool.", - "operation": "Get Cluster Pool Operation result.", - "description": "Get any cluster pool." - }, - "origin": "user, system" - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/InstallNewClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/InstallNewClusterLibraries.json deleted file mode 100644 index b755ec38d9e1..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/InstallNewClusterLibraries.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "hiloResourceGroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterPool", - "clusterName": "cluster", - "operation": { - "properties": { - "action": "Install", - "libraries": [ - { - "properties": { - "type": "pypi", - "name": "requests", - "version": "2.31.0", - "remarks": "PyPi packages." - } - }, - { - "properties": { - "type": "maven", - "groupId": "org.apache.flink", - "name": "flink-connector-kafka", - "version": "3.0.2-1.18", - "remarks": "Maven packages." - } - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterPoolVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterPoolVersions.json deleted file mode 100644 index 23debec4f8d9..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterPoolVersions.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "location": "westus2", - "api-version": "2024-05-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.0", - "name": "1.0", - "properties": { - "clusterPoolVersion": "1.0", - "aksVersion": "1.24", - "isPreview": false - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.1", - "name": "1.1", - "properties": { - "clusterPoolVersion": "1.1", - "aksVersion": "1.25", - "isPreview": false - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterpoolversions/1.2", - "name": "1.2", - "properties": { - "clusterPoolVersion": "1.2", - "aksVersion": "1.26", - "isPreview": true - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterVersions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterVersions.json deleted file mode 100644 index 8da23c3856af..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListAvailableClusterVersions.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "location": "westus2", - "api-version": "2024-05-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/flink_1.16.0-1.0.4", - "name": "flink_1.16.0-1.0.4", - "properties": { - "clusterType": "Flink", - "clusterVersion": "1.0.4", - "ossVersion": "1.16.0", - "clusterPoolVersion": "1.0", - "isPreview": false, - "components": [ - { - "name": "TaskManager", - "version": "1.16.0" - }, - { - "name": "JobManager", - "version": "1.16.0" - } - ] - } - }, - { - "id": "/subscriptions/subid/providers/Microsoft.HDInsight/locations/westus2/availableclusterversions/spark_3.3.1-1.0.4", - "name": "spark_3.3.1-1.0.4", - "properties": { - "clusterType": "Spark", - "clusterVersion": "1.0.4", - "ossVersion": "3.3.1", - "clusterPoolVersion": "1.0", - "isPreview": false, - "components": [ - { - "name": "Hadoop", - "version": "3.2.3" - }, - { - "name": "Hive", - "version": "3.1.4" - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterAvailableUpgrades.json deleted file mode 100644 index dbbc4bb14708..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterAvailableUpgrades.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/availableUpgrades/AKSPatchUpgrade", - "properties": { - "upgradeType": "AKSPatchUpgrade", - "currentVersion": "1.26.3", - "currentVersionStatus": "Supported", - "latestVersion": "1.26.6" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/availableUpgrades/hotfix1", - "properties": { - "description": "Hotfix for historyserver on version 1.16.0-1.0.6.2", - "sourceClusterVersion": "1.0.6", - "sourceOssVersion": "1.16.0", - "sourceBuildNumber": "2", - "targetClusterVersion": "1.0.6", - "targetOssVersion": "1.16.0", - "targetBuildNumber": "3", - "componentName": "historyserver", - "severity": "low", - "upgradeType": "HotfixUpgrade", - "extendedProperties": "", - "createdTime": "2023-03-29T14:13:12Z" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterInstanceViews.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterInstanceViews.json deleted file mode 100644 index f5f2eb91718b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterInstanceViews.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2024-05-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "default", - "properties": { - "status": { - "ready": "True", - "reason": "", - "message": "" - }, - "serviceStatuses": [ - { - "kind": "ZooKeeper", - "ready": "true", - "message": "" - } - ] - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterJobs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterJobs.json deleted file mode 100644 index 4494f1ddbf8b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterJobs.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourcegroup", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterPool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/jobs/flink-job-1", - "properties": { - "runId": "job-15a-4322-b32c-ea541845e911", - "jobType": "FlinkJob", - "jobName": "flink-job-1", - "jobJarDirectory": "jobJarDirectory1", - "jarName": "job.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.ExampleJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "savepoint-directory" - }, - "jobId": "362b911137dfefc2e55784666f4d4253", - "status": "RUNNING", - "jobOutput": "job-output", - "actionResult": "SUCCESS" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolAvailableUpgrades.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolAvailableUpgrades.json deleted file mode 100644 index 132617f0d41e..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolAvailableUpgrades.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/availableUpgrades/AKSPatchUpgrade", - "properties": { - "upgradeType": "AKSPatchUpgrade", - "currentVersion": "1.26.3", - "currentVersionStatus": "Deprecated", - "latestVersion": "1.26.6" - } - }, - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/availableUpgrades/NodeOsUpgrade", - "properties": { - "upgradeType": "NodeOsUpgrade", - "latestVersion": "AKSCBLMariner-V2gen2-202310.09.0" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolUpgradeHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolUpgradeHistory.json deleted file mode 100644 index 5d5e3eeb615f..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolUpgradeHistory.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/10e32bab-26da-4cc4-a441-52b318f824e6/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterpools/clusterpool1/upgradeHistories/nodeosupgrade1", - "name": "nodeosupgrade1", - "properties": { - "upgradeType": "NodeOsUpgrade", - "utcTime": "01/18/2024 03:18:47 AM", - "newNodeOs": "1.2.2", - "upgradeResult": "Succeed" - } - }, - { - "id": "/subscriptions/10e32bab-26da-4cc4-a441-52b318f824e6/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterpools/clusterpool1/upgradeHistories/akspatchupgrade1", - "name": "akspatchupgrade1", - "properties": { - "upgradeType": "AKSPatchUpgrade", - "utcTime": "01/18/2024 03:18:38 AM", - "upgradeClusterPool": false, - "upgradeAllClusterNodes": true, - "originalVersion": null, - "newVersion": "1.1.1", - "upgradeResult": "Succeed" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPools.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPools.json deleted file mode 100644 index 595e84ceba93..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPools.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourcegroup", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2024-05-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3 - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolsSubscription.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolsSubscription.json deleted file mode 100644 index 05077a9e90d1..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterPoolsSubscription.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2024-05-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterServiceConfigs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterServiceConfigs.json deleted file mode 100644 index 8abca07ba7d3..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterServiceConfigs.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2024-05-01-preview", - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "clusterPoolName": "clusterPool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "serviceName": "hadoop-service", - "componentName": "hadoop-component", - "fileName": "capacity-scheduler.xml", - "content": "" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterUpgradeHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterUpgradeHistory.json deleted file mode 100644 index 572e073a0557..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClusterUpgradeHistory.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1/upgradeHistories/upgradeDefinitionCR1", - "name": "upgradeDefinitionCR1", - "properties": { - "upgradeType": "HotfixUpgrade", - "utcTime": "01/18/2024 03:18:38 AM", - "sourceOssVersion": "2.4.1", - "sourceClusterVersion": "1.0.1", - "sourceBuildNumber": "1", - "targetOssVersion": "2.4.1", - "targetClusterVersion": "1.0.1", - "targetBuildNumber": "2", - "componentName": "Zookeeper", - "severity": "low", - "upgradeResult": "Succeed" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClustersByClusterPoolName.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClustersByClusterPoolName.json deleted file mode 100644 index c1f1c6badd2b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListClustersByClusterPoolName.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "components": [ - { - "name": "Trino", - "version": "410" - }, - { - "name": "Hive metastore", - "version": "3.1.2" - } - ], - "identityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "msiClientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "msiObjectId": "40491351-c240-4042-91e0-f644a1d2b441" - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - } - } - }, - "location": "West US 2", - "tags": { - "department": "MightyMight", - "company": "Contoso" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListPredefinedClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListPredefinedClusterLibraries.json deleted file mode 100644 index 35dfb72a8f94..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListPredefinedClusterLibraries.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourceGroup", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterPool", - "clusterName": "cluster", - "$category": "predefined" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourceGroup/providers/Microsoft.HDInsight/clusterPools/clusterPool/clusters/cluster/libraries/pyspark", - "properties": { - "type": "pypi", - "name": "pyspark", - "version": "3.5.0" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourceGroup/providers/Microsoft.HDInsight/clusterPools/clusterPool/clusters/cluster/libraries/spark-sql", - "properties": { - "type": "maven", - "groupId": "org.apache.spark", - "name": "spark-sql", - "version": "3.5.0_2.12" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListUserCustomClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListUserCustomClusterLibraries.json deleted file mode 100644 index 39ca335d1fcf..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ListUserCustomClusterLibraries.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "hiloResourceGroup", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterPool", - "clusterName": "cluster", - "$category": "custom" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourceGroup/providers/Microsoft.HDInsight/clusterPools/clusterPool/clusters/cluster/libraries/requests", - "properties": { - "type": "pypi", - "name": "requests", - "version": "2.31.0", - "remarks": "PyPi packages.", - "timestamp": "2020-01-01T00:00:00.000Z", - "status": "INSTALLED", - "message": "" - } - }, - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourceGroup/providers/Microsoft.HDInsight/clusterPools/clusterPool/clusters/cluster/libraries/flink-connector-kafka", - "properties": { - "type": "maven", - "groupId": "org.apache.flink", - "name": "flink-connector-kafka", - "version": "3.0.2-1.18", - "remarks": "Maven packages.", - "timestamp": "2020-01-01T00:00:00.000Z", - "status": "INSTALLING", - "message": "" - } - } - ] - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/LocationsNameAvailability.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/LocationsNameAvailability.json deleted file mode 100644 index fcc1bb8d6f7d..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/LocationsNameAvailability.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "api-version": "2024-05-01-preview", - "location": "southeastasia", - "NameAvailabilityParameters": { - "name": "contosemember1", - "type": "Microsoft.HDInsight/clusterPools/clusters" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "nameAvailable": false, - "reason": "AlreadyExists" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchCluster.json deleted file mode 100644 index 48e3ae7846ed..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchCluster.json +++ /dev/null @@ -1,477 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterPatchRequest": { - "properties": { - "clusterProfile": { - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "sshProfile": { - "count": 2 - }, - "authorizationProfile": { - "userIds": [ - "Testuser1", - "Testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2024-05-01-preview" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "serviceConfigsProfiles": [ - { - "serviceName": "TestService1", - "configs": [ - { - "component": "TestComp1", - "files": [ - { - "fileName": "TestFile1", - "values": { - "Test.config.1": "1", - "Test.config.2": "2" - } - }, - { - "fileName": "TestFile2", - "values": { - "Test.config.3": "3", - "Test.config.4": "4" - } - } - ] - }, - { - "component": "TestComp2", - "files": [ - { - "fileName": "TestFile3", - "content": "TestContent", - "path": "TestPath" - }, - { - "fileName": "TestFile4", - "values": { - "Test.config.7": "7", - "Test.config.8": "8" - } - } - ] - } - ] - }, - { - "serviceName": "TestService2", - "configs": [ - { - "component": "TestComp3", - "files": [ - { - "fileName": "TestFile5", - "values": { - "Test.config.9": "9" - } - } - ] - } - ] - } - ], - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": -1, - "scheduleBasedConfig": { - "defaultCount": 3, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday, Tuesday, Wednesday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 3 - } - ] - } - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchClusterPool.json deleted file mode 100644 index 5d2e98cf1140..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchClusterPool.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterPoolTags": { - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "responses": { - "200": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/pathToOperationResult" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2", - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchRangerCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchRangerCluster.json deleted file mode 100644 index 7e143d64e6f7..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/PatchRangerCluster.json +++ /dev/null @@ -1,251 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterPatchRequest": { - "properties": { - "clusterProfile": { - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "ranger", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - }, - "202": { - "headers": { - "azure-asyncoperation": "http://management.azure.com/providers/Microsoft.HDInsight/locations/EASTUS/operationStatuses/676c3c86-188d-4591-9b55-c4298b4a1279?api-version=2024-05-01-preview" - }, - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "location": "West US 2", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "ranger", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "head", - "vmSize": "Standard_D3_v2", - "count": 2 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "logAnalyticsProfile": { - "enabled": true, - "applicationLogs": { - "stdErrorEnabled": true, - "stdOutEnabled": true - }, - "metricsEnabled": true - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - } - }, - "rangerProfile": { - "rangerAdmin": { - "admins": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ], - "database": { - "host": "testsqlserver.database.windows.net", - "name": "testdb", - "passwordSecretRef": "https://testkv.vault.azure.net/secrets/mysecret/5df6584d9c25418c8d900240aa6c3452", - "username": "admin" - } - }, - "rangerAudit": { - "storageAccount": "https://teststorage.blob.core.windows.net/testblob" - }, - "rangerUsersync": { - "enabled": true, - "groups": [ - "0a53828f-36c9-44c3-be3d-99a7fce977ad", - "13be6971-79db-4f33-9d41-b25589ca25ac" - ], - "mode": "automatic", - "users": [ - "testuser1@contoso.com", - "testuser2@contoso.com" - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "tags": { - "tag1": "value1", - "tag2": "value2" - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ResizeCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ResizeCluster.json deleted file mode 100644 index 3f2788c9a799..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/ResizeCluster.json +++ /dev/null @@ -1,154 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterResizeRequest": { - "location": "West US 2", - "properties": { - "targetWorkerNodeCount": 5 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "Trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "Head", - "vmSize": "Standard_E8as_v5", - "count": 2 - }, - { - "type": "Worker", - "vmSize": "Standard_E8as_v5", - "count": 5 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.6", - "ossVersion": "0.410.0", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2024-05-01-preview" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/RunClusterJob.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/RunClusterJob.json deleted file mode 100644 index 1ce2c8ce6d7c..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/RunClusterJob.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterJob": { - "properties": { - "jobType": "FlinkJob", - "jobName": "flink-job-name", - "action": "START", - "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", - "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" - } - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "properties": { - "runId": "job-15a-4322-b32c-ea541845e911", - "jobType": "FlinkJob", - "jobName": "flink-job-name", - "action": "START", - "jobJarDirectory": "abfs://flinkjob@hilosa.dfs.core.windows.net/jars", - "jarName": "flink-sleep-job-0.0.1-SNAPSHOT.jar", - "entryClass": "com.microsoft.hilo.flink.job.streaming.SleepJob", - "flinkConfiguration": { - "parallelism": "1", - "savepoint.directory": "abfs://flinkjob@hilosa.dfs.core.windows.net/savepoint" - } - } - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UninstallExistingClusterLibraries.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UninstallExistingClusterLibraries.json deleted file mode 100644 index bc475ba56dbc..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UninstallExistingClusterLibraries.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "hiloResourceGroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterPool", - "clusterName": "cluster", - "operation": { - "properties": { - "action": "Uninstall", - "libraries": [ - { - "properties": { - "type": "pypi", - "name": "tensorflow" - } - }, - { - "properties": { - "type": "maven", - "groupId": "org.apache.flink", - "name": "flink-connector-hudi" - } - } - ] - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForCluster.json deleted file mode 100644 index 62f502387a75..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForCluster.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterUpgradeRequest": { - "properties": { - "upgradeType": "AKSPatchUpgrade" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json deleted file mode 100644 index 3bce9800f950..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeAKSPatchVersionForClusterPool.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPoolUpgradeRequest": { - "properties": { - "upgradeType": "AKSPatchUpgrade", - "upgradeClusterPool": true, - "upgradeAllClusterNodes": false - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeHotfixForCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeHotfixForCluster.json deleted file mode 100644 index 3cb92b9aec2f..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeHotfixForCluster.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "clusterName": "cluster1", - "ClusterUpgradeRequest": { - "properties": { - "upgradeType": "HotfixUpgrade", - "targetOssVersion": "1.16.0", - "targetClusterVersion": "1.0.6", - "targetBuildNumber": "3", - "componentName": "historyserver" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1/clusters/cluster1", - "name": "cluster1", - "type": "Microsoft.HDInsight/clusterPools/clusters", - "properties": { - "provisioningState": "Succeeded", - "clusterType": "trino", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "computeProfile": { - "nodes": [ - { - "type": "worker", - "vmSize": "Standard_D3_v2", - "count": 3 - } - ], - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "clusterProfile": { - "clusterVersion": "1.0.1", - "ossVersion": "2.4.1", - "managedIdentityProfile": { - "identityList": [ - { - "type": "cluster", - "resourceId": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-msi", - "clientId": "de91f1d8-767f-460a-ac11-3cf103f74b34", - "objectId": "40491351-c240-4042-91e0-f644a1d2b441" - } - ] - }, - "authorizationProfile": { - "userIds": [ - "testuser1", - "testuser2" - ] - }, - "connectivityProfile": { - "web": { - "fqdn": "cluster1.clusterpool1.westus2.projecthilo.net" - }, - "ssh": [ - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-0" - }, - { - "endpoint": "cluster1.clusterpool1.westus2.projecthilo.net/ssh/host/sshnode-1" - } - ] - }, - "trinoProfile": {}, - "sshProfile": { - "count": 2, - "podPrefix": "sshnode", - "vmSize": "Standard_D3_v2" - }, - "autoscaleProfile": { - "enabled": true, - "autoscaleType": "ScheduleBased", - "gracefulDecommissionTimeout": 3600, - "scheduleBasedConfig": { - "defaultCount": 10, - "timeZone": "Cen. Australia Standard Time", - "schedules": [ - { - "days": [ - "Monday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 20 - }, - { - "days": [ - "Sunday" - ], - "startTime": "00:00", - "endTime": "12:00", - "count": 25 - } - ] - }, - "loadBasedConfig": { - "minNodes": 10, - "maxNodes": 20, - "pollInterval": 60, - "cooldownPeriod": 300, - "scalingRules": [ - { - "actionType": "scaleup", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "greaterThan", - "threshold": 90 - } - }, - { - "actionType": "scaledown", - "evaluationCount": 3, - "scalingMetric": "cpu", - "comparisonRule": { - "operator": "lessThan", - "threshold": 20 - } - } - ] - } - } - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeNodeOsForClusterPool.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeNodeOsForClusterPool.json deleted file mode 100644 index ab008abe4317..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/examples/UpgradeNodeOsForClusterPool.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "subscriptionId": "10e32bab-26da-4cc4-a441-52b318f824e6", - "resourceGroupName": "hiloResourcegroup", - "api-version": "2024-05-01-preview", - "clusterPoolName": "clusterpool1", - "ClusterPoolUpgradeRequest": { - "properties": { - "upgradeType": "NodeOsUpgrade" - } - } - }, - "responses": { - "202": { - "headers": { - "location": "http://azure.async.operation/status" - } - }, - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/hiloResourcegroup/providers/Microsoft.HDInsight/clusterPools/clusterpool1", - "name": "clusterpool1", - "type": "Microsoft.HDInsight/clusterPools", - "properties": { - "provisioningState": "Succeeded", - "deploymentId": "45cd32aead6e4a91b079a0cdbfac8c36", - "managedResourceGroupName": "hdi-45cd32aead6e4a91b079a0cdbfac8c36", - "clusterPoolProfile": { - "clusterPoolVersion": "1.2" - }, - "computeProfile": { - "vmSize": "Standard_D3_v2", - "count": 3, - "availabilityZones": [ - "1", - "2", - "3" - ] - }, - "aksClusterProfile": { - "aksVersion": "1.24", - "aksClusterAgentPoolIdentityProfile": { - "msiResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ManagedIdentity/userAssignedIdentities/clusterpool1-agentpool", - "msiClientId": "a89fb478-2a84-4d9b-8f18-3e8c4d1db3eb", - "msiObjectId": "dc7ef861-8b55-4ffb-9003-20885cd895a9" - }, - "aksClusterResourceId": "/subscriptions/subid/resourceGroups/hdi-45cd32aead6e4a91b079a0cdbfac8c36/providers/Microsoft.ContainerService/managedClusters/clusterpool1" - } - }, - "systemData": { - "createdBy": "string", - "createdByType": "User", - "createdAt": "2020-02-03T01:01:01.1075056Z", - "lastModifiedBy": "string", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" - }, - "location": "West US 2" - } - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/hdinsight.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/hdinsight.json deleted file mode 100644 index f4b28c365114..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/preview/2024-05-01-preview/hdinsight.json +++ /dev/null @@ -1,5190 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsight on AKS Management Client", - "description": "The HDInsight on AKS Management Client.", - "version": "2024-05-01-preview" - }, - "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.HDInsight/clusterpools/{clusterPoolName}": { - "get": { - "description": "Gets a cluster pool.", - "operationId": "ClusterPools_Get", - "x-ms-examples": { - "ClusterPoolGet": { - "$ref": "./examples/GetClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusterpool details.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "description": "Creates or updates a cluster pool.", - "operationId": "ClusterPools_CreateOrUpdate", - "x-ms-examples": { - "ClusterPoolPut": { - "$ref": "./examples/CreateClusterPool.json" - }, - "ClusterPoolPutWithPrivateAks": { - "$ref": "./examples/CreateClusterPoolWithPrivateAks.json" - }, - "ClusterPoolPutWithUDRAks": { - "$ref": "./examples/CreateClusterPoolWithUDRAks.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "ClusterPool", - "description": "The Cluster Pool to create.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPool" - } - } - ], - "responses": { - "201": { - "description": "ClusterPool is created.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "200": { - "description": "Update successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing Cluster Pool Tags.", - "operationId": "ClusterPools_UpdateTags", - "x-ms-examples": { - "ClusterPoolsPatchTags": { - "$ref": "./examples/PatchClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "clusterPoolTags", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/TagsObject" - }, - "description": "Parameters supplied to update tags." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "description": "Deletes a Cluster Pool.", - "operationId": "ClusterPools_Delete", - "x-ms-examples": { - "ClusterPoolDelete": { - "$ref": "./examples/DeleteClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Accepted response definition.", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No content - The Cluster Pool doesn't exist." - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusterpools": { - "get": { - "operationId": "ClusterPools_ListBySubscription", - "x-ms-examples": { - "ClusterPoolsListBySubscription": { - "$ref": "./examples/ListClusterPoolsSubscription.json" - } - }, - "description": "Gets the list of Cluster Pools within a Subscription.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Pools successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools": { - "get": { - "operationId": "ClusterPools_ListByResourceGroup", - "x-ms-examples": { - "ClusterPoolsListByResourceGroup": { - "$ref": "./examples/ListClusterPools.json" - } - }, - "description": "Lists the HDInsight cluster pools under a resource group.", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Pools successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/upgrade": { - "post": { - "description": "Upgrade a cluster pool.", - "operationId": "ClusterPools_Upgrade", - "x-ms-examples": { - "ClusterPoolsUpgradeAKSPatchVersion": { - "$ref": "./examples/UpgradeAKSPatchVersionForClusterPool.json" - }, - "ClusterPoolsUpgradeNodeOs": { - "$ref": "./examples/UpgradeNodeOsForClusterPool.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "name": "ClusterPoolUpgradeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPoolUpgrade" - }, - "description": "Upgrade a cluster pool." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterPool" - } - }, - "202": { - "description": "Cluster Pool Upgrade request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/availableUpgrades": { - "get": { - "description": "List a cluster pool available upgrade.", - "operationId": "ClusterPoolAvailableUpgrades_List", - "x-ms-examples": { - "GetClusterPoolAvailableUpgrade": { - "$ref": "./examples/ListClusterPoolAvailableUpgrades.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusterpool Available Upgrade details.", - "schema": { - "$ref": "#/definitions/ClusterPoolAvailableUpgradeList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/upgradeHistories": { - "get": { - "description": "Returns a list of upgrade history.", - "operationId": "ClusterPoolUpgradeHistories_List", - "x-ms-examples": { - "ClusterPoolUpgradeHistoriesListResult": { - "$ref": "./examples/ListClusterPoolUpgradeHistory.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolUpgradeHistoryListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters": { - "get": { - "operationId": "Clusters_ListByClusterPoolName", - "description": "Lists the HDInsight cluster pools under a resource group.", - "x-ms-examples": { - "HDInsightClustersListByClusterPoolName": { - "$ref": "./examples/ListClustersByClusterPoolName.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - } - ], - "responses": { - "200": { - "description": "Clusters successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/upgrade": { - "post": { - "description": "Upgrade a cluster.", - "operationId": "Clusters_Upgrade", - "x-ms-examples": { - "ClustersUpgradeAKSPatchVersion": { - "$ref": "./examples/UpgradeAKSPatchVersionForCluster.json" - }, - "ClustersUpgradeHotfix": { - "$ref": "./examples/UpgradeHotfixForCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterUpgradeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpgrade" - }, - "description": "Upgrade a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Cluster Upgrade request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/availableUpgrades": { - "get": { - "description": "List a cluster available upgrade.", - "operationId": "ClusterAvailableUpgrades_List", - "x-ms-examples": { - "GetClusterAvailableUpgrade": { - "$ref": "./examples/ListClusterAvailableUpgrades.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Cluster Available Upgrade details.", - "schema": { - "$ref": "#/definitions/ClusterAvailableUpgradeList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/upgradeHistories": { - "get": { - "description": "Returns a list of upgrade history.", - "operationId": "ClusterUpgradeHistories_List", - "x-ms-examples": { - "ClusterUpgradeHistoriesListResult": { - "$ref": "./examples/ListClusterUpgradeHistory.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterUpgradeHistoryListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/rollback": { - "post": { - "description": "Manual rollback upgrade for a cluster.", - "operationId": "Clusters_UpgradeManualRollback", - "x-ms-examples": { - "ClusterUpgradeRollback": { - "$ref": "./examples/ClusterUpgradeRollback.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterRollbackUpgradeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterUpgradeRollback" - }, - "description": "Manual rollback upgrade for a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Cluster Manual Rollback Upgrade request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the rollback operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/resize": { - "post": { - "description": "Resize an existing Cluster.", - "operationId": "Clusters_Resize", - "x-ms-examples": { - "HDInsightClusterResize": { - "$ref": "./examples/ResizeCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterResizeRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterResizeData" - }, - "description": "Resize a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Cluster resize request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}": { - "get": { - "operationId": "Clusters_Get", - "description": "Gets a HDInsight cluster.", - "x-ms-examples": { - "HDInsightClusterGet": { - "$ref": "./examples/GetCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Cluster details.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - }, - "put": { - "operationId": "Clusters_Create", - "description": "Creates a cluster.", - "x-ms-examples": { - "HDInsightClusterPut": { - "$ref": "./examples/CreateAutoscaleCluster.json" - }, - "HDInsightSparkClusterPut": { - "$ref": "./examples/CreateSparkCluster.json" - }, - "HDInsightSparkClusterPutWithInternalIngress": { - "$ref": "./examples/CreateSparkClusterWithInternalIngress.json" - }, - "HDInsightRangerClusterPut": { - "$ref": "./examples/CreateRangerCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "HDInsightCluster", - "in": "body", - "required": true, - "description": "The cluster to create.", - "schema": { - "$ref": "#/definitions/Cluster" - } - } - ], - "responses": { - "201": { - "description": "Cluster is created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "200": { - "description": "Update successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "patch": { - "description": "Updates an existing Cluster.", - "operationId": "Clusters_Update", - "x-ms-examples": { - "HDInsightClustersPatchTags": { - "$ref": "./examples/PatchCluster.json" - }, - "HDInsightRangerClusterPatchTags": { - "$ref": "./examples/PatchRangerCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterPatchRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterPatch" - }, - "description": "Patch a cluster." - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Accepted.", - "headers": { - "Location": { - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "operationId": "Clusters_Delete", - "description": "Deletes a cluster.", - "x-ms-examples": { - "HDInsightClustersDelete": { - "$ref": "./examples/DeleteCluster.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "Successful." - }, - "202": { - "description": "Cluster delete request accepted.", - "headers": { - "Location": { - "type": "string" - } - } - }, - "204": { - "description": "No content - The Cluster doesn't exist." - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/runJob": { - "post": { - "operationId": "ClusterJobs_RunJob", - "description": "Operations on jobs of HDInsight on AKS cluster.", - "x-ms-examples": { - "RunClusterJob": { - "$ref": "./examples/RunClusterJob.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "ClusterJob", - "description": "The Cluster job.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterJob" - } - } - ], - "responses": { - "200": { - "description": "Successful.", - "schema": { - "$ref": "#/definitions/ClusterJob" - } - }, - "202": { - "description": "Run cluster job action request accepted.", - "headers": { - "location": { - "type": "string", - "description": "URL to get the status of the resize operation." - } - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/jobs": { - "get": { - "operationId": "ClusterJobs_List", - "description": "Get jobs of HDInsight on AKS cluster.", - "x-ms-examples": { - "ListClusterJobs": { - "$ref": "./examples/ListClusterJobs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The system query option to filter job returned in the response. Allowed value is 'jobName eq {jobName}' or 'jarName eq {jarName}'." - } - ], - "responses": { - "200": { - "description": "Cluster job details.", - "schema": { - "$ref": "#/definitions/ClusterJobList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/serviceConfigs": { - "get": { - "operationId": "Clusters_ListServiceConfigs", - "description": "Lists the config dump of all services running in cluster.", - "x-ms-examples": { - "HDInsightClusterGetServiceConfigs": { - "$ref": "./examples/ListClusterServiceConfigs.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceConfigListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability": { - "post": { - "description": "Check the availability of the resource name.", - "operationId": "Locations_CheckNameAvailability", - "x-ms-examples": { - "LocationsNameAvailability": { - "$ref": "./examples/LocationsNameAvailability.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "name": "NameAvailabilityParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/NameAvailabilityParameters" - }, - "description": "The name and type of the resource." - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/NameAvailabilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews": { - "get": { - "operationId": "Clusters_ListInstanceViews", - "x-ms-examples": { - "HDInsightClusterGetInstanceViews": { - "$ref": "./examples/ListClusterInstanceViews.json" - } - }, - "description": "Lists the lists of instance views", - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClusterInstanceViewsResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/instanceViews/default": { - "get": { - "operationId": "Clusters_GetInstanceView", - "description": "Gets the status of a cluster instance.", - "x-ms-examples": { - "HDInsightClusterGetInstanceView": { - "$ref": "./examples/GetClusterInstanceView.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ClusterInstanceViewResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.HDInsight/operations": { - "get": { - "description": "Returns list of operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "ListOperations": { - "$ref": "./examples/GetOperations.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Operation details.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterPoolVersions": { - "get": { - "description": "Returns a list of available cluster pool versions.", - "operationId": "AvailableClusterPoolVersions_ListByLocation", - "x-ms-examples": { - "ClusterPoolVersionListResult": { - "$ref": "./examples/ListAvailableClusterPoolVersions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster pool versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterPoolVersionsListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/availableClusterVersions": { - "get": { - "description": "Returns a list of available cluster versions.", - "operationId": "AvailableClusterVersions_ListByLocation", - "x-ms-examples": { - "ClusterVersionListResult": { - "$ref": "./examples/ListAvailableClusterVersions.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Available cluster versions successfully returned.", - "schema": { - "$ref": "#/definitions/ClusterVersionsListResult" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/libraries": { - "get": { - "operationId": "ClusterLibraries_List", - "description": "Get all libraries of HDInsight on AKS cluster.", - "x-ms-examples": { - "ListUserCustomClusterLibraries": { - "$ref": "./examples/ListUserCustomClusterLibraries.json" - }, - "ListPredefinedClusterLibraries": { - "$ref": "./examples/ListPredefinedClusterLibraries.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "$category", - "in": "query", - "required": true, - "enum": [ - "custom", - "predefined" - ], - "type": "string", - "x-ms-enum": { - "name": "$category", - "modelAsString": true - }, - "description": "The system query option to filter libraries returned in the response. Allowed value is 'custom' or 'predefined'." - } - ], - "responses": { - "200": { - "description": "Collection of libraries in the cluster.", - "schema": { - "$ref": "#/definitions/ClusterLibraryList" - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters/{clusterName}/manageLibraries": { - "post": { - "operationId": "ClusterLibraries_ManageLibraries", - "description": "Library management operations on HDInsight on AKS cluster.", - "x-ms-examples": { - "InstallNewClusterLibraries": { - "$ref": "./examples/InstallNewClusterLibraries.json" - }, - "UninstallExistingClusterLibraries": { - "$ref": "./examples/UninstallExistingClusterLibraries.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ClusterPoolNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "name": "operation", - "description": "The library management operation.", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterLibraryManagementOperation" - } - } - ], - "responses": { - "202": { - "description": "Cluster library management operation request accepted.", - "headers": { - "Location": { - "type": "string", - "description": "URL to get the status of the library management operation." - } - } - }, - "default": { - "description": "Error Response describing why the operation failed.", - "schema": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - } - }, - "definitions": { - "AvailabilityZones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of Availability zones to use for AKS VMSS nodes." - }, - "ClusterPoolListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ClusterPool" - }, - "description": "The list of cluster pools." - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - }, - "description": "The list cluster pools operation response." - }, - "ClusterPoolProfile": { - "type": "object", - "description": "Cluster pool profile.", - "required": [ - "clusterPoolVersion" - ], - "properties": { - "clusterPoolVersion": { - "$ref": "#/definitions/ClusterPoolVersionPattern" - }, - "publicIpTag": { - "description": "Gets or sets the IP tag for the public IPs created along with the HDInsightOnAks ClusterPools and Clusters. ", - "$ref": "#/definitions/IpTag" - } - } - }, - "IpTag": { - "type": "object", - "required": [ - "ipTagType", - "tag" - ], - "properties": { - "ipTagType": { - "type": "string", - "description": "Gets or sets the ipTag type: Example FirstPartyUsage." - }, - "tag": { - "type": "string", - "description": "Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc" - } - }, - "description": "Contains the IpTag associated with the public IP address" - }, - "ClusterPoolComputeProfile": { - "type": "object", - "description": "Cluster pool compute profile.", - "required": [ - "vmSize" - ], - "properties": { - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - }, - "count": { - "description": "The number of virtual machines.", - "type": "integer", - "format": "int32", - "readOnly": true - }, - "availabilityZones": { - "$ref": "#/definitions/AvailabilityZones" - } - } - }, - "ClusterPoolNetworkProfile": { - "type": "object", - "description": "Cluster pool networking configuration.", - "required": [ - "subnetId" - ], - "properties": { - "subnetId": { - "type": "string", - "description": "Cluster pool subnet resource id.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.Network/virtualNetworks/subnets" - } - ] - } - }, - "outboundType": { - "type": "string", - "enum": [ - "loadBalancer", - "userDefinedRouting" - ], - "x-ms-enum": { - "name": "outboundType", - "modelAsString": true, - "values": [ - { - "value": "loadBalancer", - "description": "The load balancer is used for egress through an AKS assigned public IP. This supports Kubernetes services of type 'loadBalancer'. " - }, - { - "value": "userDefinedRouting", - "description": "Egress paths must be defined by the user. This is an advanced scenario and requires proper network configuration. " - } - ] - }, - "default": "loadBalancer", - "title": "The outbound (egress) routing method.", - "description": "This can only be set at cluster pool creation time and cannot be changed later. " - }, - "enablePrivateApiServer": { - "type": "boolean", - "description": "ClusterPool is based on AKS cluster. AKS cluster exposes the API server to public internet by default. If you set this property to true, a private AKS cluster will be created, and it will use private apiserver, which is not exposed to public internet.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "apiServerAuthorizedIpRanges": { - "type": "array", - "items": { - "type": "string" - }, - "title": "The IP ranges authorized to access the AKS API server.", - "description": "IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with private AKS clusters. So you cannot set enablePrivateApiServer to true and apiServerAuthorizedIpRanges at the same time. Currently, this property is not supported and please don't use it." - } - } - }, - "ClusterPoolLogAnalyticsProfile": { - "type": "object", - "description": "Cluster pool log analytics profile used to enable or disable OMS agent for AKS cluster.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "True if log analytics is enabled for cluster pool, otherwise false." - }, - "workspaceId": { - "type": "string", - "description": "Log analytics workspace to associate with the OMS agent.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.OperationalInsights/workspaces" - } - ] - } - } - } - }, - "AksClusterProfile": { - "type": "object", - "description": "Properties of the cluster pool underlying AKS cluster.", - "properties": { - "aksClusterResourceId": { - "type": "string", - "description": "ARM Resource ID of the AKS cluster", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ContainerService/managedClusters" - } - ] - } - }, - "aksClusterAgentPoolIdentityProfile": { - "description": "Identity properties of the AKS cluster agentpool MSI", - "allOf": [ - { - "$ref": "#/definitions/IdentityProfile" - } - ] - }, - "aksVersion": { - "type": "string", - "description": "AKS control plane and default node pool version of this ClusterPool", - "readOnly": true - } - } - }, - "ClusterPoolResourceProperties": { - "type": "object", - "required": [ - "computeProfile" - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "type": "string", - "enum": [ - "Accepted", - "Succeeded", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "readOnly": true - }, - "deploymentId": { - "type": "string", - "description": "A unique id generated by the RP to identify the resource.", - "example": "45cd32aead6e4a91b079a0cdbfac8c36", - "readOnly": true - }, - "managedResourceGroupName": { - "type": "string", - "description": "A resource group created by RP, to hold the resources created by RP on-behalf of customers. It will also be used to generate aksManagedResourceGroupName by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}. Please make sure it meets resource group name restriction.", - "minLength": 1, - "maxLength": 40, - "example": "hdi-45cd32aead6e4a91b079a0cdbfac8c36" - }, - "aksManagedResourceGroupName": { - "type": "string", - "description": "A resource group created by AKS, to hold the infrastructure resources created by AKS on-behalf of customers. It is generated by cluster pool name and managed resource group name by pattern: MC_{managedResourceGroupName}_{clusterPoolName}_{region}", - "readOnly": true, - "example": "MC_hdi-45cd32aead6e4a91b079a0cdbfac8c36_test-pool_eastus" - }, - "clusterPoolProfile": { - "description": "CLuster pool profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolProfile" - } - ] - }, - "computeProfile": { - "description": "CLuster pool compute profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolComputeProfile" - } - ] - }, - "aksClusterProfile": { - "description": "Properties of underlying AKS cluster.", - "readOnly": true, - "allOf": [ - { - "$ref": "#/definitions/AksClusterProfile" - } - ] - }, - "networkProfile": { - "description": "Cluster pool network profile.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolNetworkProfile" - } - ] - }, - "logAnalyticsProfile": { - "description": "Cluster pool log analytics profile to enable OMS agent for AKS cluster.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolLogAnalyticsProfile" - } - ] - }, - "status": { - "type": "string", - "description": "Business status of the resource.", - "example": "Running", - "readOnly": true - } - }, - "description": "Cluster pool resource properties." - }, - "ClusterPool": { - "type": "object", - "description": "Cluster pool.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster pool specific properties.", - "$ref": "#/definitions/ClusterPoolResourceProperties" - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "SystemData of cluster pool.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "TagsObject": { - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "description": "Tags object for patch operations." - }, - "ClusterListResult": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The list of clusters." - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - }, - "description": "The list cluster operation response." - }, - "ClusterLogAnalyticsProfile": { - "type": "object", - "description": "Cluster log analytics profile to enable or disable OMS agent for cluster.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "True if log analytics is enabled for the cluster, otherwise false." - }, - "applicationLogs": { - "$ref": "#/definitions/ClusterLogAnalyticsApplicationLogs" - }, - "metricsEnabled": { - "type": "boolean", - "description": "True if metrics are enabled, otherwise false." - } - } - }, - "ClusterLogAnalyticsApplicationLogs": { - "type": "object", - "description": "Collection of logs to be enabled or disabled for log analytics.", - "properties": { - "stdOutEnabled": { - "type": "boolean", - "description": "True if stdout is enabled, otherwise false." - }, - "stdErrorEnabled": { - "type": "boolean", - "description": "True if stderror is enabled, otherwise false." - } - } - }, - "ClusterPrometheusProfile": { - "type": "object", - "description": "Cluster Prometheus profile.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable Prometheus for cluster or not.", - "default": false - } - } - }, - "IdentityProfile": { - "type": "object", - "description": "Identity Profile with details of an MSI.", - "required": [ - "msiResourceId", - "msiClientId", - "msiObjectId" - ], - "properties": { - "msiResourceId": { - "type": "string", - "description": "ResourceId of the MSI.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ManagedIdentity/userAssignedIdentities" - } - ] - } - }, - "msiClientId": { - "type": "string", - "description": "ClientId of the MSI.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - }, - "msiObjectId": { - "type": "string", - "description": "ObjectId of the MSI.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - } - } - }, - "ManagedIdentityProfile": { - "type": "object", - "description": "The details of managed identity.", - "required": [ - "identityList" - ], - "properties": { - "identityList": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagedIdentitySpec" - }, - "description": "The list of managed identity.", - "x-ms-identifiers": [] - } - } - }, - "ManagedIdentitySpec": { - "type": "object", - "description": "The details of a managed identity.", - "required": [ - "type", - "resourceId", - "clientId", - "objectId" - ], - "properties": { - "type": { - "description": "The type of managed identity.", - "type": "string", - "enum": [ - "cluster", - "user", - "internal" - ], - "x-ms-enum": { - "name": "managedIdentityType", - "modelAsString": true - } - }, - "resourceId": { - "type": "string", - "description": "ResourceId of the managed identity.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.ManagedIdentity/userAssignedIdentities" - } - ] - } - }, - "clientId": { - "type": "string", - "description": "ClientId of the managed identity.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - }, - "objectId": { - "type": "string", - "description": "ObjectId of the managed identity.", - "pattern": "^[{(]?[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}[)}]?$" - } - } - }, - "AuthorizationProfile": { - "type": "object", - "description": "Authorization profile with details of AAD user Ids and group Ids authorized for data plane access.", - "properties": { - "userIds": { - "type": "array", - "description": "AAD user Ids authorized for data plane access.", - "items": { - "type": "string" - } - }, - "groupIds": { - "type": "array", - "description": "AAD group Ids authorized for data plane access.", - "items": { - "type": "string" - } - } - } - }, - "SecretReference": { - "type": "object", - "description": "Secret reference and corresponding properties of a key vault secret.", - "required": [ - "referenceName", - "type", - "keyVaultObjectName" - ], - "properties": { - "referenceName": { - "type": "string", - "description": "Reference name of the secret to be used in service configs." - }, - "type": { - "type": "string", - "description": "Type of key vault object: secret, key or certificate.", - "enum": [ - "Key", - "Secret", - "Certificate" - ], - "x-ms-enum": { - "name": "KeyVaultObjectType", - "modelAsString": true - } - }, - "version": { - "type": "string", - "description": "Version of the secret in key vault." - }, - "keyVaultObjectName": { - "type": "string", - "description": "Object identifier name of the secret in key vault.", - "pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,126}$" - } - } - }, - "SecretsProfile": { - "type": "object", - "description": "The cluster secret profile.", - "required": [ - "keyVaultResourceId" - ], - "properties": { - "keyVaultResourceId": { - "type": "string", - "description": "Name of the user Key Vault where all the cluster specific user secrets are stored.", - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.KeyVault/vaults" - } - ] - } - }, - "secrets": { - "type": "array", - "description": "Properties of Key Vault secret.", - "items": { - "$ref": "#/definitions/SecretReference" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterConfigFile": { - "type": "object", - "description": "Cluster configuration files.", - "required": [ - "fileName" - ], - "properties": { - "fileName": { - "type": "string", - "description": "Configuration file name.", - "example": "hive-conf.xml." - }, - "content": { - "type": "string", - "description": "Free form content of the entire configuration file." - }, - "encoding": { - "type": "string", - "description": "This property indicates if the content is encoded and is case-insensitive. Please set the value to base64 if the content is base64 encoded. Set it to none or skip it if the content is plain text.", - "enum": [ - "Base64", - "None" - ], - "x-ms-enum": { - "name": "ContentEncoding", - "modelAsString": true - } - }, - "path": { - "type": "string", - "description": "Path of the config file if content is specified." - }, - "values": { - "type": "object", - "description": "List of key value pairs\nwhere key represents a valid service configuration name and value represents the value of the config.", - "additionalProperties": { - "type": "string" - } - } - } - }, - "ClusterServiceConfig": { - "type": "object", - "description": "Cluster configs per component.", - "required": [ - "component", - "files" - ], - "properties": { - "component": { - "type": "string", - "description": "Name of the component the config files should apply to." - }, - "files": { - "type": "array", - "description": "List of Config Files.", - "items": { - "$ref": "#/definitions/ClusterConfigFile" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterServiceConfigsProfile": { - "type": "object", - "description": "Cluster service configs.", - "required": [ - "serviceName", - "configs" - ], - "properties": { - "serviceName": { - "type": "string", - "description": "Name of the service the configurations should apply to." - }, - "configs": { - "type": "array", - "description": "List of service configs.", - "items": { - "$ref": "#/definitions/ClusterServiceConfig" - }, - "x-ms-identifiers": [] - } - } - }, - "ConnectivityProfile": { - "type": "object", - "description": "Cluster connectivity profile.", - "required": [ - "web" - ], - "properties": { - "web": { - "description": "Web connectivity endpoint details.", - "allOf": [ - { - "$ref": "#/definitions/WebConnectivityEndpoint" - } - ] - }, - "ssh": { - "type": "array", - "description": "List of SSH connectivity endpoints.", - "items": { - "$ref": "#/definitions/SshConnectivityEndpoint" - }, - "x-ms-identifiers": [] - } - }, - "readOnly": true - }, - "ClusterAccessProfile": { - "type": "object", - "description": "Cluster access profile.", - "required": [ - "enableInternalIngress" - ], - "properties": { - "enableInternalIngress": { - "type": "boolean", - "description": "Whether to create cluster using private IP instead of public IP. This property must be set at create time.", - "x-ms-mutability": [ - "create", - "read" - ] - }, - "privateLinkServiceId": { - "type": "string", - "readOnly": true, - "format": "arm-id", - "x-ms-arm-id-details": { - "allowedResources": [ - { - "type": "Microsoft.Network/privateLinkServices" - } - ] - }, - "description": "Private link service resource ID. Only when enableInternalIngress is true, this property will be returned." - } - } - }, - "WebConnectivityEndpoint": { - "type": "object", - "description": "Web connectivity endpoint details.", - "required": [ - "fqdn" - ], - "properties": { - "fqdn": { - "type": "string", - "description": "Web connectivity endpoint.", - "example": "clusterName11223344.clusterPoolName55667788.subid.eastus.hdinsightaks.net" - }, - "privateFqdn": { - "type": "string", - "description": "Private web connectivity endpoint. This property will only be returned when enableInternalIngress is true.", - "example": "clusterName11223344-int.clusterPoolName55667788.subid.eastus.hdinsightaks.net" - } - }, - "readOnly": true - }, - "SshConnectivityEndpoint": { - "type": "object", - "description": "SSH connectivity endpoint details.", - "required": [ - "endpoint" - ], - "properties": { - "endpoint": { - "type": "string", - "description": "SSH connectivity endpoint.", - "example": "clusterName11223344.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" - }, - "privateSshEndpoint": { - "type": "string", - "description": "Private SSH connectivity endpoint. This property will only be returned when enableInternalIngress is true.", - "example": "clusterName11223344-int.clusterPoolName55667788.eastus.hdinsightaks.net/ssh/host/podPrefix-0" - } - } - }, - "ClusterProfile": { - "type": "object", - "required": [ - "authorizationProfile", - "clusterVersion", - "ossVersion" - ], - "properties": { - "clusterVersion": { - "$ref": "#/definitions/ThreeOrFourPartVersionPattern" - }, - "ossVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "components": { - "$ref": "#/definitions/ClusterComponents" - }, - "identityProfile": { - "description": "This is deprecated. Please use managed identity profile instead.", - "$ref": "#/definitions/IdentityProfile" - }, - "managedIdentityProfile": { - "description": "This property is required by Trino, Spark and Flink cluster but is optional for Kafka cluster.", - "$ref": "#/definitions/ManagedIdentityProfile" - }, - "authorizationProfile": { - "$ref": "#/definitions/AuthorizationProfile" - }, - "secretsProfile": { - "$ref": "#/definitions/SecretsProfile" - }, - "serviceConfigsProfiles": { - "type": "array", - "description": "The service configs profiles.", - "items": { - "$ref": "#/definitions/ClusterServiceConfigsProfile" - }, - "x-ms-identifiers": [] - }, - "connectivityProfile": { - "$ref": "#/definitions/ConnectivityProfile" - }, - "clusterAccessProfile": { - "$ref": "#/definitions/ClusterAccessProfile" - }, - "logAnalyticsProfile": { - "$ref": "#/definitions/ClusterLogAnalyticsProfile" - }, - "prometheusProfile": { - "$ref": "#/definitions/ClusterPrometheusProfile" - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile" - }, - "autoscaleProfile": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "rangerPluginProfile": { - "$ref": "#/definitions/ClusterRangerPluginProfile" - }, - "kafkaProfile": { - "$ref": "#/definitions/KafkaProfile" - }, - "trinoProfile": { - "$ref": "#/definitions/TrinoProfile" - }, - "llapProfile": { - "type": "object", - "description": "LLAP cluster profile.", - "additionalProperties": true - }, - "flinkProfile": { - "$ref": "#/definitions/FlinkProfile" - }, - "sparkProfile": { - "$ref": "#/definitions/SparkProfile" - }, - "rangerProfile": { - "$ref": "#/definitions/RangerProfile" - }, - "stubProfile": { - "type": "object", - "description": "Stub cluster profile.", - "additionalProperties": true - }, - "scriptActionProfiles": { - "$ref": "#/definitions/ScriptActionProfiles" - } - }, - "description": "Cluster profile." - }, - "SshProfile": { - "type": "object", - "description": "Ssh profile for the cluster.", - "required": [ - "count" - ], - "properties": { - "count": { - "type": "integer", - "description": "Number of ssh pods per cluster.", - "format": "int32", - "maximum": 5.0, - "minimum": 0.0 - }, - "podPrefix": { - "type": "string", - "description": "Prefix of the pod names. Pod number will be appended to the prefix. The ingress URLs for the pods will be available at //-", - "readOnly": true - }, - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - } - } - }, - "AutoscaleProfile": { - "type": "object", - "description": "This is the Autoscale profile for the cluster. This will allow customer to create cluster enabled with Autoscale.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "This indicates whether auto scale is enabled on HDInsight on AKS cluster." - }, - "gracefulDecommissionTimeout": { - "type": "integer", - "format": "int32", - "description": "This property is for graceful decommission timeout; It has a default setting of 3600 seconds before forced shutdown takes place. This is the maximal time to wait for running containers and applications to complete before transition a DECOMMISSIONING node into DECOMMISSIONED. The default value is 3600 seconds. Negative value (like -1) is handled as infinite timeout." - }, - "autoscaleType": { - "type": "string", - "description": "User to specify which type of Autoscale to be implemented - Scheduled Based or Load Based.", - "enum": [ - "ScheduleBased", - "LoadBased" - ], - "x-ms-enum": { - "name": "AutoscaleType", - "modelAsString": true - } - }, - "scheduleBasedConfig": { - "description": "Profiles of schedule based Autoscale.", - "$ref": "#/definitions/ScheduleBasedConfig" - }, - "loadBasedConfig": { - "description": "Profiles of load based Autoscale.", - "$ref": "#/definitions/LoadBasedConfig" - } - } - }, - "ScheduleBasedConfig": { - "type": "object", - "description": "Profile of schedule based Autoscale.", - "required": [ - "timeZone", - "defaultCount", - "schedules" - ], - "properties": { - "timeZone": { - "type": "string", - "description": "User has to specify the timezone on which the schedule has to be set for schedule based autoscale configuration." - }, - "defaultCount": { - "type": "integer", - "format": "int32", - "description": "Setting default node count of current schedule configuration. Default node count specifies the number of nodes which are default when an specified scaling operation is executed (scale up/scale down)" - }, - "schedules": { - "type": "array", - "description": "This specifies the schedules where scheduled based Autoscale to be enabled, the user has a choice to set multiple rules within the schedule across days and times (start/end).", - "items": { - "$ref": "#/definitions/Schedule" - }, - "x-ms-identifiers": [] - } - } - }, - "Schedule": { - "type": "object", - "description": "Schedule definition.", - "required": [ - "days", - "startTime", - "endTime", - "count" - ], - "properties": { - "startTime": { - "type": "string", - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "description": "User has to set the start time of current schedule configuration, format like 10:30 (HH:MM)." - }, - "endTime": { - "type": "string", - "pattern": "^([0-1]?[0-9]|2[0-3]):[0-5][0-9]$", - "description": "User has to set the end time of current schedule configuration, format like 10:30 (HH:MM)." - }, - "count": { - "type": "integer", - "format": "int32", - "description": "User has to set the node count anticipated at end of the scaling operation of the set current schedule configuration, format is integer." - }, - "days": { - "type": "array", - "description": "User has to set the days where schedule has to be set for autoscale operation.", - "items": { - "type": "string", - "enum": [ - "Sunday", - "Monday", - "Tuesday", - "Wednesday", - "Thursday", - "Friday", - "Saturday" - ], - "x-ms-enum": { - "name": "ScheduleDay", - "modelAsString": true - } - } - } - } - }, - "LoadBasedConfig": { - "type": "object", - "description": "Profile of load based Autoscale.", - "required": [ - "minNodes", - "maxNodes", - "scalingRules" - ], - "properties": { - "minNodes": { - "type": "integer", - "format": "int32", - "description": "User needs to set the minimum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." - }, - "maxNodes": { - "type": "integer", - "format": "int32", - "description": "User needs to set the maximum number of nodes for load based scaling, the load based scaling will use this to scale up and scale down between minimum and maximum number of nodes." - }, - "pollInterval": { - "type": "integer", - "format": "int32", - "description": "User can specify the poll interval, this is the time period (in seconds) after which scaling metrics are polled for triggering a scaling operation." - }, - "cooldownPeriod": { - "type": "integer", - "format": "int32", - "description": "This is a cool down period, this is a time period in seconds, which determines the amount of time that must elapse between a scaling activity started by a rule and the start of the next scaling activity, regardless of the rule that triggers it. The default value is 300 seconds." - }, - "scalingRules": { - "type": "array", - "description": "The scaling rules.", - "items": { - "$ref": "#/definitions/ScalingRule" - }, - "x-ms-identifiers": [] - } - } - }, - "ScalingRule": { - "type": "object", - "description": "The scaling rule.", - "required": [ - "actionType", - "comparisonRule", - "evaluationCount", - "scalingMetric" - ], - "properties": { - "actionType": { - "type": "string", - "description": "The action type.", - "enum": [ - "scaleup", - "scaledown" - ], - "x-ms-enum": { - "name": "ScaleActionType", - "modelAsString": true - } - }, - "evaluationCount": { - "type": "integer", - "format": "int32", - "description": "This is an evaluation count for a scaling condition, the number of times a trigger condition should be successful, before scaling activity is triggered." - }, - "scalingMetric": { - "type": "string", - "description": "Metrics name for individual workloads. For example: cpu" - }, - "comparisonRule": { - "$ref": "#/definitions/ComparisonRule" - } - } - }, - "ComparisonRule": { - "type": "object", - "description": "The comparison rule.", - "required": [ - "operator", - "threshold" - ], - "properties": { - "operator": { - "type": "string", - "description": "The comparison operator.", - "enum": [ - "greaterThan", - "greaterThanOrEqual", - "lessThan", - "lessThanOrEqual" - ], - "x-ms-enum": { - "name": "ComparisonOperator", - "modelAsString": true - } - }, - "threshold": { - "type": "number", - "description": "Threshold setting." - } - } - }, - "TrinoProfile": { - "type": "object", - "description": "Trino Cluster profile.", - "properties": { - "catalogOptions": { - "$ref": "#/definitions/CatalogOptions" - }, - "coordinator": { - "$ref": "#/definitions/TrinoCoordinator" - }, - "userPluginsSpec": { - "$ref": "#/definitions/TrinoUserPlugins" - }, - "userTelemetrySpec": { - "$ref": "#/definitions/TrinoUserTelemetry" - }, - "worker": { - "$ref": "#/definitions/TrinoWorker" - } - } - }, - "CatalogOptions": { - "type": "object", - "description": "Trino cluster catalog options.", - "properties": { - "hive": { - "type": "array", - "description": "hive catalog options.", - "items": { - "$ref": "#/definitions/HiveCatalogOption" - }, - "x-ms-identifiers": [] - } - } - }, - "HiveCatalogOption": { - "type": "object", - "description": "Hive Catalog Option", - "required": [ - "catalogName", - "metastoreDbConnectionURL", - "metastoreWarehouseDir" - ], - "properties": { - "catalogName": { - "description": "Name of trino catalog which should use specified hive metastore.", - "minLength": 1, - "type": "string" - }, - "metastoreDbConnectionAuthenticationMode": { - "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", - "type": "string", - "enum": [ - "SqlAuth", - "IdentityAuth" - ], - "x-ms-enum": { - "name": "MetastoreDbConnectionAuthenticationMode", - "modelAsString": true, - "values": [ - { - "value": "SqlAuth", - "description": "The password-based authentication to connect to your Hive metastore database. " - }, - { - "value": "IdentityAuth", - "description": "The managed-identity-based authentication to connect to your Hive metastore database. " - } - ] - }, - "default": "IdentityAuth" - }, - "metastoreDbConnectionPasswordSecret": { - "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", - "type": "string" - }, - "metastoreDbConnectionURL": { - "description": "Connection string for hive metastore database.", - "type": "string" - }, - "metastoreDbConnectionUserName": { - "description": "User name for database connection.", - "type": "string" - }, - "metastoreWarehouseDir": { - "description": "Metastore root directory URI, format: abfs[s]://@.dfs.core.windows.net/. More details: https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction-abfs-uri", - "type": "string" - } - } - }, - "FlinkCatalogOptions": { - "type": "object", - "description": "Flink cluster catalog options.", - "properties": { - "hive": { - "$ref": "#/definitions/FlinkHiveCatalogOption" - } - } - }, - "FlinkHiveCatalogOption": { - "type": "object", - "description": "Hive Catalog Option for Flink cluster.", - "required": [ - "metastoreDbConnectionURL" - ], - "properties": { - "metastoreDbConnectionAuthenticationMode": { - "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", - "type": "string", - "enum": [ - "SqlAuth", - "IdentityAuth" - ], - "x-ms-enum": { - "name": "MetastoreDbConnectionAuthenticationMode", - "modelAsString": true, - "values": [ - { - "value": "SqlAuth", - "description": "The password-based authentication to connect to your Hive metastore database. " - }, - { - "value": "IdentityAuth", - "description": "The managed-identity-based authentication to connect to your Hive metastore database. " - } - ] - }, - "default": "IdentityAuth" - }, - "metastoreDbConnectionPasswordSecret": { - "description": "Secret reference name from secretsProfile.secrets containing password for database connection.", - "type": "string" - }, - "metastoreDbConnectionURL": { - "description": "Connection string for hive metastore database.", - "type": "string" - }, - "metastoreDbConnectionUserName": { - "description": "User name for database connection.", - "type": "string" - } - } - }, - "TrinoCoordinator": { - "type": "object", - "description": "Trino Coordinator.", - "properties": { - "debug": { - "$ref": "#/definitions/TrinoDebugConfig", - "x-ms-client-flatten": true - }, - "highAvailabilityEnabled": { - "type": "boolean", - "description": "The flag that if enable coordinator HA, uses multiple coordinator replicas with auto failover, one per each head node. Default: true.", - "default": true - } - } - }, - "TrinoWorker": { - "type": "object", - "description": "Trino worker.", - "properties": { - "debug": { - "$ref": "#/definitions/TrinoDebugConfig", - "x-ms-client-flatten": true - } - } - }, - "TrinoDebugConfig": { - "type": "object", - "description": "Trino debug configuration.", - "properties": { - "enable": { - "type": "boolean", - "description": "The flag that if enable debug or not.", - "default": false - }, - "port": { - "type": "integer", - "format": "int32", - "description": "The debug port.", - "default": 8008 - }, - "suspend": { - "type": "boolean", - "description": "The flag that if suspend debug or not.", - "default": false - } - } - }, - "TrinoUserTelemetry": { - "type": "object", - "description": "User telemetry", - "properties": { - "storage": { - "$ref": "#/definitions/TrinoTelemetryConfig" - } - } - }, - "TrinoTelemetryConfig": { - "type": "object", - "description": "Trino user telemetry definition.", - "properties": { - "hivecatalogName": { - "type": "string", - "description": "Hive Catalog name used to mount external tables on the logs written by trino, if not specified there tables are not created.", - "minLength": 1 - }, - "hivecatalogSchema": { - "type": "string", - "description": "Schema of the above catalog to use, to mount query logs as external tables, if not specified tables will be mounted under schema trinologs.", - "default": "trinologs" - }, - "partitionRetentionInDays": { - "type": "integer", - "description": "Retention period for query log table partitions, this doesn't have any affect on actual data.", - "format": "int32", - "default": 365 - }, - "path": { - "type": "string", - "description": "Azure storage location of the blobs.", - "minLength": 1 - } - } - }, - "TrinoUserPlugins": { - "type": "object", - "description": "Trino user plugins spec", - "properties": { - "plugins": { - "type": "array", - "description": "Trino user plugins.", - "items": { - "$ref": "#/definitions/TrinoUserPlugin" - }, - "x-ms-identifiers": [] - } - } - }, - "TrinoUserPlugin": { - "type": "object", - "description": "Trino user plugin.", - "properties": { - "enabled": { - "type": "boolean", - "description": "Denotes whether the plugin is active or not." - }, - "name": { - "type": "string", - "description": "This field maps to the sub-directory in trino plugins location, that will contain all the plugins under path.", - "minLength": 1 - }, - "path": { - "type": "string", - "description": "Fully qualified path to the folder containing the plugins.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$" - } - } - }, - "SparkProfile": { - "type": "object", - "description": "The spark cluster profile.", - "properties": { - "defaultStorageUrl": { - "type": "string", - "description": "The default storage URL." - }, - "metastoreSpec": { - "$ref": "#/definitions/SparkMetastoreSpec" - }, - "userPluginsSpec": { - "$ref": "#/definitions/SparkUserPlugins" - } - } - }, - "SparkUserPlugins": { - "type": "object", - "description": "Spark user plugins spec", - "properties": { - "plugins": { - "type": "array", - "description": "Spark user plugins.", - "items": { - "$ref": "#/definitions/SparkUserPlugin" - }, - "x-ms-identifiers": [] - } - } - }, - "SparkUserPlugin": { - "type": "object", - "description": "Spark user plugin.", - "required": [ - "path" - ], - "properties": { - "path": { - "type": "string", - "description": "Fully qualified path to the folder containing the plugins.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$" - } - } - }, - "ScriptActionProfiles": { - "type": "array", - "description": "The script action profile list.", - "items": { - "$ref": "#/definitions/ScriptActionProfile" - }, - "x-ms-identifiers": [] - }, - "ScriptActionProfile": { - "type": "object", - "description": "The script action profile.", - "required": [ - "name", - "type", - "url", - "services" - ], - "properties": { - "type": { - "type": "string", - "description": "Type of the script action. Supported type is bash scripts." - }, - "name": { - "type": "string", - "description": "Script name." - }, - "url": { - "type": "string", - "description": "Url of the script file.", - "pattern": "^(https)|(http)://.*$" - }, - "parameters": { - "type": "string", - "description": "Additional parameters for the script action. It should be space-separated list of arguments required for script execution." - }, - "services": { - "items": { - "type": "string" - }, - "type": "array", - "description": "List of services to apply the script action." - }, - "timeoutInMinutes": { - "type": "integer", - "format": "int32", - "description": "Timeout duration for the script action in minutes." - }, - "shouldPersist": { - "type": "boolean", - "default": true, - "description": "Specify if the script should persist on the cluster." - } - } - }, - "SparkMetastoreSpec": { - "type": "object", - "description": "The metastore specification for Spark cluster.", - "required": [ - "dbServerHost", - "dbName" - ], - "properties": { - "dbServerHost": { - "type": "string", - "description": "The database server host." - }, - "dbName": { - "type": "string", - "description": "The database name." - }, - "dbConnectionAuthenticationMode": { - "description": "The authentication mode to connect to your Hive metastore database. More details: https://learn.microsoft.com/en-us/azure/azure-sql/database/logins-create-manage?view=azuresql#authentication-and-authorization", - "type": "string", - "enum": [ - "SqlAuth", - "IdentityAuth" - ], - "x-ms-enum": { - "name": "DbConnectionAuthenticationMode", - "modelAsString": true, - "values": [ - { - "value": "SqlAuth", - "description": "The password-based authentication to connect to your Hive metastore database. " - }, - { - "value": "IdentityAuth", - "description": "The managed-identity-based authentication to connect to your Hive metastore database. " - } - ] - }, - "default": "IdentityAuth" - }, - "dbUserName": { - "type": "string", - "description": "The database user name." - }, - "dbPasswordSecretName": { - "type": "string", - "description": "The secret name which contains the database user password." - }, - "keyVaultId": { - "type": "string", - "description": "The key vault resource id." - }, - "thriftUrl": { - "type": "string", - "description": "The thrift url." - } - } - }, - "FlinkProfile": { - "type": "object", - "description": "The Flink cluster profile.", - "required": [ - "storage", - "jobManager", - "taskManager" - ], - "properties": { - "storage": { - "$ref": "#/definitions/FlinkStorageProfile" - }, - "numReplicas": { - "type": "integer", - "format": "int32", - "description": "The number of task managers." - }, - "jobManager": { - "description": "Job Manager container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "historyServer": { - "description": "History Server container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "taskManager": { - "description": "Task Manager container/ process CPU and memory requirements", - "$ref": "#/definitions/ComputeResourceDefinition" - }, - "catalogOptions": { - "$ref": "#/definitions/FlinkCatalogOptions" - }, - "deploymentMode": { - "description": "A string property that indicates the deployment mode of Flink cluster. It can have one of the following enum values => Application, Session. Default value is Session", - "type": "string", - "enum": [ - "Application", - "Session" - ], - "x-ms-enum": { - "name": "deploymentMode", - "modelAsString": true - } - }, - "jobSpec": { - "$ref": "#/definitions/FlinkJobProfile" - } - } - }, - "FlinkJobProfile": { - "type": "object", - "description": "Job specifications for flink clusters in application deployment mode. The specification is immutable even if job properties are changed by calling the RunJob API, please use the ListJob API to get the latest job information.", - "required": [ - "jobJarDirectory", - "jarName", - "upgradeMode" - ], - "properties": { - "jobJarDirectory": { - "description": "A string property that specifies the directory where the job JAR is located.", - "type": "string" - }, - "jarName": { - "description": "A string property that represents the name of the job JAR.", - "type": "string" - }, - "entryClass": { - "description": "A string property that specifies the entry class for the Flink job. If not specified, the entry point is auto-detected from the flink job jar package.", - "type": "string" - }, - "args": { - "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", - "type": "string" - }, - "savePointName": { - "description": "A string property that represents the name of the savepoint for the Flink job", - "type": "string" - }, - "upgradeMode": { - "description": "A string property that indicates the upgrade mode to be performed on the Flink job. It can have one of the following enum values => STATELESS_UPDATE, UPDATE, LAST_STATE_UPDATE.", - "type": "string", - "enum": [ - "STATELESS_UPDATE", - "UPDATE", - "LAST_STATE_UPDATE" - ], - "x-ms-enum": { - "name": "upgradeMode", - "modelAsString": true - } - } - } - }, - "FlinkStorageProfile": { - "type": "object", - "description": "The storage profile", - "required": [ - "storageUri" - ], - "properties": { - "storageUri": { - "type": "string", - "pattern": "^(\\w{4,5})://(.*)@(.*).\\b(blob|dfs)\\b.*$", - "description": "Storage account uri which is used for savepoint and checkpoint state." - }, - "storagekey": { - "type": "string", - "description": "Storage key is only required for wasb(s) storage.", - "x-ms-secret": true - } - } - }, - "ClusterRangerPluginProfile": { - "type": "object", - "description": "Cluster Ranger plugin profile.", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Enable Ranger for cluster or not.", - "default": false - } - } - }, - "RangerProfile": { - "type": "object", - "description": "The ranger cluster profile.", - "required": [ - "rangerAdmin", - "rangerUsersync" - ], - "properties": { - "rangerAdmin": { - "$ref": "#/definitions/RangerAdminSpec" - }, - "rangerAudit": { - "$ref": "#/definitions/RangerAuditSpec" - }, - "rangerUsersync": { - "$ref": "#/definitions/RangerUsersyncSpec" - } - } - }, - "RangerAdminSpec": { - "type": "object", - "description": "Specification for the Ranger Admin service.", - "properties": { - "admins": { - "description": "List of usernames that should be marked as ranger admins. These usernames should match the user principal name (UPN) of the respective AAD users.", - "items": { - "type": "string" - }, - "type": "array" - }, - "database": { - "properties": { - "host": { - "description": "The database URL", - "type": "string" - }, - "name": { - "description": "The database name", - "type": "string" - }, - "passwordSecretRef": { - "description": "Reference for the database password", - "type": "string" - }, - "username": { - "description": "The name of the database user", - "type": "string" - } - }, - "required": [ - "host", - "name" - ], - "type": "object" - } - }, - "required": [ - "admins", - "database" - ] - }, - "RangerAuditSpec": { - "description": "Properties required to describe audit log storage.", - "properties": { - "storageAccount": { - "description": "Azure storage location of the blobs. MSI should have read/write access to this Storage account.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$", - "type": "string" - } - }, - "type": "object" - }, - "RangerUsersyncSpec": { - "description": "Specification for the Ranger Usersync service", - "properties": { - "enabled": { - "description": "Denotes whether usersync service should be enabled", - "type": "boolean", - "default": true - }, - "groups": { - "description": "List of groups that should be synced. These group names should match the object id of the respective AAD groups.", - "items": { - "type": "string" - }, - "type": "array" - }, - "mode": { - "default": "automatic", - "description": "User & groups can be synced automatically or via a static list that's refreshed.", - "type": "string", - "enum": [ - "static", - "automatic" - ], - "x-ms-enum": { - "name": "RangerUsersyncMode", - "modelAsString": true - } - }, - "userMappingLocation": { - "description": "Azure storage location of a mapping file that lists user & group associations.", - "minLength": 1, - "pattern": "^(https)|(abfss)://.*$", - "type": "string" - }, - "users": { - "description": "List of user names that should be synced. These usernames should match the User principal name of the respective AAD users.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ComputeResourceDefinition": { - "type": "object", - "description": "The cpu and memory requirement definition.", - "required": [ - "cpu", - "memory" - ], - "properties": { - "cpu": { - "type": "number", - "format": "float", - "description": "The required CPU." - }, - "memory": { - "type": "integer", - "format": "int64", - "description": "The required memory in MB, Container memory will be 110 percentile" - } - } - }, - "KafkaProfile": { - "type": "object", - "description": "The Kafka cluster profile.", - "required": [ - "diskStorage" - ], - "properties": { - "enableKRaft": { - "description": "Expose Kafka cluster in KRaft mode.", - "default": true, - "type": "boolean" - }, - "enablePublicEndpoints": { - "description": "Expose worker nodes as public endpoints.", - "default": false, - "type": "boolean" - }, - "remoteStorageUri": { - "description": "Fully qualified path of Azure Storage container used for Tiered Storage.", - "type": "string", - "pattern": "^(https?|abfss?):\\/\\/[^/]+(?:\\/|$)" - }, - "diskStorage": { - "$ref": "#/definitions/DiskStorageProfile" - }, - "connectivityEndpoints": { - "description": "Kafka bootstrap server and brokers related connectivity endpoints.", - "$ref": "#/definitions/KafkaConnectivityEndpoints", - "readOnly": true - } - } - }, - "DiskStorageProfile": { - "type": "object", - "description": "Kafka disk storage profile.", - "required": [ - "dataDiskSize", - "dataDiskType" - ], - "properties": { - "dataDiskSize": { - "description": "Managed Disk size in GB. The maximum supported disk size for Standard and Premium HDD/SSD is 32TB, except for Premium SSD v2, which supports up to 64TB.", - "format": "int32", - "type": "integer" - }, - "dataDiskType": { - "description": "Managed Disk Type.", - "type": "string", - "enum": [ - "Standard_HDD_LRS", - "Standard_SSD_LRS", - "Standard_SSD_ZRS", - "Premium_SSD_LRS", - "Premium_SSD_ZRS", - "Premium_SSD_v2_LRS" - ], - "x-ms-enum": { - "name": "DataDiskType", - "modelAsString": true - } - } - } - }, - "KafkaConnectivityEndpoints": { - "type": "object", - "description": "Kafka bootstrap server and broker related connectivity endpoints.", - "properties": { - "bootstrapServerEndpoint": { - "type": "string", - "description": "bootstrap server connectivity endpoint." - }, - "brokerEndpoints": { - "description": "Kafka broker endpoint list.", - "type": "array", - "items": { - "type": "string" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterResourceProperties": { - "type": "object", - "required": [ - "clusterType", - "computeProfile", - "clusterProfile" - ], - "properties": { - "provisioningState": { - "description": "Provisioning state of the resource.", - "type": "string", - "enum": [ - "Accepted", - "Succeeded", - "Canceled", - "Failed" - ], - "x-ms-enum": { - "name": "ProvisioningStatus", - "modelAsString": true - }, - "readOnly": true - }, - "clusterType": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The type of cluster.", - "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" - }, - "deploymentId": { - "type": "string", - "description": "A unique id generated by the RP to identify the resource.", - "example": "45cd32aead6e4a91b079a0cdbfac8c36", - "readOnly": true - }, - "computeProfile": { - "description": "The compute profile.", - "$ref": "#/definitions/ComputeProfile" - }, - "clusterProfile": { - "$ref": "#/definitions/ClusterProfile" - }, - "status": { - "type": "string", - "description": "Business status of the resource.", - "example": "Running", - "readOnly": true - } - }, - "description": "Cluster resource properties." - }, - "ComputeProfile": { - "type": "object", - "description": "The compute profile.", - "required": [ - "nodes" - ], - "properties": { - "nodes": { - "type": "array", - "description": "The nodes definitions.", - "items": { - "$ref": "#/definitions/NodeProfile" - }, - "x-ms-identifiers": [] - }, - "availabilityZones": { - "$ref": "#/definitions/AvailabilityZones" - } - } - }, - "NodeProfile": { - "type": "object", - "description": "The node profile.", - "required": [ - "type", - "vmSize", - "count" - ], - "properties": { - "type": { - "type": "string", - "description": "The node type.", - "pattern": "^(head|Head|HEAD|worker|Worker|WORKER)$" - }, - "vmSize": { - "type": "string", - "description": "The virtual machine SKU.", - "pattern": "^[a-zA-Z0-9_\\-]{0,256}$" - }, - "count": { - "description": "The number of virtual machines.", - "type": "integer", - "format": "int32", - "minimum": 0 - } - } - }, - "Cluster": { - "type": "object", - "description": "The cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster specific properties.", - "$ref": "#/definitions/ClusterResourceProperties" - }, - "systemData": { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", - "description": "SystemData of cluster.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterPatch": { - "type": "object", - "description": "The patch for a cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Define cluster patch specific properties.", - "$ref": "#/definitions/ClusterPatchProperties" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - } - } - }, - "ClusterPatchProperties": { - "type": "object", - "description": "Cluster resource patch data.", - "properties": { - "clusterProfile": { - "$ref": "#/definitions/UpdatableClusterProfile" - } - } - }, - "UpdatableClusterProfile": { - "type": "object", - "properties": { - "serviceConfigsProfiles": { - "type": "array", - "description": "The service configs profiles.", - "items": { - "$ref": "#/definitions/ClusterServiceConfigsProfile" - }, - "x-ms-identifiers": [] - }, - "sshProfile": { - "$ref": "#/definitions/SshProfile" - }, - "autoscaleProfile": { - "$ref": "#/definitions/AutoscaleProfile" - }, - "authorizationProfile": { - "$ref": "#/definitions/AuthorizationProfile" - }, - "logAnalyticsProfile": { - "$ref": "#/definitions/ClusterLogAnalyticsProfile" - }, - "prometheusProfile": { - "$ref": "#/definitions/ClusterPrometheusProfile" - }, - "rangerPluginProfile": { - "$ref": "#/definitions/ClusterRangerPluginProfile" - }, - "rangerProfile": { - "$ref": "#/definitions/RangerProfile" - }, - "scriptActionProfiles": { - "$ref": "#/definitions/ScriptActionProfiles" - }, - "secretsProfile": { - "$ref": "#/definitions/SecretsProfile" - }, - "trinoProfile": { - "$ref": "#/definitions/TrinoProfile" - } - }, - "description": "Cluster resource patch properties." - }, - "ClusterResizeData": { - "type": "object", - "description": "The parameters for resizing a cluster.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Sets the properties. Define cluster resize specific properties.", - "$ref": "#/definitions/ClusterResizeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" - } - ] - }, - "ClusterResizeProperties": { - "type": "object", - "description": "The properties for resizing a cluster.", - "required": [ - "targetWorkerNodeCount" - ], - "properties": { - "targetWorkerNodeCount": { - "type": "integer", - "format": "int32", - "description": "Target node count of worker node." - } - } - }, - "ServiceConfigListResult": { - "type": "object", - "description": "Cluster instance service configs api response.", - "properties": { - "value": { - "type": "array", - "description": "Cluster instance service config array.", - "items": { - "$ref": "#/definitions/ServiceConfigResult" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ServiceConfigResult": { - "type": "object", - "description": "Cluster instance service config.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster instance service config properties.", - "allOf": [ - { - "$ref": "#/definitions/ServiceConfigListResultProperties" - } - ] - } - } - }, - "ServiceConfigListResultProperties": { - "type": "object", - "properties": { - "serviceName": { - "type": "string", - "description": "Service Config Name." - }, - "fileName": { - "type": "string", - "description": "File Name." - }, - "content": { - "type": "string", - "description": "Content in the service config file." - }, - "componentName": { - "type": "string", - "description": "Component Name." - }, - "type": { - "type": "string", - "description": "Config type." - }, - "path": { - "type": "string", - "description": "Config file path." - }, - "customKeys": { - "type": "object", - "description": "The custom keys.", - "additionalProperties": { - "type": "string" - } - }, - "defaultKeys": { - "type": "object", - "description": "The default keys.", - "additionalProperties": { - "$ref": "#/definitions/ServiceConfigListResultValueEntity" - } - } - }, - "required": [ - "serviceName", - "componentName", - "fileName" - ], - "description": "Service config response." - }, - "ServiceConfigListResultValueEntity": { - "type": "object", - "description": "Default config details.", - "properties": { - "value": { - "type": "string", - "description": "Config value." - }, - "description": { - "type": "string", - "description": "Config description." - } - }, - "required": [ - "value" - ] - }, - "ClusterInstanceViewsResult": { - "type": "object", - "properties": { - "value": { - "items": { - "$ref": "#/definitions/ClusterInstanceViewResult" - }, - "type": "array", - "description": "Cluster instance view array.", - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - }, - "description": "The instance view of a HDInsight Cluster." - }, - "ClusterInstanceViewResult": { - "type": "object", - "description": "Cluster Instance View.", - "required": [ - "name", - "properties" - ], - "properties": { - "name": { - "type": "string", - "description": "Name of the instance view." - }, - "properties": { - "description": "Properties of the instance view.", - "x-ms-client-flatten": true, - "allOf": [ - { - "$ref": "#/definitions/ClusterInstanceViewProperties" - } - ] - } - } - }, - "ClusterInstanceViewProperties": { - "type": "object", - "description": "Cluster Instance View Properties.", - "required": [ - "status", - "serviceStatuses" - ], - "properties": { - "status": { - "description": "Status of the instance view.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInstanceViewStatus" - } - ] - }, - "serviceStatuses": { - "type": "array", - "description": "List of statuses of relevant services that make up the HDInsight on AKS cluster to surface to the customer.", - "items": { - "$ref": "#/definitions/ServiceStatus" - }, - "x-ms-identifiers": [] - } - } - }, - "ClusterInstanceViewStatus": { - "type": "object", - "description": "Status of the instance view.", - "required": [ - "ready" - ], - "properties": { - "ready": { - "type": "string", - "description": "The cluster ready status" - }, - "reason": { - "type": "string", - "description": "The status reason." - }, - "message": { - "type": "string", - "description": "The additional message." - } - } - }, - "ServiceStatus": { - "type": "object", - "description": "Describes the status of a service of a HDInsight on AKS cluster.", - "required": [ - "kind", - "ready" - ], - "properties": { - "kind": { - "type": "string", - "description": "Kind of the service. E.g. \"Zookeeper\"." - }, - "ready": { - "type": "string", - "description": "Indicates if the service is ready / healthy. Values can be \"true\", \"false\", \"unknown\" or anything else." - }, - "message": { - "type": "string", - "description": "A message describing the error if any." - } - } - }, - "NameAvailabilityParameters": { - "description": "Details of check name availability request body.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name for checking availability." - }, - "type": { - "type": "string", - "description": "The resource type in Microsoft.HDInsight." - } - } - }, - "NameAvailabilityResult": { - "description": "Result of check name availability.", - "type": "object", - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "Indicator of availability of the Microsoft.HDInsight resource name." - }, - "reason": { - "type": "string", - "description": "The reason of unavailability." - }, - "message": { - "type": "string", - "description": "The error message of unavailability." - } - } - }, - "ClusterPoolVersionPattern": { - "type": "string", - "description": "Cluster pool version is a 2-part version.", - "example": "1.2", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" - }, - "ClusterPoolVersionsListResult": { - "type": "object", - "description": "Represents a list of cluster pool versions.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster pool versions.", - "items": { - "$ref": "#/definitions/ClusterPoolVersion" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterPoolVersion": { - "type": "object", - "description": "Available cluster pool version.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster pool version properties.", - "$ref": "#/definitions/ClusterPoolVersionProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterPoolVersionProperties": { - "type": "object", - "description": "Cluster pool version properties.", - "properties": { - "clusterPoolVersion": { - "$ref": "#/definitions/ClusterPoolVersionPattern" - }, - "aksVersion": { - "type": "string", - "description": "AKS version.", - "example": "1.24" - }, - "isPreview": { - "type": "boolean", - "description": "Indicate if this version is in preview or not.", - "default": false - } - } - }, - "ThreePartVersionPattern": { - "type": "string", - "description": "Version with three part.", - "example": "1.0.4", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})$" - }, - "ThreeOrFourPartVersionPattern": { - "type": "string", - "description": "Version with 3/4 part.", - "example": "1.0.4", - "pattern": "^(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})\\.(0|[1-9][0-9]{0,18})(?:\\.(0|[1-9][0-9]{0,18}))?$" - }, - "ClusterVersionsListResult": { - "type": "object", - "description": "Represents a list of cluster versions.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster versions.", - "items": { - "$ref": "#/definitions/ClusterVersion" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterVersion": { - "type": "object", - "description": "Available cluster version.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Cluster version properties.", - "$ref": "#/definitions/ClusterVersionProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterVersionProperties": { - "type": "object", - "description": "Cluster version properties.", - "properties": { - "clusterType": { - "type": "string", - "description": "The type of cluster.", - "pattern": "^[a-zA-Z][a-zA-Z0-9]{0,31}$" - }, - "clusterVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "ossVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "clusterPoolVersion": { - "type": "string", - "description": "The two part cluster pool version. If the cluster version is before cluster pool version on-board, the return value will be empty string", - "example": "1.0" - }, - "isPreview": { - "type": "boolean", - "description": "Indicate if this version is in preview or not.", - "default": false - }, - "components": { - "$ref": "#/definitions/ClusterComponents" - } - } - }, - "ClusterComponents": { - "type": "array", - "description": "Component list of this cluster type and version.", - "readOnly": true, - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - } - }, - "x-ms-identifiers": [], - "example": [ - { - "name": "HDFS", - "version": "1.2.3" - }, - { - "name": "HIVE", - "version": "1.2.3" - } - ] - }, - "ClusterJobList": { - "description": "Collection of cluster job.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of cluster job.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterJob" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - } - } - }, - "ClusterJob": { - "description": "Cluster job.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterJobProperties" - } - } - }, - "ClusterJobProperties": { - "description": "Properties of cluster job.", - "type": "object", - "properties": { - "jobType": { - "description": "Type of cluster job.", - "enum": [ - "FlinkJob" - ], - "type": "string", - "x-ms-enum": { - "name": "jobType", - "modelAsString": true - } - } - }, - "discriminator": "jobType", - "required": [ - "jobType" - ] - }, - "FlinkJobProperties": { - "description": "Properties of flink job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterJobProperties" - } - ], - "properties": { - "runId": { - "description": "Run id of job", - "type": "string" - }, - "jobName": { - "description": "Name of job", - "type": "string" - }, - "jobJarDirectory": { - "description": "A string property that specifies the directory where the job JAR is located.", - "type": "string" - }, - "jarName": { - "description": "A string property that represents the name of the job JAR.", - "type": "string" - }, - "entryClass": { - "description": "A string property that specifies the entry class for the Flink job.", - "type": "string" - }, - "args": { - "description": "A string property representing additional JVM arguments for the Flink job. It should be space separated value.", - "type": "string" - }, - "savePointName": { - "description": "A string property that represents the name of the savepoint for the Flink job", - "type": "string" - }, - "action": { - "description": "A string property that indicates the action to be performed on the Flink job. It can have one of the following enum values => NEW, UPDATE, STATELESS_UPDATE, STOP, START, CANCEL, SAVEPOINT, LIST_SAVEPOINT, or DELETE.", - "type": "string", - "enum": [ - "NEW", - "UPDATE", - "STATELESS_UPDATE", - "STOP", - "START", - "CANCEL", - "SAVEPOINT", - "LIST_SAVEPOINT", - "DELETE", - "LAST_STATE_UPDATE", - "RE_LAUNCH" - ], - "x-ms-enum": { - "name": "action", - "modelAsString": true - } - }, - "flinkConfiguration": { - "description": "Additional properties used to configure Flink jobs. It allows users to set properties such as parallelism and jobSavePointDirectory. It accepts additional key-value pairs as properties, where the keys are strings and the values are strings as well.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "jobId": { - "description": "Unique id for identifying a job", - "type": "string", - "readOnly": true - }, - "status": { - "description": "Status of job.", - "type": "string", - "readOnly": true - }, - "jobOutput": { - "description": "Output of job.", - "type": "string", - "readOnly": true - }, - "actionResult": { - "description": "Action result of job.", - "type": "string", - "readOnly": true - }, - "lastSavePoint": { - "description": "The last savepoint.", - "type": "string", - "readOnly": true - } - }, - "x-ms-discriminator-value": "FlinkJob" - }, - "ClusterPoolAvailableUpgradeList": { - "type": "object", - "description": "collection of cluster pool available upgrade.", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of cluster pool available upgrade.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterPoolAvailableUpgrade" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - } - } - }, - "ClusterPoolAvailableUpgrade": { - "type": "object", - "description": "Cluster pool available upgrade.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster pool upgrade specific properties.", - "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterPoolAvailableUpgradeProperties": { - "type": "object", - "description": "Cluster pool available upgrade properties.", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "NodeOsUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterPoolAvailableUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterPoolAvailableUpgradeAksPatchUpgradeProperties": { - "type": "object", - "description": "Cluster pool available AKS patch version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" - } - ], - "properties": { - "currentVersion": { - "description": "Current AKS version.", - "type": "string" - }, - "currentVersionStatus": { - "description": "Current AKS version's status: whether it is deprecated or supported", - "enum": [ - "Deprecated", - "Supported" - ], - "type": "string", - "x-ms-enum": { - "name": "currentClusterPoolAksVersionStatus", - "modelAsString": true - } - }, - "latestVersion": { - "description": "Latest AKS patch version.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterPoolAvailableUpgradeNodeOsUpgradeProperties": { - "type": "object", - "description": "Cluster pool available node OS update.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolAvailableUpgradeProperties" - } - ], - "properties": { - "latestVersion": { - "description": "The latest node OS version.", - "type": "string" - } - }, - "x-ms-discriminator-value": "NodeOsUpgrade" - }, - "ClusterAvailableUpgradeList": { - "type": "object", - "description": "Collection of cluster available upgrade.", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of Cluster available upgrade.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterAvailableUpgrade" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "The URL of next result page.", - "type": "string" - } - } - }, - "ClusterAvailableUpgrade": { - "type": "object", - "description": "Cluster available upgrade.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Gets or sets the properties. Define cluster upgrade specific properties.", - "$ref": "#/definitions/ClusterAvailableUpgradeProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterAvailableUpgradeProperties": { - "type": "object", - "description": "Cluster available upgrade properties.", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "HotfixUpgrade", - "PatchVersionUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterAvailableUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterAvailableUpgradeAksPatchUpgradeProperties": { - "type": "object", - "description": "Cluster available AKS patch version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterAvailableUpgradeProperties" - } - ], - "properties": { - "currentVersion": { - "description": "Current node pool version.", - "type": "string" - }, - "currentVersionStatus": { - "description": "Current AKS version's status: whether it is deprecated or supported", - "enum": [ - "Deprecated", - "Supported" - ], - "type": "string", - "x-ms-enum": { - "name": "currentClusterAksVersionStatus", - "modelAsString": true - } - }, - "latestVersion": { - "description": "Latest available version, which should be equal to AKS control plane version if it's not deprecated.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterAvailableInPlaceUpgradeProperties": { - "type": "object", - "description": "Cluster available in-place upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterAvailableUpgradeProperties" - } - ], - "properties": { - "description": { - "type": "string", - "description": "Hotfix version upgrade description." - }, - "sourceOssVersion": { - "description": "Source OSS version of current cluster component.", - "type": "string" - }, - "sourceClusterVersion": { - "description": "Source cluster version of current cluster component.", - "type": "string" - }, - "sourceBuildNumber": { - "description": "Source build number of current cluster component.", - "type": "string" - }, - "targetOssVersion": { - "description": "Target OSS version of component to be upgraded.", - "type": "string" - }, - "targetClusterVersion": { - "description": "Target cluster version of component to be upgraded.", - "type": "string" - }, - "targetBuildNumber": { - "description": "Target build number of component to be upgraded.", - "type": "string" - }, - "componentName": { - "description": "Name of component to be upgraded.", - "type": "string" - }, - "severity": { - "description": "Severity of this upgrade.", - "enum": [ - "low", - "medium", - "high", - "critical" - ], - "type": "string", - "x-ms-enum": { - "name": "Severity", - "modelAsString": true - } - }, - "extendedProperties": { - "description": "Extended properties of current available upgrade version", - "type": "string" - }, - "createdTime": { - "description": "Created time of current available upgrade version", - "type": "string", - "format": "date-time" - } - } - }, - "ClusterAvailableUpgradeHotfixUpgradeProperties": { - "type": "object", - "description": "Cluster available hotfix version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterAvailableInPlaceUpgradeProperties" - } - ], - "x-ms-discriminator-value": "HotfixUpgrade" - }, - "ClusterAvailableUpgradePatchVersionUpgradeProperties": { - "type": "object", - "description": "Cluster available patch version upgrade.", - "allOf": [ - { - "$ref": "#/definitions/ClusterAvailableInPlaceUpgradeProperties" - } - ], - "x-ms-discriminator-value": "PatchVersionUpgrade" - }, - "ClusterPoolUpgrade": { - "description": "Cluster Pool Upgrade.", - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterPoolUpgradeProperties" - } - } - }, - "ClusterPoolUpgradeProperties": { - "description": "Properties of upgrading cluster pool.", - "type": "object", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "NodeOsUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterPoolUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterPoolAKSPatchVersionUpgradeProperties": { - "description": "Properties of upgrading cluster pool's AKS patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolUpgradeProperties" - } - ], - "properties": { - "upgradeClusterPool": { - "description": "whether upgrade cluster pool or not. If it's true, upgradeAllClusterNodes should be false.", - "type": "boolean", - "default": false - }, - "upgradeAllClusterNodes": { - "description": "whether upgrade all clusters' nodes. If it's true, upgradeClusterPool should be false.", - "type": "boolean", - "default": false - }, - "targetAksVersion": { - "description": "Target AKS version. When it's not set, latest version will be used. When upgradeClusterPool is true and upgradeAllClusterNodes is false, target version should be greater or equal to current version. When upgradeClusterPool is false and upgradeAllClusterNodes is true, target version should be equal to AKS version of cluster pool.", - "type": "string" - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterPoolNodeOsImageUpdateProperties": { - "description": "Properties of upgrading cluster pool's AKS patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolUpgradeProperties" - } - ], - "properties": {}, - "x-ms-discriminator-value": "NodeOsUpgrade" - }, - "ClusterPoolUpgradeHistoryListResult": { - "type": "object", - "required": [ - "value" - ], - "description": "Represents a list of cluster pool upgrade history.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster pool upgrade history.", - "items": { - "$ref": "#/definitions/ClusterPoolUpgradeHistory" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterPoolUpgradeHistory": { - "type": "object", - "description": "Cluster pool upgrade history.", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterPoolUpgradeHistoryProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterPoolUpgradeHistoryProperties": { - "description": "Properties of cluster pool upgrade history.", - "type": "object", - "required": [ - "upgradeType", - "utcTime", - "upgradeResult" - ], - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "NodeOsUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterPoolUpgradeHistoryType", - "modelAsString": true - } - }, - "utcTime": { - "description": "Time when created this upgrade history.", - "type": "string" - }, - "upgradeResult": { - "description": "Result of this upgrade.", - "enum": [ - "Succeed", - "Failed" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterPoolUpgradeHistoryUpgradeResultType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType" - }, - "ClusterPoolNodeOsUpgradeHistoryProperties": { - "type": "object", - "description": "Cluster pool node os upgrade history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolUpgradeHistoryProperties" - } - ], - "properties": { - "newNodeOs": { - "type": "string", - "description": "New Node Os version." - } - }, - "x-ms-discriminator-value": "NodeOsUpgrade" - }, - "ClusterPoolAksPatchUpgradeHistoryProperties": { - "type": "object", - "description": "Cluster pool aks upgrade history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterPoolUpgradeHistoryProperties" - } - ], - "properties": { - "upgradeClusterPool": { - "type": "boolean", - "description": "Whether upgrade cluster pool." - }, - "upgradeAllClusterNodes": { - "type": "boolean", - "description": "Whether upgrade all cluster nodes." - }, - "originalVersion": { - "type": "string", - "description": "Version before update." - }, - "newVersion": { - "type": "string", - "description": "Version going to update." - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterUpgrade": { - "description": "Cluster Upgrade.", - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterUpgradeProperties" - } - } - }, - "ClusterUpgradeProperties": { - "description": "Properties of upgrading cluster.", - "type": "object", - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "HotfixUpgrade", - "PatchVersionUpgrade" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterUpgradeType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType", - "required": [ - "upgradeType" - ] - }, - "ClusterAKSPatchVersionUpgradeProperties": { - "description": "Properties of upgrading cluster's AKS patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterUpgradeProperties" - } - ], - "properties": {}, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterInPlaceUpgradeProperties": { - "description": "Properties of in-place upgrading cluster.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterUpgradeProperties" - } - ], - "properties": { - "targetOssVersion": { - "description": "Target OSS version of component to be upgraded.", - "type": "string" - }, - "targetClusterVersion": { - "description": "Target cluster version of component to be upgraded.", - "type": "string" - }, - "targetBuildNumber": { - "description": "Target build number of component to be upgraded.", - "type": "string" - }, - "componentName": { - "description": "Name of component to be upgraded.", - "type": "string" - } - } - }, - "ClusterHotfixUpgradeProperties": { - "description": "Properties of upgrading cluster's hotfix.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterInPlaceUpgradeProperties" - } - ], - "x-ms-discriminator-value": "HotfixUpgrade" - }, - "ClusterPatchVersionUpgradeProperties": { - "description": "Properties of upgrading cluster's patch version.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ClusterInPlaceUpgradeProperties" - } - ], - "x-ms-discriminator-value": "PatchVersionUpgrade" - }, - "ClusterUpgradeHistoryListResult": { - "type": "object", - "required": [ - "value" - ], - "description": "Represents a list of cluster upgrade history.", - "properties": { - "value": { - "type": "array", - "description": "The list of cluster upgrade history.", - "items": { - "$ref": "#/definitions/ClusterUpgradeHistory" - } - }, - "nextLink": { - "type": "string", - "description": "The link (url) to the next page of results.", - "readOnly": true - } - } - }, - "ClusterUpgradeHistory": { - "type": "object", - "description": "Cluster upgrade history.", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterUpgradeHistoryProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ] - }, - "ClusterUpgradeHistoryProperties": { - "description": "Properties of cluster upgrade history.", - "type": "object", - "required": [ - "upgradeType", - "utcTime", - "upgradeResult" - ], - "properties": { - "upgradeType": { - "description": "Type of upgrade.", - "enum": [ - "AKSPatchUpgrade", - "HotfixUpgrade", - "HotfixUpgradeRollback", - "PatchVersionUpgrade", - "PatchVersionUpgradeRollback" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterUpgradeHistoryType", - "modelAsString": true - } - }, - "utcTime": { - "description": "Time when created this upgrade history.", - "type": "string" - }, - "upgradeResult": { - "description": "Result of this upgrade.", - "enum": [ - "Succeed", - "Failed" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterUpgradeHistoryUpgradeResultType", - "modelAsString": true - } - } - }, - "discriminator": "upgradeType" - }, - "ClusterInPlaceUpgradeHistoryProperties": { - "type": "object", - "description": "Cluster in-place upgrade history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterUpgradeHistoryProperties" - } - ], - "properties": { - "sourceClusterVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "sourceOssVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "sourceBuildNumber": { - "type": "string", - "description": "Source build number." - }, - "targetClusterVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "targetOssVersion": { - "$ref": "#/definitions/ThreePartVersionPattern" - }, - "targetBuildNumber": { - "type": "string", - "description": "Target build number." - }, - "componentName": { - "type": "string", - "description": "Component name to upgrade." - }, - "severity": { - "description": "Severity of this upgrade.", - "enum": [ - "low", - "medium", - "high", - "critical" - ], - "type": "string", - "x-ms-enum": { - "name": "clusterUpgradeHistorySeverityType", - "modelAsString": true - } - } - } - }, - "ClusterHotfixUpgradeHistoryProperties": { - "type": "object", - "description": "Cluster hotfix upgrade history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInPlaceUpgradeHistoryProperties" - } - ], - "x-ms-discriminator-value": "HotfixUpgrade" - }, - "ClusterHotfixUpgradeRollbackHistoryProperties": { - "type": "object", - "description": "Cluster hotfix upgrade rollback history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInPlaceUpgradeHistoryProperties" - } - ], - "x-ms-discriminator-value": "HotfixUpgradeRollback" - }, - "ClusterPatchVersionUpgradeHistoryProperties": { - "type": "object", - "description": "Cluster patch version upgrade history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInPlaceUpgradeHistoryProperties" - } - ], - "x-ms-discriminator-value": "PatchVersionUpgrade" - }, - "ClusterPatchVersionUpgradeRollbackHistoryProperties": { - "type": "object", - "description": "Cluster patch version upgrade rollback history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterInPlaceUpgradeHistoryProperties" - } - ], - "x-ms-discriminator-value": "PatchVersionUpgradeRollback" - }, - "ClusterAksPatchUpgradeHistoryProperties": { - "type": "object", - "description": "Cluster aks patch upgrade history properties.", - "allOf": [ - { - "$ref": "#/definitions/ClusterUpgradeHistoryProperties" - } - ], - "properties": { - "originalVersion": { - "type": "string", - "description": "Version before update." - }, - "newVersion": { - "type": "string", - "description": "Version going to update." - } - }, - "x-ms-discriminator-value": "AKSPatchUpgrade" - }, - "ClusterUpgradeRollback": { - "description": "Cluster Upgrade.", - "type": "object", - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterUpgradeRollbackProperties" - } - } - }, - "ClusterUpgradeRollbackProperties": { - "description": "Properties for manual rollback of cluster's upgrade.", - "type": "object", - "properties": { - "upgradeHistory": { - "description": "A specific upgrade history to rollback", - "type": "string" - } - }, - "required": [ - "upgradeHistory" - ] - }, - "ClusterLibraryManagementOperation": { - "description": "Library management operation.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterLibraryManagementOperationProperties" - } - } - }, - "ClusterLibraryManagementOperationProperties": { - "description": "Properties of a library management operation.", - "type": "object", - "required": [ - "action", - "libraries" - ], - "properties": { - "action": { - "description": "The library management action.", - "enum": [ - "Install", - "Uninstall" - ], - "type": "string", - "x-ms-enum": { - "name": "LibraryManagementAction", - "modelAsString": true - } - }, - "libraries": { - "type": "array", - "description": "The libraries to be installed/updated/uninstalled.", - "items": { - "$ref": "#/definitions/ClusterLibrary" - } - } - } - }, - "ClusterLibraryList": { - "description": "Collection of libraries in the cluster.", - "type": "object", - "required": [ - "value" - ], - "properties": { - "value": { - "type": "array", - "description": "Collection of libraries in the cluster.", - "uniqueItems": false, - "items": { - "$ref": "#/definitions/ClusterLibrary" - } - }, - "nextLink": { - "description": "The url of next result page.", - "type": "string", - "readOnly": true - } - } - }, - "ClusterLibrary": { - "description": "Libraries in the cluster.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "properties": { - "properties": { - "$ref": "#/definitions/ClusterLibraryProperties" - } - } - }, - "ClusterLibraryProperties": { - "description": "Properties of a library in the cluster.", - "type": "object", - "properties": { - "type": { - "description": "Type of the library.", - "enum": [ - "pypi", - "maven" - ], - "type": "string", - "x-ms-enum": { - "name": "type", - "modelAsString": true - } - }, - "remarks": { - "description": "Remark of the latest library management operation.", - "type": "string" - }, - "timestamp": { - "description": "Timestamp of the latest library management operation.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "status": { - "description": "Status of the library.", - "enum": [ - "INSTALLING", - "INSTALLED", - "INSTALL_FAILED", - "UNINSTALLING", - "UNINSTALL_FAILED" - ], - "type": "string", - "x-ms-enum": { - "name": "status", - "modelAsString": true - }, - "readOnly": true - }, - "message": { - "description": "Error message of the library operation when a failure occurs.", - "type": "string", - "readOnly": true - } - }, - "discriminator": "type", - "required": [ - "type" - ] - }, - "PyPiLibraryProperties": { - "description": "Properties of a PyPi library in the cluster.", - "type": "object", - "required": [ - "name" - ], - "allOf": [ - { - "$ref": "#/definitions/ClusterLibraryProperties" - } - ], - "properties": { - "name": { - "description": "Name of the PyPi package.", - "type": "string" - }, - "version": { - "description": "Version of the PyPi package.", - "type": "string" - } - }, - "x-ms-discriminator-value": "pypi" - }, - "MavenLibraryProperties": { - "description": "Properties of a Maven library in the cluster.", - "type": "object", - "required": [ - "name", - "groupId" - ], - "allOf": [ - { - "$ref": "#/definitions/ClusterLibraryProperties" - } - ], - "properties": { - "groupId": { - "description": "GroupId of the Maven package.", - "type": "string" - }, - "name": { - "description": "ArtifactId of the Maven package.", - "type": "string" - }, - "version": { - "description": "Version of the Maven package.", - "type": "string" - } - }, - "x-ms-discriminator-value": "maven" - } - }, - "parameters": { - "ClusterPoolNameParameter": { - "name": "clusterPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the cluster pool.", - "x-ms-parameter-location": "method" - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the HDInsight cluster.", - "x-ms-parameter-location": "method" - }, - "ClusterTypeNameParameter": { - "name": "clusterTypeName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the HDInsight on AKS cluster type.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.go.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.go.md deleted file mode 100644 index 77ab0d7a7d12..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.go.md +++ /dev/null @@ -1,11 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) && $(track2) -license-header: MICROSOFT_MIT_NO_VERSION -module-name: sdk/resourcemanager/hdinsightcontainers/armhdinsightcontainers -module: github.com/Azure/azure-sdk-for-go/$(module-name) -output-folder: $(go-sdk-folder)/$(module-name) -azure-arm: true -``` \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md deleted file mode 100644 index 01cdabebe9ad..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.java.md +++ /dev/null @@ -1,7 +0,0 @@ -## Java - -These settings apply only when `--java` is specified on the command line. - -``` yaml $(java) -client-flattened-annotation-target: disabled -``` diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md deleted file mode 100644 index cb16a494a112..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.md +++ /dev/null @@ -1,175 +0,0 @@ -# HDInsight On Aks - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for HDInsight On Aks. - ---- - -## Getting Started - -To build the SDK for HDInsight, 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 HDInsight On Aks API. - -``` yaml -title: HDInsightContainersManagementClient -description: HDInsight Containers Management Client -openapi-type: arm -openapi-subtype: rpaas -azure-arm: true -tag: package-preview-2024-05 -``` - -``` yaml -modelerfour: - flatten-models: false -``` - -### Suppression - - -### Tag: package-preview-2024-05 - -These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. - -```yaml $(tag) == 'package-preview-2024-05' -input-file: - - preview/2024-05-01-preview/hdinsight.json - -suppressions: - - code: ResourceNameRestriction - reason: Keep compatibility with old API version. - - code: OperationIdNounVerb - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters"].get.operationId - reason: The operation id is valid. - - code: EnumInsteadOfBoolean - - code: TrackedResourcePatchOperation - where: - - $.definitions.Cluster - reason: This is a false positive, and there is ClusterPatch defined for patching cluster. - - code: PatchBodyParametersSchema - reason: We refers to the same models in PUT operation, and the errors checked are allowed by our service. - - code: DeleteResponseCodes - reason: If the resource only exist in arm, and doesn't have backend resources, we return 200 in delete operation. - - code: EnumInsteadOfBoolean - where: - - $.definitions.ClusterAccessProfile.properties.enableInternalIngress - - $.definitions.ClusterPoolNetworkProfile.properties.enablePrivateApiServer - - $.definitions.ClusterRangerPluginProfile.properties.enabled - - $.definitions.RangerUsersyncSpec.properties.enabled - - $.definitions.KafkaProfile.properties.enableKRaft - - $.definitions.KafkaProfile.enablePublicEndpoints - - $.definitions.ClusterPoolAKSPatchVersionUpgradeProperties.upgradeClusterPool - - $.definitions.ClusterPoolAKSPatchVersionUpgradeProperties.upgradeAllClusterNodes - reason: They are used for enabling or disabling a feature. Using a boolean type is more user friendly, and they will be not extended to other values. -``` -### Tag: package-preview-2023-11 - -These settings apply only when `--tag=package-preview-2023-11` is specified on the command line. - -``` yaml $(tag) == 'package-preview-2023-11' -input-file: - - preview/2023-11-01-preview/hdinsight.json - -suppressions: - - code: ResourceNameRestriction - reason: Keep compatibility with old API version. - - code: OperationIdNounVerb - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusterpools/{clusterPoolName}/clusters"].get.operationId - reason: The operation id is valid. - - code: EnumInsteadOfBoolean - - code: TrackedResourcePatchOperation - where: - - $.definitions.Cluster - reason: This is a false positive, and there is ClusterPatch defined for patching cluster. - - code: DeleteResponseCodes - reason: If the resource only exist in arm, and doesn't have backend resources, we return 200 in delete operation. - - code: EnumInsteadOfBoolean - where: - - $.definitions.ClusterAccessProfile.properties.enableInternalIngress - - $.definitions.ClusterPoolNetworkProfile.properties.enablePrivateApiServer - - $.definitions.ClusterRangerPluginProfile.properties.enabled - - $.definitions.RangerUsersyncSpec.properties.enabled - - $.definitions.KafkaProfile.properties.enableKRaft - - $.definitions.KafkaProfile.enablePublicEndpoints - - $.definitions.ClusterPoolAKSPatchVersionUpgradeProperties.upgradeClusterPool - - $.definitions.ClusterPoolAKSPatchVersionUpgradeProperties.upgradeAllClusterNodes - reason: They are used for enabling or disabling a feature. Using a boolean type is more user friendly, and they will be not extended to other values. -``` - -### Tag: package-2023-06-preview - -These settings apply only when `--tag=package-2023-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2023-06-preview' -input-file: - - preview/2023-06-01-preview/hdinsight.json -suppressions: - - code: ResourceNameRestriction - reason: Keep compatibility with old API version. - - code: PatchBodyParametersSchema - reason: The "location" property is a must for a tracked resource. - - code: TrackedResourcePatchOperation - reason: This is a false positive, the "tags" property is defined in TrackedResource. - - code: OperationIdNounVerb - reason: This is false alarm. We checked that the operation id "Clusters_ListByClusterPoolName" is correct. - - code: GetCollectionOnlyHasValueAndNextLink - reason: This is false alarm. -``` - ---- - -# 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-go - - repo: azure-sdk-for-java - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-resource-manager-schemas - - repo: azure-powershell -``` - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Azure.ResourceManager.HDInsight.Containers - output-folder: $(csharp-sdks-folder)/hdinsight/Azure.ResourceManager.HDInsight.Containers/src/Generated - clear-output-folder: true -``` diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.nodejs.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.nodejs.md deleted file mode 100644 index 5da095ac0e5b..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.nodejs.md +++ /dev/null @@ -1,29 +0,0 @@ -## 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-hdinsightcontainers - output-folder: $(node-sdks-folder)/lib/services/hdInsightContainersManagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` - -## Tag: package-hdinsightcontainers-2023-06-preview and Node.js - -These settings apply only when `--tag=package-hdinsightcontainers-2023-06-preview --nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(tag) == 'package-hdinsightonaks-2023-06-preview' && $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-hdinsightcontainers - output-folder: $(node-sdks-folder)/lib/services/hdInsightContainersManagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.python.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.python.md deleted file mode 100644 index ad7a3c03b301..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.python.md +++ /dev/null @@ -1,25 +0,0 @@ -## 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) -title: HDInsightContainersMgmtClient -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -namespace: azure.mgmt.hdinsightcontainers -package-name: azure-mgmt-hdinsightcontainers -package-version: 1.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/hdinsight/azure-mgmt-hdinsightcontainers/azure/mgmt/hdinsightcontainers -``` - -``` yaml $(python) -modelerfour: - lenient-model-deduplication: true -``` diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.typescript.md b/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.typescript.md deleted file mode 100644 index d575e8875201..000000000000 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/HDInsightOnAks/readme.typescript.md +++ /dev/null @@ -1,12 +0,0 @@ -## 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-hdinsightcontainers" - output-folder: "$(typescript-sdks-folder)/sdk/hdinsight/arm-hdinsightcontainers" - generate-metadata: true -``` diff --git a/specification/hybridconnectivity/HybridConnectivity.Management/PublicCloud.tsp b/specification/hybridconnectivity/HybridConnectivity.Management/PublicCloud.tsp index 63c2f63e6111..63fd2f665def 100644 --- a/specification/hybridconnectivity/HybridConnectivity.Management/PublicCloud.tsp +++ b/specification/hybridconnectivity/HybridConnectivity.Management/PublicCloud.tsp @@ -99,9 +99,9 @@ model PublicCloudConnector is TrackedResource { #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" @doc("Public Cloud Connector") model PublicCloudConnectorUpdate extends TrackedResourceUpdate { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" @doc("The resource-specific properties for this resource.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: PublicCloudConnectorPropertiesUpdate; } @@ -208,9 +208,9 @@ model SolutionConfigurationProperties { @doc("Solution Configuration") model SolutionConfigurationUpdate extends Azure.ResourceManager.CommonTypes.ProxyResource { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" @doc("The resource-specific properties for this resource.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: SolutionConfigurationPropertiesUpdate; } diff --git a/specification/hybridconnectivity/HybridConnectivity.Management/back-compatible.tsp b/specification/hybridconnectivity/HybridConnectivity.Management/back-compatible.tsp new file mode 100644 index 000000000000..02cb9fb90f2d --- /dev/null +++ b/specification/hybridconnectivity/HybridConnectivity.Management/back-compatible.tsp @@ -0,0 +1,13 @@ +import "@azure-tools/typespec-client-generator-core"; + +import "./main.tsp"; + +using Azure.ClientGenerator.Core; +using Microsoft.HybridConnectivity; + +@@Legacy.flattenProperty(EndpointResource.properties, "autorest"); +@@Legacy.flattenProperty(InventoryResource.properties, "autorest"); +@@Legacy.flattenProperty(PublicCloudConnector.properties, "autorest"); +@@Legacy.flattenProperty(ServiceConfigurationResource.properties, "autorest"); +@@Legacy.flattenProperty(SolutionConfiguration.properties, "autorest"); +@@Legacy.flattenProperty(SolutionTypeResource.properties, "autorest"); diff --git a/specification/hybridconnectivity/HybridConnectivity.Management/main.tsp b/specification/hybridconnectivity/HybridConnectivity.Management/main.tsp index 6f4791a3e722..32a131f5bdbb 100644 --- a/specification/hybridconnectivity/HybridConnectivity.Management/main.tsp +++ b/specification/hybridconnectivity/HybridConnectivity.Management/main.tsp @@ -13,6 +13,7 @@ import "./EndpointResource.tsp"; import "./ServiceConfigurationResource.tsp"; import "./PublicCloud.tsp"; import "@azure-tools/typespec-client-generator-core"; +import "./back-compatible.tsp"; using Azure.ClientGenerator.Core; using TypeSpec.Rest; diff --git a/specification/hybridconnectivity/HybridConnectivity.Management/models.tsp b/specification/hybridconnectivity/HybridConnectivity.Management/models.tsp index 84d2033223c1..b070fba3e7f3 100644 --- a/specification/hybridconnectivity/HybridConnectivity.Management/models.tsp +++ b/specification/hybridconnectivity/HybridConnectivity.Management/models.tsp @@ -145,8 +145,8 @@ model ServiceConfigurationResourcePatch { /** * The service configuration properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ServiceConfigurationPropertiesPatch; } @@ -177,8 +177,8 @@ model EndpointAccessResource { /** * Azure relay hybrid connection access properties */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty relay?: RelayNamespaceAccessProperties; } @@ -229,15 +229,15 @@ model IngressGatewayResource { /** * Azure relay hybrid connection access properties */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty relay?: RelayNamespaceAccessProperties; /** * Ingress gateway profile */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty ingress?: IngressProfileProperties; } @@ -253,8 +253,8 @@ model IngressProfileProperties { /** * The AAD Profile */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty aadProfile: AADProfileProperties; } diff --git a/specification/hybridconnectivity/HybridConnectivity.Management/tspconfig.yaml b/specification/hybridconnectivity/HybridConnectivity.Management/tspconfig.yaml index 50fffa34ca80..727608823696 100644 --- a/specification/hybridconnectivity/HybridConnectivity.Management/tspconfig.yaml +++ b/specification/hybridconnectivity/HybridConnectivity.Management/tspconfig.yaml @@ -14,7 +14,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/hybridconnectivity.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + "@azure-tools/typespec-csharp": emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" flavor: "azure" diff --git a/specification/informatica/Informatica.DataManagement.Management/back-compatible.tsp b/specification/informatica/Informatica.DataManagement.Management/back-compatible.tsp new file mode 100644 index 000000000000..6751d52a3cae --- /dev/null +++ b/specification/informatica/Informatica.DataManagement.Management/back-compatible.tsp @@ -0,0 +1,13 @@ +import "@azure-tools/typespec-client-generator-core"; + +import "./main.tsp"; + +using Azure.ClientGenerator.Core; +using Informatica.DataManagement; + +@@Legacy.flattenProperty(InformaticaOrganizationResource.properties, + "autorest" +); +@@Legacy.flattenProperty(InformaticaServerlessRuntimeResource.properties, + "autorest" +); diff --git a/specification/informatica/Informatica.DataManagement.Management/main.tsp b/specification/informatica/Informatica.DataManagement.Management/main.tsp index 170c923f58fc..ef8c2f3f9653 100644 --- a/specification/informatica/Informatica.DataManagement.Management/main.tsp +++ b/specification/informatica/Informatica.DataManagement.Management/main.tsp @@ -1,4 +1,6 @@ import "@typespec/rest"; +import "./back-compatible.tsp"; + import "@typespec/openapi"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; diff --git a/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml b/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml index 8b97fa774d4e..380df64ba4e7 100644 --- a/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml +++ b/specification/informatica/Informatica.DataManagement.Management/tspconfig.yaml @@ -8,8 +8,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-informaticadatamanagement" diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/back-compatible.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/back-compatible.tsp new file mode 100644 index 000000000000..6f830b2867ba --- /dev/null +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/back-compatible.tsp @@ -0,0 +1,14 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using Microsoft.IoTOperationsDataProcessor; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Dataset.properties, + "autorest" +); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Instance.properties, + "autorest" +); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Pipeline.properties, + "autorest" +); diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/main.tsp b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/main.tsp index 785be082c9d4..516e459c0f5d 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/main.tsp +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/main.tsp @@ -3,9 +3,12 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + import "./instance.tsp"; import "./pipeline.tsp"; import "./dataset.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml index bfb5a822f38a..a1d0663c5388 100644 --- a/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml +++ b/specification/iotoperationsdataprocessor/IoTOperationsDataProcessor.Management/tspconfig.yaml @@ -5,8 +5,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" omit-unreachable-types: true linter: diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/back-compatible.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/back-compatible.tsp new file mode 100644 index 000000000000..3af43ada6886 --- /dev/null +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/back-compatible.tsp @@ -0,0 +1,43 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using Microsoft.IoTOperationsMQ; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BrokerAuthenticationResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BrokerAuthorizationResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BrokerListenerResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(BrokerResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DataLakeConnectorResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DiagnosticServiceResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DataLakeTopicMapResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(KafkaConnectorResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(KafkaTopicMapResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MqttBridgeConnectorResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MqResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MqttBridgeTopicMapResource.properties, + "autorest" +); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp b/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp index e2e594541441..b530d792f0e5 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/main.tsp @@ -3,12 +3,14 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; import "./models/datalakeconnector.tsp"; import "./models/diagnosticservice.tsp"; import "./models/mqttbroker.tsp"; import "./models/mqttbridgeconnector.tsp"; import "./models/kafkaconnector.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml b/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml index 054be2f00a65..01c9f345b126 100644 --- a/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml +++ b/specification/iotoperationsmq/IoTOperationsMQ.Management/tspconfig.yaml @@ -5,8 +5,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iotoperationsmq.json" linter: extends: diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/back-compatible.tsp b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/back-compatible.tsp new file mode 100644 index 000000000000..3a1514386476 --- /dev/null +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/back-compatible.tsp @@ -0,0 +1,12 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using Microsoft.IoTOperationsOrchestrator; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Instance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Solution.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Target.properties, + "autorest" +); diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/main.tsp b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/main.tsp index 0ff065c5ebd5..7b98a3d1f6cb 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/main.tsp +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/main.tsp @@ -3,9 +3,12 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + import "./instance.tsp"; import "./target.tsp"; import "./solution.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml index bfb5a822f38a..a1d0663c5388 100644 --- a/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml +++ b/specification/iotoperationsorchestrator/IoTOperationsOrchestrator.Management/tspconfig.yaml @@ -5,8 +5,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" omit-unreachable-types: true linter: diff --git a/specification/keyvault/KeyVault.Management/Secret.tsp b/specification/keyvault/KeyVault.Management/Secret.tsp index 17408d0b0da3..64ff9c3788c6 100644 --- a/specification/keyvault/KeyVault.Management/Secret.tsp +++ b/specification/keyvault/KeyVault.Management/Secret.tsp @@ -57,8 +57,8 @@ interface Secrets { Azure.ResourceManager.Foundations.DefaultBaseParameters >, SecretCreateOrUpdateParameters, - Secret | ArmResourceCreatedResponse, - CloudError + Response = ArmResponse | ArmResourceCreatedSyncResponse, + ErrorResponse = CloudError >; /** diff --git a/specification/keyvault/Security.KeyVault.BackupRestore/tspconfig.yaml b/specification/keyvault/Security.KeyVault.BackupRestore/tspconfig.yaml index 7c66fdef765a..8d21607c0a7b 100644 --- a/specification/keyvault/Security.KeyVault.BackupRestore/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.BackupRestore/tspconfig.yaml @@ -32,6 +32,7 @@ options: inject-spans: true single-client: true generate-fakes: true + omit-constructors: true "@azure-tools/typespec-client-generator-cli": additionalDirectories: - "specification/keyvault/Security.KeyVault.Common/" diff --git a/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml b/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml index e51c896a1498..51f715c4df17 100644 --- a/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.Certificates/tspconfig.yaml @@ -58,6 +58,7 @@ options: single-client: true inject-spans: true generate-fakes: true + omit-constructors: true "@azure-tools/typespec-rust": crate-name: "azure_security_keyvault_certificates" crate-version: "0.0.1" diff --git a/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml b/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml index 6db0743c3222..1650eb016641 100644 --- a/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.Keys/tspconfig.yaml @@ -57,6 +57,7 @@ options: single-client: true inject-spans: true generate-fakes: true + omit-constructors: true "@azure-tools/typespec-rust": crate-name: "azure_security_keyvault_keys" crate-version: "0.0.1" diff --git a/specification/keyvault/Security.KeyVault.RBAC/tspconfig.yaml b/specification/keyvault/Security.KeyVault.RBAC/tspconfig.yaml index a828f5729cf7..de5077b02b10 100644 --- a/specification/keyvault/Security.KeyVault.RBAC/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.RBAC/tspconfig.yaml @@ -32,6 +32,7 @@ options: inject-spans: true single-client: true generate-fakes: true + omit-constructors: true "@azure-tools/typespec-client-generator-cli": additionalDirectories: - "specification/keyvault/Security.KeyVault.Common/" diff --git a/specification/keyvault/Security.KeyVault.Secrets/tspconfig.yaml b/specification/keyvault/Security.KeyVault.Secrets/tspconfig.yaml index 24c6df7cb55f..6e30c222cd7c 100644 --- a/specification/keyvault/Security.KeyVault.Secrets/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.Secrets/tspconfig.yaml @@ -56,6 +56,7 @@ options: single-client: true inject-spans: true generate-fakes: true + omit-constructors: true "@azure-tools/typespec-rust": crate-name: "azure_security_keyvault_secrets" crate-version: "0.0.1" diff --git a/specification/keyvault/Security.KeyVault.Settings/tspconfig.yaml b/specification/keyvault/Security.KeyVault.Settings/tspconfig.yaml index e754bbb61eac..998985a001e9 100644 --- a/specification/keyvault/Security.KeyVault.Settings/tspconfig.yaml +++ b/specification/keyvault/Security.KeyVault.Settings/tspconfig.yaml @@ -31,6 +31,7 @@ options: inject-spans: true single-client: true generate-fakes: true + omit-constructors: true "@azure-tools/typespec-client-generator-cli": additionalDirectories: - "specification/keyvault/Security.KeyVault.Common/" diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2025-05-01/openapi.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2025-05-01/openapi.json index 56f34e07d643..91d2352e888c 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2025-05-01/openapi.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2025-05-01/openapi.json @@ -2613,7 +2613,7 @@ ], "responses": { "200": { - "description": "The request has succeeded.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/Secret" } @@ -2622,13 +2622,6 @@ "description": "Resource 'Secret' create operation succeeded", "schema": { "$ref": "#/definitions/Secret" - }, - "headers": { - "Retry-After": { - "type": "integer", - "format": "int32", - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." - } } }, "default": { diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/back-compatible.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/back-compatible.tsp new file mode 100644 index 000000000000..7c7b8dc23fba --- /dev/null +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/back-compatible.tsp @@ -0,0 +1,11 @@ +import "@azure-tools/typespec-client-generator-core"; + +import "./main.tsp"; + +using Azure.ClientGenerator.Core; +using Microsoft.KubernetesRuntime; + +@@Legacy.flattenProperty(BgpPeer.properties, "autorest"); +@@Legacy.flattenProperty(LoadBalancer.properties, "autorest"); +@@Legacy.flattenProperty(ServiceResource.properties, "autorest"); +@@Legacy.flattenProperty(StorageClassResource.properties, "autorest"); diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/main.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/main.tsp index 89045c8a3037..34c2538aeaed 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/main.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/main.tsp @@ -1,4 +1,6 @@ import "./storageclass.tsp"; +import "./back-compatible.tsp"; + import "./loadbalancer.tsp"; import "./bgppeer.tsp"; import "./service.tsp"; diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml index 64577759ea32..4bca92cb2050 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: resource-manager - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/kubernetesruntime.json" use-read-only-status-schema: true "@azure-tools/typespec-csharp": diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/back-compatible.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/back-compatible.tsp new file mode 100644 index 000000000000..4a3d81eb5c49 --- /dev/null +++ b/specification/liftrastronomer/Astronomer.Astro.Management/back-compatible.tsp @@ -0,0 +1,10 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Astronomer.Astro; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OrganizationResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp index e3fced1943c9..a99f7d817cdc 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp +++ b/specification/liftrastronomer/Astronomer.Astro.Management/main.tsp @@ -1,4 +1,5 @@ import "./LiftrBase.Data/main.tsp"; +import "./back-compatible.tsp"; import "@typespec/rest"; import "@typespec/versioning"; diff --git a/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml b/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml index 7b5578213673..c3eb5d0f71e5 100644 --- a/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml +++ b/specification/liftrastronomer/Astronomer.Astro.Management/tspconfig.yaml @@ -14,8 +14,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/astronomer.json" "@azure-tools/typespec-ts": experimental-extensible-enums: true diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/back-compatible.tsp b/specification/liftrqumulo/Qumulo.Storage.Management/back-compatible.tsp new file mode 100644 index 000000000000..3627498f4e5d --- /dev/null +++ b/specification/liftrqumulo/Qumulo.Storage.Management/back-compatible.tsp @@ -0,0 +1,6 @@ +import "@azure-tools/typespec-client-generator-core"; +import "./LiftrBase.Storage/main.tsp"; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LiftrBase.Storage.FileSystemResource.properties, + "autorest" +); diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp b/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp index 67ecb08e33a9..7a6e0b932b90 100644 --- a/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp +++ b/specification/liftrqumulo/Qumulo.Storage.Management/main.tsp @@ -1,4 +1,5 @@ import "./LiftrBase.Storage/main.tsp"; +import "./back-compatible.tsp"; import "@typespec/rest"; import "@typespec/openapi"; diff --git a/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml b/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml index 5d848840d5a5..23f49780037c 100644 --- a/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml +++ b/specification/liftrqumulo/Qumulo.Storage.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/Qumulo.Storage.json" "@azure-tools/typespec-ts": experimental-extensible-enums: true diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/back-compatible.tsp b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/back-compatible.tsp new file mode 100644 index 000000000000..2e43f10f0c6f --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/back-compatible.tsp @@ -0,0 +1,26 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Microsoft.LoadTestService; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LoadTestMappingResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LoadTestProfileMappingResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LoadTestResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(MaxMonthlyVirtualUserHoursResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(QuotaResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/main.tsp b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/main.tsp index e74f32a155c3..70c67570d566 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/main.tsp +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/main.tsp @@ -4,6 +4,7 @@ import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; import "./routes.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/tspconfig.yaml b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/tspconfig.yaml index 512de0f97265..619b799e7ddd 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/tspconfig.yaml +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/loadtesting/tspconfig.yaml @@ -16,8 +16,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}" output-file: "{version-status}/{version}/loadtestservice.json" omit-unreachable-types: true diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/back-compatible.tsp b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/back-compatible.tsp new file mode 100644 index 000000000000..1dc60399ccf6 --- /dev/null +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/back-compatible.tsp @@ -0,0 +1,20 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Playwright.Management; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PlaywrightQuota.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PlaywrightWorkspace.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PlaywrightWorkspaceQuota.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/main.tsp b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/main.tsp index 11144f03b931..0e02e9123576 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/main.tsp +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/main.tsp @@ -2,6 +2,7 @@ import "@typespec/versioning"; import "@azure-tools/typespec-azure-resource-manager"; import "./typespec/routes.tsp"; import "./typespec/quotas.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Versioning; using Azure.ResourceManager; diff --git a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/tspconfig.yaml b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/tspconfig.yaml index 8dea9181b1f8..16aacdc5c6f5 100644 --- a/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/tspconfig.yaml +++ b/specification/loadtestservice/resource-manager/Microsoft.LoadTestService/playwright/tspconfig.yaml @@ -19,8 +19,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}" output-file: "{version-status}/{version}/playwright.json" omit-unreachable-types: true diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Create.json new file mode 100644 index 000000000000..e2981841f545 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Create.json @@ -0,0 +1,379 @@ +{ + "title": "AccessControlLists_Create_MaximumSet_Gen", + "operationId": "AccessControlLists_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + }, + "tags": { + "keyID": "keyValue" + }, + "location": "eastUs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled", + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "flags": [ + "established" + ], + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ] + }, + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Delete.json new file mode 100644 index 000000000000..af3bdca682f4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AccessControlLists_Delete_MaximumSet_Gen", + "operationId": "AccessControlLists_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Get.json new file mode 100644 index 000000000000..f7ed24e975d1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Get.json @@ -0,0 +1,139 @@ +{ + "title": "AccessControlLists_Get_MaximumSet_Gen", + "operationId": "AccessControlLists_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ListByResourceGroup.json new file mode 100644 index 000000000000..bd804ce29803 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ListByResourceGroup.json @@ -0,0 +1,143 @@ +{ + "title": "AccessControlLists_ListByResourceGroup_MaximumSet_Gen", + "operationId": "AccessControlLists_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ListBySubscription.json new file mode 100644 index 000000000000..1301c9cb6295 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ListBySubscription.json @@ -0,0 +1,142 @@ +{ + "title": "AccessControlLists_ListBySubscription_MaximumSet_Gen", + "operationId": "AccessControlLists_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Resync.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Resync.json new file mode 100644 index 000000000000..f79c7d0440e4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "AccessControlLists_Resync_MaximumSet_Gen", + "operationId": "AccessControlLists_Resync", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Update.json new file mode 100644 index 000000000000..99a8b9b28361 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_Update.json @@ -0,0 +1,253 @@ +{ + "title": "AccessControlLists_Update_MaximumSet_Gen", + "operationId": "AccessControlLists_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "configurationType": "File", + "aclsUrl": "https://microsoft.com/a", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "flags": [ + "established" + ], + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_UpdateAdministrativeState.json new file mode 100644 index 000000000000..5e1c0b468217 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "AccessControlLists_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "AccessControlLists_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ValidateConfiguration.json new file mode 100644 index 000000000000..35c1d0774d10 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/AccessControlLists_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "AccessControlLists_ValidateConfiguration_MaximumSet_Gen", + "operationId": "AccessControlLists_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Create.json new file mode 100644 index 000000000000..8435757ed6ba --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Create.json @@ -0,0 +1,214 @@ +{ + "title": "ExternalNetworks_Create_MaximumSet_Gen", + "operationId": "ExternalNetworks_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "resource": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Delete.json new file mode 100644 index 000000000000..b5115f3fd1ff --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "ExternalNetworks_Delete_MaximumSet_Gen", + "operationId": "ExternalNetworks_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Get.json new file mode 100644 index 000000000000..05c7faa76ea0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Get.json @@ -0,0 +1,85 @@ +{ + "title": "ExternalNetworks_Get_MaximumSet_Gen", + "operationId": "ExternalNetworks_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..b91889ca930d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,89 @@ +{ + "title": "ExternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "ExternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Update.json new file mode 100644 index 000000000000..ab2c984f940b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_Update.json @@ -0,0 +1,144 @@ +{ + "title": "ExternalNetworks_Update_MaximumSet_Gen", + "operationId": "ExternalNetworks_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "properties": { + "properties": { + "annotation": "annotation1", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..ef8f566b574e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "ExternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "ExternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..b9ade0923cc5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "ExternalNetworks_UpdateStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "ExternalNetworks_UpdateStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Create.json new file mode 100644 index 000000000000..59347e9d5ac8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Create.json @@ -0,0 +1,307 @@ +{ + "title": "InternalNetworks_Create_MaximumSet_Gen", + "operationId": "InternalNetworks_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "resource": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Delete.json new file mode 100644 index 000000000000..9fab8dfddc2b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "InternalNetworks_Delete_MaximumSet_Gen", + "operationId": "InternalNetworks_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Get.json new file mode 100644 index 000000000000..35ccdbb97d0a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Get.json @@ -0,0 +1,117 @@ +{ + "title": "InternalNetworks_Get_MaximumSet_Gen", + "operationId": "InternalNetworks_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..61946d006328 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,121 @@ +{ + "title": "InternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "InternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Update.json new file mode 100644 index 000000000000..1202c83d54ee --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_Update.json @@ -0,0 +1,202 @@ +{ + "title": "InternalNetworks_Update_MaximumSet_Gen", + "operationId": "InternalNetworks_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "properties": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0" + } + ], + "ipv6NeighborAddress": [ + { + "address": "10.1.0.0" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..cf9a63327ad8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateBgpAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateBgpAdministrativeState.json new file mode 100644 index 000000000000..5c192ffccb0e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateBgpAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateBgpAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateBgpAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..aa0716adbbfa --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Create.json new file mode 100644 index 000000000000..4d58ba055872 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Create.json @@ -0,0 +1,94 @@ +{ + "title": "InternetGatewayRules_Create_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "resource": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + } + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Delete.json new file mode 100644 index 000000000000..65056d6e5815 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGatewayRules_Delete_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Get.json new file mode 100644 index 000000000000..e874f87557d2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Get.json @@ -0,0 +1,44 @@ +{ + "title": "InternetGatewayRules_Get_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_ListByResourceGroup.json new file mode 100644 index 000000000000..b5adb9b10f5d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "title": "InternetGatewayRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_ListBySubscription.json new file mode 100644 index 000000000000..10288cbdeacf --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "title": "InternetGatewayRules_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Update.json new file mode 100644 index 000000000000..a14bbaf8a375 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGatewayRules_Update.json @@ -0,0 +1,54 @@ +{ + "title": "InternetGatewayRules_Update_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "properties": { + "tags": { + "KeyID": "KeyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Create.json new file mode 100644 index 000000000000..51ba8c7ac127 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Create.json @@ -0,0 +1,83 @@ +{ + "title": "InternetGateways_Create_MaximumSet_Gen", + "operationId": "InternetGateways_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "resource": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Delete.json new file mode 100644 index 000000000000..c3871f28599d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGateways_Delete_MaximumSet_Gen", + "operationId": "InternetGateways_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Get.json new file mode 100644 index 000000000000..533aa77d29d3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Get.json @@ -0,0 +1,40 @@ +{ + "title": "InternetGateways_Get_MaximumSet_Gen", + "operationId": "InternetGateways_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_ListByResourceGroup.json new file mode 100644 index 000000000000..aa66a8cb4c68 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "InternetGateways_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGateways_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_ListBySubscription.json new file mode 100644 index 000000000000..c3dc1f4e3e6b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "InternetGateways_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGateways_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Update.json new file mode 100644 index 000000000000..27ffbae1e2d5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/InternetGateways_Update.json @@ -0,0 +1,53 @@ +{ + "title": "InternetGateways_Update_MaximumSet_Gen", + "operationId": "InternetGateways_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Create.json new file mode 100644 index 000000000000..1595d7cde39e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Create.json @@ -0,0 +1,111 @@ +{ + "title": "IpCommunities_Create_MaximumSet_Gen", + "operationId": "IpCommunities_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Delete.json new file mode 100644 index 000000000000..a512af5dadc9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpCommunities_Delete_MaximumSet_Gen", + "operationId": "IpCommunities_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Get.json new file mode 100644 index 000000000000..1bda305934a4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Get.json @@ -0,0 +1,49 @@ +{ + "title": "IpCommunities_Get_MaximumSet_Gen", + "operationId": "IpCommunities_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..358037fa9ce7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "IpCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_ListBySubscription.json new file mode 100644 index 000000000000..40d5f27cc5f0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "IpCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Update.json new file mode 100644 index 000000000000..a4f1dd442a56 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpCommunities_Update.json @@ -0,0 +1,73 @@ +{ + "title": "IpCommunities_Update_MaximumSet_Gen", + "operationId": "IpCommunities_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "properties": { + "tags": { + "keyID": "KeyValue" + }, + "properties": { + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Create.json new file mode 100644 index 000000000000..9784c4d841f9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Create.json @@ -0,0 +1,102 @@ +{ + "title": "IpExtendedCommunities_Create_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Delete.json new file mode 100644 index 000000000000..5f9d0eff1c00 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpExtendedCommunities_Delete_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Get.json new file mode 100644 index 000000000000..ec299f320b42 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Get.json @@ -0,0 +1,46 @@ +{ + "title": "IpExtendedCommunities_Get_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..2da21b7e47d6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "IpExtendedCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_ListBySubscription.json new file mode 100644 index 000000000000..12cb789b5f91 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "IpExtendedCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Update.json new file mode 100644 index 000000000000..fd353be61c9f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpExtendedCommunities_Update.json @@ -0,0 +1,68 @@ +{ + "title": "IpExtendedCommunities_Update_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Create.json new file mode 100644 index 000000000000..a30c6e3b6e3f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Create.json @@ -0,0 +1,102 @@ +{ + "title": "IpPrefixes_Create_MaximumSet_Gen", + "operationId": "IpPrefixes_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "resource": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Delete.json new file mode 100644 index 000000000000..027a12c980a5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpPrefixes_Delete_MaximumSet_Gen", + "operationId": "IpPrefixes_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Get.json new file mode 100644 index 000000000000..038749b88065 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Get.json @@ -0,0 +1,46 @@ +{ + "title": "IpPrefixes_Get_MaximumSet_Gen", + "operationId": "IpPrefixes_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_ListByResourceGroup.json new file mode 100644 index 000000000000..ddfeff34510f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "IpPrefixes_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpPrefixes_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_ListBySubscription.json new file mode 100644 index 000000000000..a8800a55e0b6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "IpPrefixes_ListBySubscription_MaximumSet_Gen", + "operationId": "IpPrefixes_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Update.json new file mode 100644 index 000000000000..ed11bbef6c01 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/IpPrefixes_Update.json @@ -0,0 +1,68 @@ +{ + "title": "IpPrefixes_Update_MaximumSet_Gen", + "operationId": "IpPrefixes_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..ee171335ad5a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L2IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Create.json new file mode 100644 index 000000000000..1de2ad9ab7a2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Create.json @@ -0,0 +1,84 @@ +{ + "title": "L2IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Delete.json new file mode 100644 index 000000000000..f155078736b3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L2IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Get.json new file mode 100644 index 000000000000..aee14a158a8a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Get.json @@ -0,0 +1,40 @@ +{ + "title": "L2IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..b58030db7cf4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "L2IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..8166ad90af19 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "L2IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Update.json new file mode 100644 index 000000000000..574cf8c6e427 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_Update.json @@ -0,0 +1,54 @@ +{ + "title": "L2IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "mtu": 6000 + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..4c41075e244a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L2IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L2IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..c2c5404c4d12 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L2IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L2IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..aa19da8b7db9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L3IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Create.json new file mode 100644 index 000000000000..97258c850bbb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Create.json @@ -0,0 +1,141 @@ +{ + "title": "L3IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "resource": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Delete.json new file mode 100644 index 000000000000..3e7e92d99f82 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L3IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Get.json new file mode 100644 index 000000000000..45a422ec262a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Get.json @@ -0,0 +1,59 @@ +{ + "title": "L3IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..762800d137ca --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "title": "L3IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..3ae67b0153cc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ListBySubscription.json @@ -0,0 +1,62 @@ +{ + "title": "L3IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Update.json new file mode 100644 index 000000000000..edf53b33053b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_Update.json @@ -0,0 +1,93 @@ +{ + "title": "L3IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..f66155236fa4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L3IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L3IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..5c2bb706532c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/L3IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L3IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "mg" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Create.json new file mode 100644 index 000000000000..49ceed7a8eb8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Create.json @@ -0,0 +1,130 @@ +{ + "title": "NeighborGroups_Create_MaximumSet_Gen", + "operationId": "NeighborGroups_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "resource": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Delete.json new file mode 100644 index 000000000000..cfdd3f3059a3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NeighborGroups_Delete_MaximumSet_Gen", + "operationId": "NeighborGroups_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Get.json new file mode 100644 index 000000000000..a32e9f8367ac --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Get.json @@ -0,0 +1,57 @@ +{ + "title": "NeighborGroups_Get_MaximumSet_Gen", + "operationId": "NeighborGroups_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..4bf98890980d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "NeighborGroups_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NeighborGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_ListBySubscription.json new file mode 100644 index 000000000000..aeaada7a7baf --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "NeighborGroups_ListBySubscription_MaximumSet_Gen", + "operationId": "NeighborGroups_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Update.json new file mode 100644 index 000000000000..3e56806ea0f4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NeighborGroups_Update.json @@ -0,0 +1,86 @@ +{ + "title": "NeighborGroups_Update_MaximumSet_Gen", + "operationId": "NeighborGroups_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "Updating", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDeviceSkus_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDeviceSkus_Get.json new file mode 100644 index 000000000000..46d749b6cd00 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDeviceSkus_Get.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkDeviceSkus_Get_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkDeviceSkuName": "example-deviceSku" + }, + "responses": { + "200": { + "body": { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDeviceSkus_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDeviceSkus_ListBySubscription.json new file mode 100644 index 000000000000..3ae43e057f80 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDeviceSkus_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "NetworkDeviceSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Create.json new file mode 100644 index 000000000000..b5993dc3080d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Create.json @@ -0,0 +1,95 @@ +{ + "title": "NetworkDevices_Create_MaximumSet_Gen", + "operationId": "NetworkDevices_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "resource": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Delete.json new file mode 100644 index 000000000000..4d483128670a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkDevices_Delete_MaximumSet_Gen", + "operationId": "NetworkDevices_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Get.json new file mode 100644 index 000000000000..be1f976e9898 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Get.json @@ -0,0 +1,45 @@ +{ + "title": "NetworkDevices_Get_MaximumSet_Gen", + "operationId": "NetworkDevices_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..e8c7c84bbdc0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "title": "NetworkDevices_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_ListBySubscription.json new file mode 100644 index 000000000000..8559a3beb510 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "NetworkDevices_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDevices_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Reboot.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Reboot.json new file mode 100644 index 000000000000..6f3a91cbb09d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Reboot.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Reboot_MaximumSet_Gen", + "operationId": "NetworkDevices_Reboot", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "rebootType": "GracefulRebootWithZTP" + } + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RefreshConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RefreshConfiguration.json new file mode 100644 index 000000000000..93586a346895 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkDevices_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkDevices_RefreshConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RunRoCommand.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RunRoCommand.json new file mode 100644 index 000000000000..91025ecd7805 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RunRoCommand.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkDevices_RunRoCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRoCommand", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "sigtufivipqdapgglzi" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "svvzwijqaghjlelhr", + "message": "kgttomemzowwdiqvbtqlrd", + "target": "txdqddgrezjihhhrmdovikhm", + "details": [], + "additionalInfo": [ + { + "type": "vcaekwfqlkfzcjompti", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "outputUrl": "dxzpukpwdgo" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RunRwCommand.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RunRwCommand.json new file mode 100644 index 000000000000..4a9ea97ea83f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_RunRwCommand.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkDevices_RunRwCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRwCommand", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "yzuabghycngqmqtfacvoh" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "svvzwijqaghjlelhr", + "message": "kgttomemzowwdiqvbtqlrd", + "target": "txdqddgrezjihhhrmdovikhm", + "details": [], + "additionalInfo": [ + { + "type": "vcaekwfqlkfzcjompti", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "outputUrl": "hypjtiwzhevuc" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Update.json new file mode 100644 index 000000000000..392bf8fe6175 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Update.json @@ -0,0 +1,60 @@ +{ + "title": "NetworkDevices_Update_MaximumSet_Gen", + "operationId": "NetworkDevices_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_UpdateAdministrativeState.json new file mode 100644 index 000000000000..e1bd7f7794e6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkDevices_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkDevices_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "resourceIds": [ + "" + ], + "state": "RMA" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Upgrade.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Upgrade.json new file mode 100644 index 000000000000..28c627fccf75 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkDevices_Upgrade.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Upgrade_MaximumSet_Gen", + "operationId": "NetworkDevices_Upgrade", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "version": "1.0.0" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Create.json new file mode 100644 index 000000000000..b1c6ab25f476 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Create.json @@ -0,0 +1,176 @@ +{ + "title": "NetworkFabricControllers_Create_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "resource": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "isWorkloadManagementNetworkEnabled": "True", + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Delete.json new file mode 100644 index 000000000000..8f91ec82c5a4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabricControllers_Delete_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Get.json new file mode 100644 index 000000000000..2e7178462006 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Get.json @@ -0,0 +1,72 @@ +{ + "title": "NetworkFabricControllers_Get_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_ListByResourceGroup.json new file mode 100644 index 000000000000..3541ae52cc03 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_ListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "title": "NetworkFabricControllers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_ListBySubscription.json new file mode 100644 index 000000000000..bad557fcec40 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_ListBySubscription.json @@ -0,0 +1,75 @@ +{ + "title": "NetworkFabricControllers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Update.json new file mode 100644 index 000000000000..9ab3eba8b2a8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricControllers_Update.json @@ -0,0 +1,96 @@ +{ + "title": "NetworkFabricControllers_Update_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricSkus_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricSkus_Get.json new file mode 100644 index 000000000000..c8172a76d1f6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricSkus_Get.json @@ -0,0 +1,36 @@ +{ + "title": "NetworkFabricSkus_Get_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkFabricSkuName": "wxample-fabricsku" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricSkus_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricSkus_ListBySubscription.json new file mode 100644 index 000000000000..ad538f69e92f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabricSkus_ListBySubscription.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabricSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_CommitConfiguration.json new file mode 100644 index 000000000000..deed3be982e5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_CommitConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-networkFabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Create.json new file mode 100644 index 000000000000..975097cf74f7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Create.json @@ -0,0 +1,397 @@ +{ + "title": "NetworkFabrics_Create_MaximumSet_Gen", + "operationId": "NetworkFabrics_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "password": "xxx-xx-xx", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Delete.json new file mode 100644 index 000000000000..d0c139f7c23c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabrics_Delete_MaximumSet_Gen", + "operationId": "NetworkFabrics_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Deprovision.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Deprovision.json new file mode 100644 index 000000000000..140aa94f5019 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Deprovision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Deprovision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Deprovision", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Get.json new file mode 100644 index 000000000000..fe9da64b52d9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Get.json @@ -0,0 +1,150 @@ +{ + "title": "NetworkFabrics_Get_MaximumSet_Gen", + "operationId": "NetworkFabrics_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_GetTopology.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_GetTopology.json new file mode 100644 index 000000000000..c71871703bdd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_GetTopology.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkFabrics_GetTopology_MaximumSet_Gen", + "operationId": "NetworkFabrics_GetTopology", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ListByResourceGroup.json new file mode 100644 index 000000000000..b4d37a7c3ecc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ListByResourceGroup.json @@ -0,0 +1,154 @@ +{ + "title": "NetworkFabrics_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ListBySubscription.json new file mode 100644 index 000000000000..829492311a93 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ListBySubscription.json @@ -0,0 +1,153 @@ +{ + "title": "NetworkFabrics_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Provision.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Provision.json new file mode 100644 index 000000000000..45c3065d6248 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Provision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Provision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Provision", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_RefreshConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_RefreshConfiguration.json new file mode 100644 index 000000000000..bd34a828d128 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_RefreshConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Update.json new file mode 100644 index 000000000000..14dd18529410 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Update.json @@ -0,0 +1,257 @@ +{ + "title": "NetworkFabrics_Update_MaximumSet_Gen", + "operationId": "NetworkFabrics_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation1", + "rackCount": 6, + "serverCountPerRack": 10, + "ipv4Prefix": "10.18.0.0/17", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/60", + "fabricASN": 12345, + "terminalServerConfiguration": { + "username": "username1", + "password": "xxxxxxxx", + "serialNumber": "1234567", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json new file mode 100644 index 000000000000..3478e9396b91 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateInfraManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateInfraManagementBfdConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json new file mode 100644 index 000000000000..435d85e516b3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Upgrade.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Upgrade.json new file mode 100644 index 000000000000..518795125fd7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_Upgrade.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_Upgrade_MaximumSet_Gen", + "operationId": "NetworkFabrics_Upgrade", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "version": "3.x.x", + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ValidateConfiguration.json new file mode 100644 index 000000000000..f18b605ff9b0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkFabrics_ValidateConfiguration.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "validateAction": "Cabling" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Create.json new file mode 100644 index 000000000000..7b5c37e90538 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Create.json @@ -0,0 +1,73 @@ +{ + "title": "NetworkInterfaces_Create_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "resource": { + "properties": { + "annotation": "annotation", + "interfaceType": "Management", + "administrativeState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..71f733e6e126 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkInterfaces_Delete_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..0efe58de95b2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Get.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkInterfaces_Get_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_ListByNetworkDevice.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_ListByNetworkDevice.json new file mode 100644 index 000000000000..788fce977a3a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_ListByNetworkDevice.json @@ -0,0 +1,42 @@ +{ + "title": "NetworkInterfaces_ListByNetworkDevice_MaximumSet_Gen", + "operationId": "NetworkInterfaces_ListByNetworkDevice", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..0d58ef795203 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_Update.json @@ -0,0 +1,48 @@ +{ + "title": "NetworkInterfaces_Update_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "properties": { + "properties": { + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_UpdateAdministrativeState.json new file mode 100644 index 000000000000..52003d2e427d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkInterfaces_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkInterfaces_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkInterfaces_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Create.json new file mode 100644 index 000000000000..4084af2eda20 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Create.json @@ -0,0 +1,94 @@ +{ + "title": "NetworkPacketBrokers_Create_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "resource": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Delete.json new file mode 100644 index 000000000000..b1aa7b0ea835 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkPacketBrokers_Delete_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Get.json new file mode 100644 index 000000000000..8eedd3e13ca3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Get.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkPacketBrokers_Get_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_ListByResourceGroup.json new file mode 100644 index 000000000000..79b74669e55d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "NetworkPacketBrokers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_ListBySubscription.json new file mode 100644 index 000000000000..a827dfdc412a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkPacketBrokers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Update.json new file mode 100644 index 000000000000..cb133c0cdab6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkPacketBrokers_Update.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkPacketBrokers_Update_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Create.json new file mode 100644 index 000000000000..9a01bbe9eb53 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Create.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkRacks_Create_MaximumSet_Gen", + "operationId": "NetworkRacks_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "resource": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Delete.json new file mode 100644 index 000000000000..90584c3a3af3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkRacks_Delete_MaximumSet_Gen", + "operationId": "NetworkRacks_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Get.json new file mode 100644 index 000000000000..91f7bd200a8c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Get.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkRacks_Get_MaximumSet_Gen", + "operationId": "NetworkRacks_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_ListByResourceGroup.json new file mode 100644 index 000000000000..8a1330a9c76b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "NetworkRacks_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkRacks_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_ListBySubscription.json new file mode 100644 index 000000000000..af7bd05d13f1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkRacks_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkRacks_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Update.json new file mode 100644 index 000000000000..99fbed98d4cd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkRacks_Update.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkRacks_Update_MaximumSet_Gen", + "operationId": "NetworkRacks_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Create.json new file mode 100644 index 000000000000..00dc44691afe --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Create.json @@ -0,0 +1,340 @@ +{ + "title": "NetworkTapRules_Create_MaximumSet_Gen", + "operationId": "NetworkTapRules_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "pollingIntervalInSeconds": 30, + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Delete.json new file mode 100644 index 000000000000..cb2fbbb2943a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTapRules_Delete_MaximumSet_Gen", + "operationId": "NetworkTapRules_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Get.json new file mode 100644 index 000000000000..9edce7cd0d27 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Get.json @@ -0,0 +1,126 @@ +{ + "title": "NetworkTapRules_Get_MaximumSet_Gen", + "operationId": "NetworkTapRules_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ListByResourceGroup.json new file mode 100644 index 000000000000..2128f9c21a45 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ListByResourceGroup.json @@ -0,0 +1,130 @@ +{ + "title": "NetworkTapRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ListBySubscription.json new file mode 100644 index 000000000000..82c413a364d5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ListBySubscription.json @@ -0,0 +1,129 @@ +{ + "title": "NetworkTapRules_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Resync.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Resync.json new file mode 100644 index 000000000000..700cdeda9234 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTapRules_Resync_MaximumSet_Gen", + "operationId": "NetworkTapRules_Resync", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Update.json new file mode 100644 index 000000000000..05e0f9fb0031 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_Update.json @@ -0,0 +1,225 @@ +{ + "title": "NetworkTapRules_Update_MaximumSet_Gen", + "operationId": "NetworkTapRules_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/amdsdx", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_UpdateAdministrativeState.json new file mode 100644 index 000000000000..a6ef36b88911 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkTapRules_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTapRules_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ValidateConfiguration.json new file mode 100644 index 000000000000..281321d62333 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTapRules_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkTapRules_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkTapRules_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Create.json new file mode 100644 index 000000000000..5642fb074109 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Create.json @@ -0,0 +1,125 @@ +{ + "title": "NetworkTaps_Create_MaximumSet_Gen", + "operationId": "NetworkTaps_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "resource": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Delete.json new file mode 100644 index 000000000000..68045cbc4ade --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTaps_Delete_MaximumSet_Gen", + "operationId": "NetworkTaps_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Get.json new file mode 100644 index 000000000000..287179c06ac5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Get.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkTaps_Get_MaximumSet_Gen", + "operationId": "NetworkTaps_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_ListByResourceGroup.json new file mode 100644 index 000000000000..b13b23d36099 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_ListByResourceGroup.json @@ -0,0 +1,58 @@ +{ + "title": "NetworkTaps_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTaps_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_ListBySubscription.json new file mode 100644 index 000000000000..6dc9c84c98db --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_ListBySubscription.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkTaps_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTaps_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Resync.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Resync.json new file mode 100644 index 000000000000..3d231062a446 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTaps_Resync_MaximumSet_Gen", + "operationId": "NetworkTaps_Resync", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Update.json new file mode 100644 index 000000000000..d915ef60c312 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_Update.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkTaps_Update_MaximumSet_Gen", + "operationId": "NetworkTaps_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation1", + "pollingType": "Pull", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_UpdateAdministrativeState.json new file mode 100644 index 000000000000..c06540817af3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkTaps_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkTaps_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTaps_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Create.json new file mode 100644 index 000000000000..0305f288a174 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Create.json @@ -0,0 +1,211 @@ +{ + "title": "NetworkToNetworkInterconnects_Create_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "resource": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Delete.json new file mode 100644 index 000000000000..454a58faf0c3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkToNetworkInterconnects_Delete_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Get.json new file mode 100644 index 000000000000..0e26b026c3ad --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Get.json @@ -0,0 +1,84 @@ +{ + "title": "NetworkToNetworkInterconnects_Get_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_ListByNetworkFabric.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_ListByNetworkFabric.json new file mode 100644 index 000000000000..ec5ecac1f7d9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_ListByNetworkFabric.json @@ -0,0 +1,88 @@ +{ + "title": "NetworkToNetworkInterconnects_ListByNetworkFabric_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_ListByNetworkFabric", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Update.json new file mode 100644 index 000000000000..c202ce3d7f5e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_Update.json @@ -0,0 +1,139 @@ +{ + "title": "NetworkToNetworkInterconnects_Update_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "properties": { + "properties": { + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "20.0.0.12/29", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.14/29", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 2345, + "vlanId": 1235 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_UpdateAdministrativeState.json new file mode 100644 index 000000000000..366039ba84bf --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..e68765388922 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/Operations_List.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/Operations_List.json new file mode 100644 index 000000000000..e752db72760e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/Operations_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Read", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Gets/List NetworkFabricController resources.", + "description": "Gets/List the NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Write", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Create or Update NetworkFabricController resource.", + "description": "Create or Update NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Delete", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Deletes the NetworkFabricController resource.", + "description": "Deletes the NetworkFabricController resource." + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen" +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_CommitConfiguration.json new file mode 100644 index 000000000000..c0abcc368cc3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "RoutePolicies_CommitConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Create.json new file mode 100644 index 000000000000..7692fa8cec05 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Create.json @@ -0,0 +1,246 @@ +{ + "title": "RoutePolicies_Create_MaximumSet_Gen", + "operationId": "RoutePolicies_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "resource": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Delete.json new file mode 100644 index 000000000000..394c5799f5e2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RoutePolicies_Delete_MaximumSet_Gen", + "operationId": "RoutePolicies_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Get.json new file mode 100644 index 000000000000..d2be66d5fc46 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Get.json @@ -0,0 +1,94 @@ +{ + "title": "RoutePolicies_Get_MaximumSet_Gen", + "operationId": "RoutePolicies_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..c389e077a3aa --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ListByResourceGroup.json @@ -0,0 +1,98 @@ +{ + "title": "RoutePolicies_ListByResourceGroup_MaximumSet_Gen", + "operationId": "RoutePolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ListBySubscription.json new file mode 100644 index 000000000000..a7f47a51dae4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ListBySubscription.json @@ -0,0 +1,97 @@ +{ + "title": "RoutePolicies_ListBySubscription_MaximumSet_Gen", + "operationId": "RoutePolicies_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Update.json new file mode 100644 index 000000000000..210aabe13601 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_Update.json @@ -0,0 +1,161 @@ +{ + "title": "RoutePolicies_Update_MaximumSet_Gen", + "operationId": "RoutePolicies_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_UpdateAdministrativeState.json new file mode 100644 index 000000000000..9bb4b8110cef --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "RoutePolicies_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "RoutePolicies_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ValidateConfiguration.json new file mode 100644 index 000000000000..fa11d7b11a20 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-02-15-preview/RoutePolicies_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "RoutePolicies_ValidateConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Create.json new file mode 100644 index 000000000000..0a1fffd3c3f9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Create.json @@ -0,0 +1,457 @@ +{ + "title": "AccessControlLists_Create_MaximumSet_Gen", + "operationId": "AccessControlLists_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + } + }, + "tags": { + "keyID": "keyValue" + }, + "location": "eastUs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Delete.json new file mode 100644 index 000000000000..3cefd65c2e0e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AccessControlLists_Delete_MaximumSet_Gen", + "operationId": "AccessControlLists_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Get.json new file mode 100644 index 000000000000..e9d396a65713 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Get.json @@ -0,0 +1,166 @@ +{ + "title": "AccessControlLists_Get_MaximumSet_Gen", + "operationId": "AccessControlLists_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ListByResourceGroup.json new file mode 100644 index 000000000000..cba54d8fba1e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ListByResourceGroup.json @@ -0,0 +1,170 @@ +{ + "title": "AccessControlLists_ListByResourceGroup_MaximumSet_Gen", + "operationId": "AccessControlLists_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ListBySubscription.json new file mode 100644 index 000000000000..123cae6f5ddd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ListBySubscription.json @@ -0,0 +1,169 @@ +{ + "title": "AccessControlLists_ListBySubscription_MaximumSet_Gen", + "operationId": "AccessControlLists_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Resync.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Resync.json new file mode 100644 index 000000000000..01d3ca5bd192 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "AccessControlLists_Resync_MaximumSet_Gen", + "operationId": "AccessControlLists_Resync", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Update.json new file mode 100644 index 000000000000..d46cf9755223 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_Update.json @@ -0,0 +1,304 @@ +{ + "title": "AccessControlLists_Update_MaximumSet_Gen", + "operationId": "AccessControlLists_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "configurationType": "File", + "aclsUrl": "https://microsoft.com/a", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "protocolNeighbors": [ + "example-neighbor" + ], + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "remark-comment", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_UpdateAdministrativeState.json new file mode 100644 index 000000000000..a7b43bbb1a22 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "AccessControlLists_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "AccessControlLists_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ValidateConfiguration.json new file mode 100644 index 000000000000..81b6a94e7b8f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/AccessControlLists_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "AccessControlLists_ValidateConfiguration_MaximumSet_Gen", + "operationId": "AccessControlLists_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Create.json new file mode 100644 index 000000000000..70996a3338d7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Create.json @@ -0,0 +1,351 @@ +{ + "title": "ExternalNetworks_Create_MaximumSet_Gen", + "operationId": "ExternalNetworks_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "resource": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Delete.json new file mode 100644 index 000000000000..18cc361079eb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "ExternalNetworks_Delete_MaximumSet_Gen", + "operationId": "ExternalNetworks_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Get.json new file mode 100644 index 000000000000..998babe4aebc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Get.json @@ -0,0 +1,132 @@ +{ + "title": "ExternalNetworks_Get_MaximumSet_Gen", + "operationId": "ExternalNetworks_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..bec10c2d0cfe --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,136 @@ +{ + "title": "ExternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "ExternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/14", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Update.json new file mode 100644 index 000000000000..44f02e6664ff --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_Update.json @@ -0,0 +1,211 @@ +{ + "title": "ExternalNetworks_Update_MaximumSet_Gen", + "operationId": "ExternalNetworks_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "properties": { + "properties": { + "annotation": "annotation1", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 13, + "threshold": 24, + "idleTimeExpiry": 8 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 13, + "threshold": 24, + "idleTimeExpiry": 8 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/14", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..b99bfe2d77a5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "ExternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "ExternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_UpdateBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_UpdateBfdAdministrativeState.json new file mode 100644 index 000000000000..91034d0e614a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/ExternalNetworks_UpdateBfdAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "ExternalNetworks_UpdateBfdAdministrativeState", + "operationId": "ExternalNetworks_UpdateBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "routeType": "Static", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "routeType": "Static", + "administrativeState": "Enable", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Create.json new file mode 100644 index 000000000000..8aacf8f265c4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Create.json @@ -0,0 +1,397 @@ +{ + "title": "InternalNetworks_Create_MaximumSet_Gen", + "operationId": "InternalNetworks_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "resource": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Delete.json new file mode 100644 index 000000000000..5f00e70f4ee8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "InternalNetworks_Delete_MaximumSet_Gen", + "operationId": "InternalNetworks_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Get.json new file mode 100644 index 000000000000..ccc0f105724f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Get.json @@ -0,0 +1,148 @@ +{ + "title": "InternalNetworks_Get_MaximumSet_Gen", + "operationId": "InternalNetworks_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1/24" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..226e7ae9b7c1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,152 @@ +{ + "title": "InternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "InternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1/24" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Update.json new file mode 100644 index 000000000000..82745398d8ce --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_Update.json @@ -0,0 +1,258 @@ +{ + "title": "InternalNetworks_Update_MaximumSet_Gen", + "operationId": "InternalNetworks_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "properties": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "ipv6NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.10" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 6, + "idleTimeExpiry": 20 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 6, + "idleTimeExpiry": 20 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 7, + "idleTimeExpiry": 20 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 7, + "idleTimeExpiry": 20 + } + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..e478dbdd8557 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateBfdAdministrativeState.json new file mode 100644 index 000000000000..8a6aaf9a9d29 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateBfdAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "InternalNetworks_UpdateBfdAdministrativeState", + "operationId": "InternalNetworks_UpdateBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "routeType": "Static", + "neighborAddress": "10.10.1.10", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "neighborAddressAdministrativeStatus": [ + { + "neighborAddress": "10.10.1.10", + "administrativeState": "Enable", + "error": "" + } + ], + "error": { + "code": "bidbvvmy", + "message": "ekbarfd", + "target": "wpnbisaqlnidiilkhaadmu", + "details": [], + "additionalInfo": [ + { + "type": "qakayuauodscmplibrcmvrnvfnia", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateBgpAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateBgpAdministrativeState.json new file mode 100644 index 000000000000..eb416992983f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternalNetworks_UpdateBgpAdministrativeState.json @@ -0,0 +1,45 @@ +{ + "title": "InternalNetworks_UpdateBgpAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateBgpAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "neighborAddress": "10.10.10.10", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "neighborAddressAdministrativeStatus": [ + { + "neighborAddress": "10.10.10.10", + "administrativeState": "Enable", + "error": "" + } + ], + "error": { + "code": "bidbvvmy", + "message": "ekbarfd", + "target": "wpnbisaqlnidiilkhaadmu", + "details": [], + "additionalInfo": [ + { + "type": "qakayuauodscmplibrcmvrnvfnia", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Create.json new file mode 100644 index 000000000000..c8e8c74032d3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Create.json @@ -0,0 +1,139 @@ +{ + "title": "InternetGatewayRules_Create_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "resource": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + } + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Delete.json new file mode 100644 index 000000000000..8906fb215958 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGatewayRules_Delete_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Get.json new file mode 100644 index 000000000000..972a8004d9ca --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Get.json @@ -0,0 +1,62 @@ +{ + "title": "InternetGatewayRules_Get_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_ListByResourceGroup.json new file mode 100644 index 000000000000..3ecabbd7f646 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "title": "InternetGatewayRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_ListBySubscription.json new file mode 100644 index 000000000000..61659b5d2568 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "title": "InternetGatewayRules_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Update.json new file mode 100644 index 000000000000..ea5c146c2d38 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGatewayRules_Update.json @@ -0,0 +1,69 @@ +{ + "title": "InternetGatewayRules_Update_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "properties": { + "tags": { + "KeyID": "KeyValue1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue1" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Create.json new file mode 100644 index 000000000000..5fc7fc6436f7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Create.json @@ -0,0 +1,86 @@ +{ + "title": "InternetGateways_Create_MaximumSet_Gen", + "operationId": "InternetGateways_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "resource": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Delete.json new file mode 100644 index 000000000000..f67ab2d2ac1b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGateways_Delete_MaximumSet_Gen", + "operationId": "InternetGateways_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Get.json new file mode 100644 index 000000000000..750ab3e8bd04 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Get.json @@ -0,0 +1,44 @@ +{ + "title": "InternetGateways_Get_MaximumSet_Gen", + "operationId": "InternetGateways_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_ListByResourceGroup.json new file mode 100644 index 000000000000..915937f220af --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "title": "InternetGateways_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGateways_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_ListBySubscription.json new file mode 100644 index 000000000000..3c7ffd6d0975 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "title": "InternetGateways_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGateways_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Update.json new file mode 100644 index 000000000000..f64b052f581d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/InternetGateways_Update.json @@ -0,0 +1,54 @@ +{ + "title": "InternetGateways_Update_MaximumSet_Gen", + "operationId": "InternetGateways_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Create.json new file mode 100644 index 000000000000..1f13a23728e0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Create.json @@ -0,0 +1,113 @@ +{ + "title": "IpCommunities_Create_MaximumSet_Gen", + "operationId": "IpCommunities_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Delete.json new file mode 100644 index 000000000000..6ca7f53e4766 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpCommunities_Delete_MaximumSet_Gen", + "operationId": "IpCommunities_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Get.json new file mode 100644 index 000000000000..1a0b5dcb42cf --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Get.json @@ -0,0 +1,53 @@ +{ + "title": "IpCommunities_Get_MaximumSet_Gen", + "operationId": "IpCommunities_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..42e841dbeca8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "IpCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_ListBySubscription.json new file mode 100644 index 000000000000..25515ddc7a99 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "IpCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Update.json new file mode 100644 index 000000000000..a5a082201433 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpCommunities_Update.json @@ -0,0 +1,74 @@ +{ + "title": "IpCommunities_Update_MaximumSet_Gen", + "operationId": "IpCommunities_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "properties": { + "tags": { + "keyID": "KeyValue" + }, + "properties": { + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Create.json new file mode 100644 index 000000000000..c390472a2cb5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Create.json @@ -0,0 +1,104 @@ +{ + "title": "IpExtendedCommunities_Create_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Delete.json new file mode 100644 index 000000000000..24bc034f2b9b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpExtendedCommunities_Delete_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Get.json new file mode 100644 index 000000000000..9d360eef9c5c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Get.json @@ -0,0 +1,50 @@ +{ + "title": "IpExtendedCommunities_Get_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..381c30d93453 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "IpExtendedCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_ListBySubscription.json new file mode 100644 index 000000000000..3c5017672ba1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "IpExtendedCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Update.json new file mode 100644 index 000000000000..308496e4220c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpExtendedCommunities_Update.json @@ -0,0 +1,69 @@ +{ + "title": "IpExtendedCommunities_Update_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Create.json new file mode 100644 index 000000000000..1b972143335c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Create.json @@ -0,0 +1,104 @@ +{ + "title": "IpPrefixes_Create_MaximumSet_Gen", + "operationId": "IpPrefixes_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "resource": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Delete.json new file mode 100644 index 000000000000..a6378236bb64 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpPrefixes_Delete_MaximumSet_Gen", + "operationId": "IpPrefixes_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Get.json new file mode 100644 index 000000000000..4e994e543405 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Get.json @@ -0,0 +1,50 @@ +{ + "title": "IpPrefixes_Get_MaximumSet_Gen", + "operationId": "IpPrefixes_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_ListByResourceGroup.json new file mode 100644 index 000000000000..e620afe892e5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "IpPrefixes_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpPrefixes_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_ListBySubscription.json new file mode 100644 index 000000000000..0fc0d584aae1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "IpPrefixes_ListBySubscription_MaximumSet_Gen", + "operationId": "IpPrefixes_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Update.json new file mode 100644 index 000000000000..5ae33efd32d1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/IpPrefixes_Update.json @@ -0,0 +1,69 @@ +{ + "title": "IpPrefixes_Update_MaximumSet_Gen", + "operationId": "IpPrefixes_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..f627d7cdc9fb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L2IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Create.json new file mode 100644 index 000000000000..8d25ea059ffa --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Create.json @@ -0,0 +1,96 @@ +{ + "title": "L2IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Delete.json new file mode 100644 index 000000000000..fd833e932122 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L2IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Get.json new file mode 100644 index 000000000000..30a92bf1bb91 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Get.json @@ -0,0 +1,45 @@ +{ + "title": "L2IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..e231b5e86d53 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "title": "L2IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..ec76a873fd3d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "L2IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Update.json new file mode 100644 index 000000000000..c6ac3ffd60d1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_Update.json @@ -0,0 +1,57 @@ +{ + "title": "L2IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "mtu": 6000, + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..8eafd68370a0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L2IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L2IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..5a5cc173f414 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L2IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L2IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..3c74f41369bc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L3IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Create.json new file mode 100644 index 000000000000..349799982cc8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Create.json @@ -0,0 +1,179 @@ +{ + "title": "L3IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "resource": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": {}, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 90 + }, + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 90 + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 90 + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Delete.json new file mode 100644 index 000000000000..dff9f7a7d2fc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L3IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Get.json new file mode 100644 index 000000000000..95c165f91309 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Get.json @@ -0,0 +1,76 @@ +{ + "title": "L3IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 10 + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..18a923d41a46 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,80 @@ +{ + "title": "L3IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 50 + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..8d4ea4e199fd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ListBySubscription.json @@ -0,0 +1,79 @@ +{ + "title": "L3IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 50 + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Update.json new file mode 100644 index 000000000000..28ad79dcd17c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_Update.json @@ -0,0 +1,116 @@ +{ + "title": "L3IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "routePrefixLimit": { + "hardLimit": 28, + "threshold": 50 + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 28, + "threshold": 90 + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..0d79600c31e0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L3IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L3IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..e8c10f5f9645 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/L3IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L3IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "mg" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Create.json new file mode 100644 index 000000000000..e6549c7ac906 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Create.json @@ -0,0 +1,130 @@ +{ + "title": "NeighborGroups_Create_MaximumSet_Gen", + "operationId": "NeighborGroups_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "resource": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Delete.json new file mode 100644 index 000000000000..10585dc47608 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NeighborGroups_Delete_MaximumSet_Gen", + "operationId": "NeighborGroups_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Get.json new file mode 100644 index 000000000000..0b6fbece5896 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Get.json @@ -0,0 +1,60 @@ +{ + "title": "NeighborGroups_Get_MaximumSet_Gen", + "operationId": "NeighborGroups_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..9dc246eda890 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "title": "NeighborGroups_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NeighborGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_ListBySubscription.json new file mode 100644 index 000000000000..0746e509467e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "title": "NeighborGroups_ListBySubscription_MaximumSet_Gen", + "operationId": "NeighborGroups_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Update.json new file mode 100644 index 000000000000..52ea00af47f9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NeighborGroups_Update.json @@ -0,0 +1,86 @@ +{ + "title": "NeighborGroups_Update_MaximumSet_Gen", + "operationId": "NeighborGroups_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "Updating", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDeviceSkus_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDeviceSkus_Get.json new file mode 100644 index 000000000000..860961e62917 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDeviceSkus_Get.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkDeviceSkus_Get_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkDeviceSkuName": "example-deviceSku" + }, + "responses": { + "200": { + "body": { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDeviceSkus_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDeviceSkus_ListBySubscription.json new file mode 100644 index 000000000000..56d43e0b6721 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDeviceSkus_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "NetworkDeviceSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Create.json new file mode 100644 index 000000000000..0eb2249de53c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Create.json @@ -0,0 +1,97 @@ +{ + "title": "NetworkDevices_Create_MaximumSet_Gen", + "operationId": "NetworkDevices_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "resource": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Delete.json new file mode 100644 index 000000000000..b83e96dc47f0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkDevices_Delete_MaximumSet_Gen", + "operationId": "NetworkDevices_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Get.json new file mode 100644 index 000000000000..e4433c2309af --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Get.json @@ -0,0 +1,49 @@ +{ + "title": "NetworkDevices_Get_MaximumSet_Gen", + "operationId": "NetworkDevices_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..6a442d1ea8c5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "NetworkDevices_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_ListBySubscription.json new file mode 100644 index 000000000000..95b6a9bf82f1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "NetworkDevices_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDevices_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Reboot.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Reboot.json new file mode 100644 index 000000000000..5fac4569baab --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Reboot.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Reboot_MaximumSet_Gen", + "operationId": "NetworkDevices_Reboot", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "rebootType": "GracefulRebootWithZTP" + } + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RefreshConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RefreshConfiguration.json new file mode 100644 index 000000000000..956946244584 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkDevices_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkDevices_RefreshConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RunRoCommand.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RunRoCommand.json new file mode 100644 index 000000000000..220b6f637bd1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RunRoCommand.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkDevices_RunRoCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRoCommand", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "show version" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "zuwgsrizc", + "message": "v", + "target": "elwgfga", + "details": [], + "additionalInfo": [ + { + "type": "modrphiaxpggwxenqcitxvbeevku", + "info": {} + } + ] + }, + "endTime": "2025-04-25T08:06:00.912Z", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/locations/UKSOUTH/operationStatuses/b7c3d8f2-56e4-4a9b-8c7d-123456789ABC*1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF", + "name": "b7c3d8f2-56e4-4a9b-8c7d-123456789ABC*1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF", + "properties": { + "configurationState": "Succeeded", + "outputUrl": "https://testsast1.blob.core.windows.net/container1", + "deviceConfigurationPreview": "{\n \"architecture\": \"arm64\",\n \"bootupTimestamp\": 1745279999.1234567,\n \"configMacAddress\": \"11:22:33:44:55:66\",\n \"hardwareRevision\": \"RevB\",\n \"hwMacAddress\": \"66:55:44:33:22:11\",\n \"imageFormatVersion\": \"2.0\",\n \"imageOptimization\": \"High\",\n \"internalBuildId\": \"a123b456-c789-0123-d456-7890e123f456\",\n \"internalVersion\": \"5.12.1FX-NX-12345678.5121FXNX\",\n \"isIntlVersion\": true,\n \"kernelVersion\": \"6.0.0-1.cm3\",\n \"memFree\": 209715200,\n \"memTotal\": 262144000,\n \"mfgName\": \"Cisco\",\n \"modelName\": \"vEOS\",\n \"serialNumber\": \"1234567890ABCDEF1234567890ABCDEF\",\n \"systemMacAddress\": \"aa:bb:cc:dd:ee:ff\",\n \"uptime\": 123456.78901234567,\n \"version\": \"5.12.1FX-NX-12345678.5121FXNX (release build)\"\n}" + }, + "resourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "startTime": "2025-04-25T08:06:00.912Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RunRwCommand.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RunRwCommand.json new file mode 100644 index 000000000000..354d7785cc4e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_RunRwCommand.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkDevices_RunRwCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRwCommand", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "yzuabghycngqmqtfacvoh" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "svvzwijqaghjlelhr", + "message": "kgttomemzowwdiqvbtqlrd", + "target": "txdqddgrezjihhhrmdovikhm", + "details": [], + "additionalInfo": [ + { + "type": "vcaekwfqlkfzcjompti", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "outputUrl": "hypjtiwzhevuc" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Update.json new file mode 100644 index 000000000000..dfc91b4d8b01 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Update.json @@ -0,0 +1,61 @@ +{ + "title": "NetworkDevices_Update_MaximumSet_Gen", + "operationId": "NetworkDevices_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_UpdateAdministrativeState.json new file mode 100644 index 000000000000..e20ace6660bc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkDevices_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkDevices_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "resourceIds": [ + "" + ], + "state": "RMA" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Upgrade.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Upgrade.json new file mode 100644 index 000000000000..9ae32f7195e8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkDevices_Upgrade.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Upgrade_MaximumSet_Gen", + "operationId": "NetworkDevices_Upgrade", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "version": "1.0.0" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Create.json new file mode 100644 index 000000000000..cfb75f7bdf0c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Create.json @@ -0,0 +1,174 @@ +{ + "title": "NetworkFabricControllers_Create_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "resource": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "isWorkloadManagementNetworkEnabled": "True", + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Delete.json new file mode 100644 index 000000000000..66bc2de3e8b7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabricControllers_Delete_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Get.json new file mode 100644 index 000000000000..7ff43178add7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Get.json @@ -0,0 +1,74 @@ +{ + "title": "NetworkFabricControllers_Get_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_ListByResourceGroup.json new file mode 100644 index 000000000000..8258f44a82bd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "NetworkFabricControllers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_ListBySubscription.json new file mode 100644 index 000000000000..9fec9104010c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "NetworkFabricControllers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Update.json new file mode 100644 index 000000000000..32956e2232fb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricControllers_Update.json @@ -0,0 +1,95 @@ +{ + "title": "NetworkFabricControllers_Update_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricSkus_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricSkus_Get.json new file mode 100644 index 000000000000..28ee19f69744 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricSkus_Get.json @@ -0,0 +1,36 @@ +{ + "title": "NetworkFabricSkus_Get_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkFabricSkuName": "wxample-fabricsku" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricSkus_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricSkus_ListBySubscription.json new file mode 100644 index 000000000000..40c53fb72bb0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabricSkus_ListBySubscription.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabricSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ArmConfigurationDiff.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ArmConfigurationDiff.json new file mode 100644 index 000000000000..6e028fc88a2b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ArmConfigurationDiff.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_ArmConfigurationDiff_MaximumSet", + "operationId": "NetworkFabrics_ArmConfigurationDiff", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "configurationDiffUrl": "", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "seonvum", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_BatchUpdate.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_BatchUpdate.json new file mode 100644 index 000000000000..e2b5965a33f5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_BatchUpdate.json @@ -0,0 +1,27 @@ +{ + "title": "NetworkFabrics_BatchUpdate", + "operationId": "NetworkFabrics_BatchUpdate", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "operation": "Stop", + "batchId": "batchid1" + } + }, + "responses": { + "200": { + "body": { + "batchId": "batchid1", + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_CommitBatchStatus.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_CommitBatchStatus.json new file mode 100644 index 000000000000..d0cc282b3d93 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_CommitBatchStatus.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkFabrics_CommitBatchStatus_MaximumSet", + "operationId": "NetworkFabrics_CommitBatchStatus", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "commitBatchId": "batch-id" + } + }, + "responses": { + "200": { + "body": { + "commitBatchId": "batch-id", + "commitBatchState": "Processing", + "commitBatchDetails": { + "failedDevices": [ + "device-id-1" + ] + }, + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_CommitConfiguration.json new file mode 100644 index 000000000000..78eb70b012d1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_CommitConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-networkFabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Create.json new file mode 100644 index 000000000000..39708defaebd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Create.json @@ -0,0 +1,518 @@ +{ + "title": "NetworkFabrics_Create_MaximumSet_Gen", + "operationId": "NetworkFabrics_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "password": "xxx-xx-xx", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "nniDerivedUniqueRdConfigurationState": "Enabled" + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key872": {} + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Delete.json new file mode 100644 index 000000000000..26e029aae8fa --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabrics_Delete_MaximumSet_Gen", + "operationId": "NetworkFabrics_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Deprovision.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Deprovision.json new file mode 100644 index 000000000000..06522aeadab8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Deprovision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Deprovision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Deprovision", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_DiscardBatchUpdate.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_DiscardBatchUpdate.json new file mode 100644 index 000000000000..02411a21ca36 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_DiscardBatchUpdate.json @@ -0,0 +1,25 @@ +{ + "title": "NetworkFabrics_DiscardBatchUpdate", + "operationId": "NetworkFabrics_DiscardBatchUpdate", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "batchId": "batchid1" + } + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_DiscardCommitBatch.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_DiscardCommitBatch.json new file mode 100644 index 000000000000..a2cfb81b741e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_DiscardCommitBatch.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkFabrics_DiscardCommitBatch", + "operationId": "NetworkFabrics_DiscardCommitBatch", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "commitBatchId": "batchId1" + } + }, + "responses": { + "200": { + "body": { + "commitBatchId": "batchId1", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Get.json new file mode 100644 index 000000000000..17e4b37c5091 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Get.json @@ -0,0 +1,201 @@ +{ + "title": "NetworkFabrics_Get_MaximumSet_Gen", + "operationId": "NetworkFabrics_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id-1" + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_GetTopology.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_GetTopology.json new file mode 100644 index 000000000000..90b85549addd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_GetTopology.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkFabrics_GetTopology_MaximumSet_Gen", + "operationId": "NetworkFabrics_GetTopology", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ListByResourceGroup.json new file mode 100644 index 000000000000..fe690a8b9062 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ListByResourceGroup.json @@ -0,0 +1,205 @@ +{ + "title": "NetworkFabrics_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "uniqueRd" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batchId" + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ListBySubscription.json new file mode 100644 index 000000000000..4df91f0dfefa --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ListBySubscription.json @@ -0,0 +1,204 @@ +{ + "title": "NetworkFabrics_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id-1" + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_LockFabric.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_LockFabric.json new file mode 100644 index 000000000000..6e147e97dbfd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_LockFabric.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_LockFabric_MaximumSet", + "operationId": "NetworkFabrics_LockFabric", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-networkFabric", + "body": { + "lockType": "Administrative", + "action": "Lock" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Provision.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Provision.json new file mode 100644 index 000000000000..f8b57a7e5b55 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Provision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Provision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Provision", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_RefreshConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_RefreshConfiguration.json new file mode 100644 index 000000000000..38d53759231f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_RefreshConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Update.json new file mode 100644 index 000000000000..c713cf9eede5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Update.json @@ -0,0 +1,329 @@ +{ + "title": "NetworkFabrics_Update_MaximumSet_Gen", + "operationId": "NetworkFabrics_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key872": {} + } + }, + "properties": { + "annotation": "annotation1", + "rackCount": 6, + "serverCountPerRack": 10, + "ipv4Prefix": "10.18.0.0/17", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/60", + "fabricASN": 12345, + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "terminalServerConfiguration": { + "username": "username1", + "password": "xxxxxxxx", + "serialNumber": "1234567", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "hardwareAlertThreshold": 43, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "nniDerivedUniqueRdConfigurationState": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "apogd" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "izc" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json new file mode 100644 index 000000000000..c07cdeabf20a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateInfraManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateInfraManagementBfdConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json new file mode 100644 index 000000000000..105e23cc2afb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Upgrade.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Upgrade.json new file mode 100644 index 000000000000..b1edde5b59b8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_Upgrade.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_Upgrade_MaximumSet_Gen", + "operationId": "NetworkFabrics_Upgrade", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "version": "3.x.x", + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ValidateConfiguration.json new file mode 100644 index 000000000000..3b31f6a7b82d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ValidateConfiguration.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "validateAction": "Cabling" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ViewDeviceConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ViewDeviceConfiguration.json new file mode 100644 index 000000000000..afdcf67cd3b0 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkFabrics_ViewDeviceConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_ViewDeviceConfiguration_MaximumSet", + "operationId": "NetworkFabrics_ViewDeviceConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "deviceConfigurationUrl": "", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Create.json new file mode 100644 index 000000000000..d34d17961a1a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Create.json @@ -0,0 +1,78 @@ +{ + "title": "NetworkInterfaces_Create_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "resource": { + "properties": { + "annotation": "annotation", + "interfaceType": "Management", + "description": "device 1", + "additionalDescription": "device 1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "description": "device 1", + "additionalDescription": "device 1", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..535994e86cbd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkInterfaces_Delete_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..d8014747725a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Get.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkInterfaces_Get_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "lastOperation": { + "details": "Succeeded" + }, + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_ListByNetworkDevice.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_ListByNetworkDevice.json new file mode 100644 index 000000000000..c68452138776 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_ListByNetworkDevice.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkInterfaces_ListByNetworkDevice_MaximumSet_Gen", + "operationId": "NetworkInterfaces_ListByNetworkDevice", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "lastOperation": { + "details": "Succeeded" + }, + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..d6505e490166 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_Update.json @@ -0,0 +1,52 @@ +{ + "title": "NetworkInterfaces_Update_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "properties": { + "properties": { + "annotation": "annotation", + "description": "device 1", + "additionalDescription": "device 1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_UpdateAdministrativeState.json new file mode 100644 index 000000000000..0e680a9823c6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkInterfaces_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkInterfaces_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkInterfaces_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Create.json new file mode 100644 index 000000000000..6e293f323e9a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Create.json @@ -0,0 +1,138 @@ +{ + "title": "NetworkMonitors_Create", + "operationId": "NetworkMonitors_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor", + "resource": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "stationConfigurationState": "Enabled", + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "er", + "stationIp": "cno", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Delete.json new file mode 100644 index 000000000000..096e7f681d6d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkMonitors_Delete_MaximumSet", + "operationId": "NetworkMonitors_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "rgmanagednetworkfabric", + "networkMonitorName": "example-monitor" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Get.json new file mode 100644 index 000000000000..7112ade85ede --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Get.json @@ -0,0 +1,61 @@ +{ + "title": "NetworkMonitors_Get_MaximumSet", + "operationId": "NetworkMonitors_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_ListByResourceGroup.json new file mode 100644 index 000000000000..bd0fb34185b4 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "NetworkMonitors_ListByResourceGroup", + "operationId": "NetworkMonitors_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key5330": "whychexhqeakupefimkszcdqsnibx" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_ListBySubscription.json new file mode 100644 index 000000000000..b10062fd48a7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "NetworkMonitors_ListBySubscription", + "operationId": "NetworkMonitors_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "station-name", + "stationIp": "10.0.0.1", + "stationPort": 38846, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 489, + "probeInterval": 2854, + "probeCount": 64 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key2555": "pv" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Update.json new file mode 100644 index 000000000000..8f279e52b096 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_Update.json @@ -0,0 +1,91 @@ +{ + "title": "NetworkMonitors_Update", + "operationId": "NetworkMonitors_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor", + "properties": { + "tags": { + "key": "value" + }, + "properties": { + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 64685, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 64685, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_UpdateAdministrativeState.json new file mode 100644 index 000000000000..df7fc4b69715 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkMonitors_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkMonitors_UpdateAdministrativeState", + "operationId": "NetworkMonitors_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Create.json new file mode 100644 index 000000000000..a1f5f170cc52 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Create.json @@ -0,0 +1,94 @@ +{ + "title": "NetworkPacketBrokers_Create_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "resource": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Delete.json new file mode 100644 index 000000000000..4cc741f24af3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkPacketBrokers_Delete_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Get.json new file mode 100644 index 000000000000..f92e2b771830 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Get.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkPacketBrokers_Get_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_ListByResourceGroup.json new file mode 100644 index 000000000000..6d7cf3b9cb55 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkPacketBrokers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_ListBySubscription.json new file mode 100644 index 000000000000..98f3fcdeb382 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "NetworkPacketBrokers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Update.json new file mode 100644 index 000000000000..c4819c43c398 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkPacketBrokers_Update.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkPacketBrokers_Update_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Create.json new file mode 100644 index 000000000000..e837921b25d6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Create.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkRacks_Create_MaximumSet_Gen", + "operationId": "NetworkRacks_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "resource": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Delete.json new file mode 100644 index 000000000000..4638074fe2f8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkRacks_Delete_MaximumSet_Gen", + "operationId": "NetworkRacks_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Get.json new file mode 100644 index 000000000000..ff06e8c4abbb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Get.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkRacks_Get_MaximumSet_Gen", + "operationId": "NetworkRacks_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_ListByResourceGroup.json new file mode 100644 index 000000000000..55de114df8c3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_ListByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkRacks_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkRacks_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_ListBySubscription.json new file mode 100644 index 000000000000..77c149b0222e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_ListBySubscription.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkRacks_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkRacks_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Update.json new file mode 100644 index 000000000000..cd3298918823 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkRacks_Update.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkRacks_Update_MaximumSet_Gen", + "operationId": "NetworkRacks_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Create.json new file mode 100644 index 000000000000..287b071c9efa --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Create.json @@ -0,0 +1,352 @@ +{ + "title": "NetworkTapRules_Create_MaximumSet_Gen", + "operationId": "NetworkTapRules_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "pollingIntervalInSeconds": 30, + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Delete.json new file mode 100644 index 000000000000..5955fadcaea9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTapRules_Delete_MaximumSet_Gen", + "operationId": "NetworkTapRules_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Get.json new file mode 100644 index 000000000000..85d34428e545 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Get.json @@ -0,0 +1,133 @@ +{ + "title": "NetworkTapRules_Get_MaximumSet_Gen", + "operationId": "NetworkTapRules_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ListByResourceGroup.json new file mode 100644 index 000000000000..77e8555ff65c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ListByResourceGroup.json @@ -0,0 +1,137 @@ +{ + "title": "NetworkTapRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ListBySubscription.json new file mode 100644 index 000000000000..4905845157ec --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ListBySubscription.json @@ -0,0 +1,136 @@ +{ + "title": "NetworkTapRules_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Resync.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Resync.json new file mode 100644 index 000000000000..e6f8b090dab2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTapRules_Resync_MaximumSet_Gen", + "operationId": "NetworkTapRules_Resync", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Update.json new file mode 100644 index 000000000000..836771675e4a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_Update.json @@ -0,0 +1,233 @@ +{ + "title": "NetworkTapRules_Update_MaximumSet_Gen", + "operationId": "NetworkTapRules_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/amdsdx", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_UpdateAdministrativeState.json new file mode 100644 index 000000000000..96938eeaf2ba --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkTapRules_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTapRules_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ValidateConfiguration.json new file mode 100644 index 000000000000..ef9cb94452da --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTapRules_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkTapRules_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkTapRules_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Create.json new file mode 100644 index 000000000000..fb22cba01135 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Create.json @@ -0,0 +1,125 @@ +{ + "title": "NetworkTaps_Create_MaximumSet_Gen", + "operationId": "NetworkTaps_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "resource": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Delete.json new file mode 100644 index 000000000000..8e7737bd334a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTaps_Delete_MaximumSet_Gen", + "operationId": "NetworkTaps_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Get.json new file mode 100644 index 000000000000..1f6ba4b71b3d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Get.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkTaps_Get_MaximumSet_Gen", + "operationId": "NetworkTaps_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_ListByResourceGroup.json new file mode 100644 index 000000000000..d2651e5d89a9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "NetworkTaps_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTaps_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_ListBySubscription.json new file mode 100644 index 000000000000..91891b276b61 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "NetworkTaps_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTaps_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Resync.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Resync.json new file mode 100644 index 000000000000..744e6c31f0fc --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTaps_Resync_MaximumSet_Gen", + "operationId": "NetworkTaps_Resync", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Update.json new file mode 100644 index 000000000000..a8937f1b4593 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_Update.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkTaps_Update_MaximumSet_Gen", + "operationId": "NetworkTaps_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation1", + "pollingType": "Pull", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_UpdateAdministrativeState.json new file mode 100644 index 000000000000..f4d3284e8f5e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkTaps_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkTaps_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTaps_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Create.json new file mode 100644 index 000000000000..a9063c128375 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Create.json @@ -0,0 +1,375 @@ +{ + "title": "NetworkToNetworkInterconnects_Create_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "resource": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe08:00/64", + "nextHop": [ + "fe01::1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe08:00/64", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe08:00/64", + "nextHop": [ + "fe01::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Delete.json new file mode 100644 index 000000000000..8ffaca408c77 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkToNetworkInterconnects_Delete_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Get.json new file mode 100644 index 000000000000..ce02392130ca --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Get.json @@ -0,0 +1,140 @@ +{ + "title": "NetworkToNetworkInterconnects_Get_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_ListByNetworkFabric.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_ListByNetworkFabric.json new file mode 100644 index 000000000000..3c963f1a5fb6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_ListByNetworkFabric.json @@ -0,0 +1,144 @@ +{ + "title": "NetworkToNetworkInterconnects_ListByNetworkFabric_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_ListByNetworkFabric", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Update.json new file mode 100644 index 000000000000..d7e80f204413 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_Update.json @@ -0,0 +1,221 @@ +{ + "title": "NetworkToNetworkInterconnects_Update_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "properties": { + "properties": { + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "20.0.0.12/29", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.14/29", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 2345, + "vlanId": 1235, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 1 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + } + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateAdministrativeState.json new file mode 100644 index 000000000000..b1a19d24ef13 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json new file mode 100644 index 000000000000..4c3b88979a6e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateBfdAdministrativeState", + "operationId": "NetworkToNetworkInterconnects_UpdateBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "routeType": "Static", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "routeType": "Static", + "administrativeState": "Enable", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..d91b994b4853 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/Operations_List.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/Operations_List.json new file mode 100644 index 000000000000..ee880e549cf7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/Operations_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Read", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Gets/List NetworkFabricController resources.", + "description": "Gets/List the NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Write", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Create or Update NetworkFabricController resource.", + "description": "Create or Update NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Delete", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Deletes the NetworkFabricController resource.", + "description": "Deletes the NetworkFabricController resource." + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen" +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_CommitConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_CommitConfiguration.json new file mode 100644 index 000000000000..92978a9f1ce7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "RoutePolicies_CommitConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Create.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Create.json new file mode 100644 index 000000000000..b8da269af835 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Create.json @@ -0,0 +1,246 @@ +{ + "title": "RoutePolicies_Create_MaximumSet_Gen", + "operationId": "RoutePolicies_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "resource": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Delete.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Delete.json new file mode 100644 index 000000000000..8c96019d672e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RoutePolicies_Delete_MaximumSet_Gen", + "operationId": "RoutePolicies_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Get.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Get.json new file mode 100644 index 000000000000..fd186a114f19 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Get.json @@ -0,0 +1,97 @@ +{ + "title": "RoutePolicies_Get_MaximumSet_Gen", + "operationId": "RoutePolicies_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ListByResourceGroup.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..651167a21c50 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ListByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "title": "RoutePolicies_ListByResourceGroup_MaximumSet_Gen", + "operationId": "RoutePolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ListBySubscription.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ListBySubscription.json new file mode 100644 index 000000000000..3c5ae1360ab6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ListBySubscription.json @@ -0,0 +1,100 @@ +{ + "title": "RoutePolicies_ListBySubscription_MaximumSet_Gen", + "operationId": "RoutePolicies_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Update.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Update.json new file mode 100644 index 000000000000..dda045ae4900 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_Update.json @@ -0,0 +1,161 @@ +{ + "title": "RoutePolicies_Update_MaximumSet_Gen", + "operationId": "RoutePolicies_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_UpdateAdministrativeState.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_UpdateAdministrativeState.json new file mode 100644 index 000000000000..3d94686a91b9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "RoutePolicies_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "RoutePolicies_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ValidateConfiguration.json b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ValidateConfiguration.json new file mode 100644 index 000000000000..c4cf028c87e2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/examples/2024-06-15-preview/RoutePolicies_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "RoutePolicies_ValidateConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/main.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/main.tsp new file mode 100644 index 000000000000..562ce4fd6d2a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/main.tsp @@ -0,0 +1,77 @@ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models/common.tsp"; +import "./models/AccessControlList.tsp"; +import "./models/InternetGateway.tsp"; +import "./models/InternetGatewayRule.tsp"; +import "./models/NetworkFabric.tsp"; +import "./models/NetworkToNetworkInterconnect.tsp"; +import "./models/IpCommunity.tsp"; +import "./models/IpExtendedCommunity.tsp"; +import "./models/IpPrefix.tsp"; +import "./models/L2IsolationDomain.tsp"; +import "./models/L3IsolationDomain.tsp"; +import "./models/InternalNetwork.tsp"; +import "./models/ExternalNetwork.tsp"; +import "./models/NeighborGroup.tsp"; +import "./models/NetworkDevice.tsp"; +import "./models/NetworkDeviceSku.tsp"; +import "./models/NetworkInterface.tsp"; +import "./models/NetworkFabricController.tsp"; +import "./models/NetworkFabricSku.tsp"; +import "./models/NetworkPacketBroker.tsp"; +import "./models/NetworkRack.tsp"; +import "./models/NetworkTapRule.tsp"; +import "./models/NetworkTap.tsp"; +import "./models/RoutePolicy.tsp"; +import "./models/NetworkMonitor.tsp"; +import "./resources/AccessControlList.tsp"; +import "./resources/InternetGatewayRule.tsp"; +import "./resources/InternetGateway.tsp"; +import "./resources/IpCommunity.tsp"; +import "./resources/IpExtendedCommunity.tsp"; +import "./resources/IpPrefix.tsp"; +import "./resources/L2IsolationDomain.tsp"; +import "./resources/L3IsolationDomain.tsp"; +import "./resources/InternalNetwork.tsp"; +import "./resources/ExternalNetwork.tsp"; +import "./resources/NeighborGroup.tsp"; +import "./resources/NetworkDeviceSku.tsp"; +import "./resources/NetworkDevice.tsp"; +import "./resources/NetworkInterface.tsp"; +import "./resources/NetworkFabricController.tsp"; +import "./resources/NetworkFabricSku.tsp"; +import "./resources/NetworkFabric.tsp"; +import "./resources/NetworkToNetworkInterconnect.tsp"; +import "./resources/NetworkPacketBroker.tsp"; +import "./resources/NetworkRack.tsp"; +import "./resources/NetworkTapRule.tsp"; +import "./resources/NetworkTap.tsp"; +import "./resources/RoutePolicy.tsp"; +import "./resources/NetworkMonitor.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@doc("Self service experience for Azure Network Fabric API.") +@armProviderNamespace("Microsoft.ManagedNetworkFabric") +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +@service(#{ title: "Azure Network Fabric Management Service API" }) +@versioned(Versions) +namespace Microsoft.ManagedNetworkFabric; + +@doc("API Versions") +enum Versions { + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + @doc("2024-02-15-preview") + v2024_02_15_preview: "2024-02-15-preview", + + @doc("2024-06-15-preview") + v2024_06_15_preview: "2024-06-15-preview", +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/AccessControlList.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/AccessControlList.tsp new file mode 100644 index 000000000000..27dd3c9224ee --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/AccessControlList.tsp @@ -0,0 +1,410 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Access Control List Properties defines the resource properties.") +model AccessControlListProperties { + ...AnnotationResource; + + @doc("Input method to configure Access Control List.") + configurationType: ConfigurationType; + + @doc("Access Control List file URL.") + aclsUrl?: url; + + @doc("Default action that needs to be applied when no condition is matched. Example: Permit | Deny.") + defaultAction?: CommunityActionTypes = CommunityActionTypes.Permit; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of match configurations.") + @minItems(1) + matchConfigurations?: AccessControlListMatchConfiguration[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of dynamic match configurations.") + @minItems(1) + dynamicMatchConfigurations?: CommonDynamicMatchConfiguration[]; + + @doc("The last synced timestamp.") + @visibility(Lifecycle.Read) + lastSyncedTime?: utcDateTime; + + @doc("Access Control List (ACL) Type") + @added(Versions.v2024_06_15_preview) + aclType?: AclType; + + @doc("Device Role") + @added(Versions.v2024_06_15_preview) + deviceRole?: DeviceRole; + + @doc("Global Access Control List (ACL) actions") + @added(Versions.v2024_06_15_preview) + globalAccessControlListActions?: GlobalAccessControlListActionProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("Defines the match configuration that are supported to filter the traffic.") +model AccessControlListMatchConfiguration { + @doc("The name of the match configuration.") + @minLength(1) + matchConfigurationName?: string; + + @doc("Sequence Number of the match configuration.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber?: int64; + + @doc("Type of IP Address. IPv4 or IPv6") + ipAddressType?: IPAddressType; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of the match conditions.") + @minItems(1) + matchConditions?: AccessControlListMatchCondition[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of actions that need to be performed for the matched conditions.") + @minItems(1) + actions?: AccessControlListAction[]; +} + +@doc("Defines the match configuration that are supported to filter the traffic.") +model AccessControlListMatchConfigurationPatch { + @doc("The name of the match configuration.") + @minLength(1) + matchConfigurationName?: string; + + @doc("Sequence Number of the match configuration.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber?: int64; + + @doc("Type of IP Address. IPv4 or IPv6") + ipAddressType?: IPAddressType; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of the match conditions.") + @minItems(1) + matchConditions?: AccessControlListMatchConditionPatch[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of actions that need to be performed for the matched conditions.") + @minItems(1) + actions?: AccessControlListActionPatch[]; +} + +@doc("Defines the match condition that is supported to filter the traffic.") +model AccessControlListMatchCondition { + ...CommonMatchConditions; + + @doc("List of ether type values that need to be matched.") + @minItems(1) + etherTypes?: string[]; + + @doc("List of IP fragment packets that need to be matched.") + @minItems(1) + fragments?: string[]; + + @doc("List of IP Lengths that need to be matched.") + @minItems(1) + ipLengths?: string[]; + + @doc("List of TTL [Time To Live] values that need to be matched.") + @minItems(1) + ttlValues?: string[]; + + @doc("List of DSCP Markings that need to be matched.") + @minItems(1) + dscpMarkings?: string[]; + + @doc("Protocol neighbors that need to be matched.") + @added(Versions.v2024_06_15_preview) + protocolNeighbors?: string[]; + + @doc("Defines the port condition that needs to be matched.") + portCondition?: AccessControlListPortCondition; + + @doc("Internet Control Message Protocol (ICMP) configuration") + @added(Versions.v2024_06_15_preview) + icmpConfiguration?: IcmpConfigurationProperties; +} + +@doc("Defines the match condition that is supported to filter the traffic.") +model AccessControlListMatchConditionPatch { + ...CommonMatchConditionsPatch; + + @doc("List of ether type values that need to be matched.") + @minItems(1) + etherTypes?: string[]; + + @doc("List of IP fragment packets that need to be matched.") + @minItems(1) + fragments?: string[]; + + @doc("List of IP Lengths that need to be matched.") + @minItems(1) + ipLengths?: string[]; + + @doc("List of TTL [Time To Live] values that need to be matched.") + @minItems(1) + ttlValues?: string[]; + + @doc("List of DSCP Markings that need to be matched.") + @minItems(1) + dscpMarkings?: string[]; + + @doc("Defines the port condition that needs to be matched.") + portCondition?: AccessControlListPortConditionPatch; + + @doc("Protocol neighbors that need to be matched.") + @added(Versions.v2024_06_15_preview) + protocolNeighbors?: string[]; + + @doc("Internet Control Message Protocol (ICMP) configuration") + @added(Versions.v2024_06_15_preview) + icmpConfiguration?: IcmpConfigurationPatchProperties; +} + +@doc("Defines the port condition that needs to be matched.") +model AccessControlListPortCondition { + ...PortCondition; + + @doc("List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg") + flags?: string[]; +} + +@doc("Defines the port condition that needs to be matched.") +model AccessControlListPortConditionPatch { + ...PortConditionPatch; + + @doc("List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg") + flags?: string[]; +} + +@doc("Action that need to performed.") +model AccessControlListAction { + @doc("Type of actions that can be performed.") + type?: AclActionType; + + @doc("Name of the counter block to get match count information.") + @minLength(1) + counterName?: string; + + @doc("Remark comment") + @added(Versions.v2024_06_15_preview) + remarkComment?: string; + + @doc("Police rate configuration") + @added(Versions.v2024_06_15_preview) + policeRateConfiguration?: PoliceRateConfigurationProperties; +} + +@doc("Action that need to be performed") +model AccessControlListActionPatch is AccessControlListAction; + +@doc("The Access Control Lists patch resource definition.") +model AccessControlListPatch { + ...TagsUpdate; + + @doc("Access Control Lists patch properties.") + properties?: AccessControlListPatchProperties; +} + +@doc("Access Control Lists patch properties.") +model AccessControlListPatchProperties { + @doc("Input method to configure Access Control List.") + configurationType?: ConfigurationType; + + @doc("Access Control List file URL.") + aclsUrl?: url; + + @doc("Default action that needs to be applied when no condition is matched. Example: Permit | Deny.") + defaultAction?: CommunityActionTypes; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of match configurations.") + @minItems(1) + matchConfigurations?: AccessControlListMatchConfigurationPatch[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of dynamic match configurations.") + @minItems(1) + dynamicMatchConfigurations?: CommonDynamicMatchConfigurationPatch[]; + + @doc("Access Control List (ACL) Type") + @added(Versions.v2024_06_15_preview) + aclType?: AclType; + + @doc("Device Role") + @added(Versions.v2024_06_15_preview) + deviceRole?: DeviceRole; + + @doc("Global Access Control List (ACL) actions") + @added(Versions.v2024_06_15_preview) + globalAccessControlListActions?: GlobalAccessControlListActionPatchProperties; + + ...AnnotationResource; +} + +@doc("Type of actions that can be performed.") +union AclActionType { + @doc("AclActionType Drop") + Drop: "Drop", + + @doc("AclActionType Count") + Count: "Count", + + @doc("AclActionType Log") + Log: "Log", + + @doc("AclActionType Remark") + @added(Versions.v2024_06_15_preview) + Remark: "Remark", + + @doc("AclActionType PoliceRate") + @added(Versions.v2024_06_15_preview) + PoliceRate: "PoliceRate", + + string, +} + +@doc("Access Control List (ACL) Type") +@added(Versions.v2024_06_15_preview) +union AclType { + @doc("AclType Control Plane Traffic Policy") + Cp: "ControlPlaneTrafficPolicy", + + @doc("AclType Tenant") + Tenant: "Tenant", + + @doc("AclType Management") + Management: "Management", + + string, +} + +@doc("Device Role") +@added(Versions.v2024_06_15_preview) +union DeviceRole { + @doc("DeviceRole - Customer Edge (CE)") + CE: "CE", + + @doc("DeviceRole - Top of Rack (ToR)") + ToR: "ToR", + + @doc("DeviceRole - Network Packet Broker (NPB)") + NPB: "NPB", + + @doc("Device Role Management Switch") + ManagementSwitch: "ManagementSwitch", + + string, +} + +@doc("Global Access Control List actions properties") +@added(Versions.v2024_06_15_preview) +model GlobalAccessControlListActionProperties { + @doc("Configuration to enable or disable ACL action count.") + enableCount?: BooleanEnumProperty = BooleanEnumProperty.False; +} + +@doc("Global Access Control List actions patch properties") +@added(Versions.v2024_06_15_preview) +@withoutDefaultValues +model GlobalAccessControlListActionPatchProperties + is GlobalAccessControlListActionProperties; + +@doc("Internet Control Message Protocol (ICMP) configuration") +@added(Versions.v2024_06_15_preview) +model IcmpConfigurationProperties { + @doc("Internet Control Message Protocol (ICMP) types") + @minItems(1) + icmpTypes?: string[]; +} + +@doc("Internet Control Message Protocol (ICMP) configuration patch properties") +@added(Versions.v2024_06_15_preview) +model IcmpConfigurationPatchProperties is IcmpConfigurationProperties; + +@doc("Police rate configuration properties") +@added(Versions.v2024_06_15_preview) +model PoliceRateConfigurationProperties { + @doc("Rate limit in bits per second.") + bitRate?: BitRate; + + @doc("Burst size in packets.") + burstSize?: BurstSize; +} + +@doc("Bit rate in bits per second.") +@added(Versions.v2024_06_15_preview) +model BitRate { + @doc("Bitrate.") + rate?: int64; + + @doc("Bitrate unit.") + unit?: BitRateUnit; +} + +@doc("Bit rate unit.") +@added(Versions.v2024_06_15_preview) +union BitRateUnit { + @doc("Bit rate unit in bits per second.") + bps: "bps", + + @doc("Bit rate unit in kilobits per second.") + Kbps: "Kbps", + + @doc("Bit rate unit in megabits per second.") + Mbps: "Mbps", + + @doc("Bit rate unit in gigabits per second.") + Gbps: "Gbps", + + string, +} + +@doc("Burst size in packets.") +@added(Versions.v2024_06_15_preview) +model BurstSize { + @doc("Burst size.") + size?: int64; + + @doc("Burst size unit.") + unit?: BurstSizeUnit; +} + +@doc("Burst size unit in packets.") +@added(Versions.v2024_06_15_preview) +union BurstSizeUnit { + @doc("Burst size unit in bytes.") + Bytes: "Bytes", + + @doc("Burst size unit in kilobytes.") + KBytes: "KBytes", + + @doc("Burst size unit in megabytes.") + MBytes: "MBytes", + + @doc("Burst size unit in gigabytes.") + GBytes: "GBytes", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/ExternalNetwork.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/ExternalNetwork.tsp new file mode 100644 index 000000000000..ad6e0260b504 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/ExternalNetwork.tsp @@ -0,0 +1,428 @@ +import "./common.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("External Network Properties.") +model ExternalNetworkProperties { + ...AnnotationResource; + + @doc("ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.") + networkToNetworkInterconnectId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + importRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + exportRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importRoutePolicy") + importRoutePolicyDeprecated?: ImportRoutePolicy; + + @doc("Import Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + importRoutePolicy?: ImportRoutePolicy; + + @doc("Export Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportRoutePolicy") + exportRoutePolicyDeprecated?: ExportRoutePolicy; + + @doc("Export Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + exportRoutePolicy?: ExportRoutePolicy; + + @doc("Peering option list.") + peeringOption: PeeringOption; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option B properties object") + optionBProperties?: L3OptionBProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option A properties object") + optionAProperties?: ExternalNetworkPropertiesOptionAProperties; + + @added(Versions.v2024_06_15_preview) + @doc("Static Route Configuration.") + staticRouteConfiguration?: ExternalNetworkStaticRouteConfiguration; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Option B configuration.") +model L3OptionBPatchProperties { + @doc("RouteTargets to be applied. This is used for the backward compatibility.") + importRouteTargets?: string[]; + + @doc("RouteTargets to be applied. This is used for the backward compatibility.") + exportRouteTargets?: string[]; + + @doc("RouteTargets to be applied.") + routeTargets?: RouteTargetPatchInformation; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Option B configuration.") +model L3OptionBProperties { + @doc("RouteTargets to be applied. This is used for the backward compatibility.") + importRouteTargets?: string[]; + + @doc("RouteTargets to be applied. This is used for the backward compatibility.") + exportRouteTargets?: string[]; + + @doc("RouteTargets to be applied.") + routeTargets?: RouteTargetInformation; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("option A properties object") +model ExternalNetworkPropertiesOptionAProperties { + ...Layer3IpPrefixProperties; + + @doc("MTU to use for option A peering.") + @maxValue(9200) + @minValue(64) + mtu?: int32 = 1500; + + @doc("Vlan identifier. Example : 501") + @maxValue(4094) + @minValue(501) + vlanId: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Fabric ASN number. Example 65001") + @visibility(Lifecycle.Read) + @maxValue(4294967295) + @minValue(1) + fabricASN?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Peer ASN number.Example : 28") + @maxValue(4294967295) + @minValue(1) + peerASN: int64; + + @doc("BFD configuration properties") + bfdConfiguration?: BfdConfiguration; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "ingressAclId") + ingressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + ingressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("BMP Monitor Configuration.") + @added(Versions.v2024_06_15_preview) + bmpConfiguration?: ExternalNetworkBmpProperties; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "egressAclId") + egressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + egressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("V4OverV6 BGP Session state") + @added(Versions.v2024_06_15_preview) + v4OverV6BgpSession?: V4OverV6BgpSessionState = V4OverV6BgpSessionState.Disabled; + + @doc("V6OverV4 BGP Session state") + @added(Versions.v2024_06_15_preview) + v6OverV4BgpSession?: V6OverV4BgpSessionState = V6OverV4BgpSessionState.Disabled; + + @doc("Native IPv4 prefix limits configuration") + @added(Versions.v2024_06_15_preview) + nativeIpv4PrefixLimit?: NativeIpv4PrefixLimitProperties; + + @doc("Native IPv6 prefix limits configuration") + @added(Versions.v2024_06_15_preview) + nativeIpv6PrefixLimit?: NativeIpv6PrefixLimitProperties; +} + +@doc("The ExternalNetwork patch resource definition.") +model ExternalNetworkPatch { + @doc("External Network Patch properties.") + properties?: ExternalNetworkPatchProperties; +} + +@doc("External Network Patch properties.") +model ExternalNetworkPatchProperties { + ...AnnotationResource; + + @doc("ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.") + networkToNetworkInterconnectId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + importRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + exportRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importRoutePolicy") + importRoutePolicyDeprecated?: ImportRoutePolicyPatch; + + @doc("Import Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + importRoutePolicy?: ImportRoutePolicyPatch; + + @doc("Export Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportRoutePolicy") + exportRoutePolicyDeprecated?: ExportRoutePolicyPatch; + + @doc("Export Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + exportRoutePolicy?: ExportRoutePolicyPatch; + + @doc("Peering option list.") + peeringOption?: PeeringOption; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option B properties object") + optionBProperties?: L3OptionBPatchProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option A properties object") + optionAProperties?: ExternalNetworkPatchPropertiesOptionAProperties; + + @added(Versions.v2024_06_15_preview) + @doc("Static Route Configuration.") + staticRouteConfiguration?: ExternalNetworkStaticRoutePatchConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("option A properties object") +model ExternalNetworkPatchPropertiesOptionAProperties { + ...Layer3IpPrefixPatchProperties; + + @doc("MTU to use for option A peering.") + @maxValue(9200) + @minValue(64) + mtu?: int32; + + @doc("Vlan identifier. Example : 501") + @maxValue(4094) + @minValue(501) + vlanId?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Fabric ASN number. Example 65001") + @visibility(Lifecycle.Read) + @maxValue(4294967295) + @minValue(1) + fabricASN?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Peer ASN number.Example : 28") + @maxValue(4294967295) + @minValue(1) + peerASN?: int64; + + @doc("BFD configuration properties") + bfdConfiguration?: BfdPatchConfiguration; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "ingressAclId") + ingressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + ingressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "egressAclId") + egressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + egressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("BMP Monitor Configuration.") + @added(Versions.v2024_06_15_preview) + bmpConfiguration?: ExternalNetworkBmpPatchProperties; + + @doc("V4OverV6 BGP Session state") + @added(Versions.v2024_06_15_preview) + v4OverV6BgpSession?: V4OverV6BgpSessionState; + + @doc("V6OverV4 BGP Session state") + @added(Versions.v2024_06_15_preview) + v6OverV4BgpSession?: V6OverV4BgpSessionState; + + @doc("Native IPv4 prefix limit configuration") + @added(Versions.v2024_06_15_preview) + nativeIpv4PrefixLimit?: NativeIpv4PrefixLimitPatchProperties; + + @doc("Native IPv6 prefix limit configuration") + @added(Versions.v2024_06_15_preview) + nativeIpv6PrefixLimit?: NativeIpv6PrefixLimitPatchProperties; +} + +@doc("External Network Administrative State request") +@added(Versions.v2024_06_15_preview) +model ExternalNetworkBfdAdministrativeStateRequest { + @doc("Route Type that helps to know which bfd we are updating.") + routeType?: ExternalNetworkRouteType; + + @doc("Administrative state.") + administrativeState?: BfdAdministrativeState; +} + +@doc("External Network Administrative State response") +@added(Versions.v2024_06_15_preview) +model ExternalNetworkBfdAdministrativeStateResponse { + @doc("Route Type that helps to know which bfd we are updating.") + routeType?: ExternalNetworkRouteType; + + @doc("Administrative state.") + administrativeState?: BfdAdministrativeState; + + ...ErrorResponse; +} + +@doc("External Network RouteType.") +@added(Versions.v2024_06_15_preview) +union ExternalNetworkRouteType { + @doc("ExternalNetwork Static.") + Static: "Static", + + @doc("ExternalNetwork OptionA.") + OptionA: "OptionA", + + string, +} + +@doc("Static Route Configuration properties for ExternalNetwork.") +@added(Versions.v2024_06_15_preview) +model ExternalNetworkStaticRouteConfiguration { + @doc("BFD configuration properties") + bfdConfiguration?: BfdConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRouteProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRouteProperties[]; +} + +@doc("Static Route Configuration properties for External Network.") +@added(Versions.v2024_06_15_preview) +model ExternalNetworkStaticRoutePatchConfiguration { + @doc("BFD configuration properties") + bfdConfiguration?: BfdPatchConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRoutePatchProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRoutePatchProperties[]; +} + +@doc("BGP Monitoring Protocol (BMP) Configuration properties.") +@added(Versions.v2024_06_15_preview) +model ExternalNetworkBmpProperties { + @doc("BMP Configuration State.") + configurationState?: BmpConfigurationState = BmpConfigurationState.Disabled; +} + +@doc("BMP Monitoring Configuration patch properties.") +@added(Versions.v2024_06_15_preview) +model ExternalNetworkBmpPatchProperties { + @doc("BMP Configuration State.") + configurationState?: BmpConfigurationState; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternalNetwork.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternalNetwork.tsp new file mode 100644 index 000000000000..f41b77e26254 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternalNetwork.tsp @@ -0,0 +1,541 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; +using Azure.ResourceManager; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Internal Network Properties defines the properties of the resource.") +model InternalNetworkProperties { + ...AnnotationResource; + + @doc("Maximum transmission unit. Default value is 1500.") + @maxValue(9200) + @minValue(64) + mtu?: int32 = 1500; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("List of Connected IPv4 Subnets.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + connectedIPv4Subnets?: ConnectedSubnet[]; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("List of connected IPv6 Subnets.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + connectedIPv6Subnets?: ConnectedSubnet[]; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + importRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + exportRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importRoutePolicy") + importRoutePolicyDeprecated?: ImportRoutePolicy; + + @doc("Import Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + importRoutePolicy?: ImportRoutePolicy; + + @doc("Export Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportRoutePolicy") + exportRoutePolicyDeprecated?: ExportRoutePolicy; + + @doc("Export Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + exportRoutePolicy?: ExportRoutePolicy; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "ingressAclId") + ingressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + ingressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "egressAclId") + egressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + egressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("To check whether monitoring of internal network is enabled or not.") + isMonitoringEnabled?: IsMonitoringEnabled = IsMonitoringEnabled.False; + + @doc("Extension. Example: NoExtension | NPB.") + extension?: Extension = Extension.NoExtension; + + @doc("Vlan identifier. Example: 1001.") + @maxValue(4094) + @minValue(100) + vlanId: int32; + + @doc("BGP configuration properties.") + bgpConfiguration?: BgpConfiguration; + + @doc("Static Route Configuration properties.") + staticRouteConfiguration?: StaticRouteConfiguration; + + @doc("Native IPv4 Prefix Limit Configuration properties.") + @added(Versions.v2024_06_15_preview) + nativeIpv4PrefixLimit?: NativeIpv4PrefixLimitProperties; + + @doc("Native IPv6 Prefix Limit Configuration properties.") + @added(Versions.v2024_06_15_preview) + nativeIpv6PrefixLimit?: NativeIpv6PrefixLimitProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("BGP configuration properties") +model BgpConfiguration { + ...AnnotationResource; + + @doc("BFD configuration properties") + bfdConfiguration?: BfdConfiguration; + + @doc("Originate a defaultRoute. Ex: \"True\" | \"False\".") + defaultRouteOriginate?: BooleanEnumProperty; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2.") + @maxValue(10) + @minValue(0) + allowAS?: int32 = 2; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Enable Or Disable state.") + allowASOverride?: AllowASOverride; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of Network Fabric. Example: 65048.") + @visibility(Lifecycle.Read) + fabricASN?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Peer ASN. Example: 65047.") + @maxValue(4294967295) + @minValue(1) + peerASN: int64; + + @doc("List of BGP IPv4 Listen Range prefixes.") + ipv4ListenRangePrefixes?: string[]; + + @doc("List of BGP IPv6 Listen Ranges prefixes.") + ipv6ListenRangePrefixes?: string[]; + + @doc("List with stringified IPv4 Neighbor Addresses.") + @Azure.ResourceManager.identifiers(#["address"]) + ipv4NeighborAddress?: NeighborAddress[]; + + @doc("List with stringified IPv6 Neighbor Address.") + @Azure.ResourceManager.identifiers(#["address"]) + ipv6NeighborAddress?: NeighborAddress[]; + + @doc("InternalNetwork BMP Configuration") + @added(Versions.v2024_06_15_preview) + bmpConfiguration?: InternalNetworkBmpProperties; + + @added(Versions.v2024_06_15_preview) + @doc("V4 over V6 bgp session.") + v4OverV6BgpSession?: V4OverV6BgpSessionState = V4OverV6BgpSessionState.Disabled; + + @doc("v6 over v4 bgp session.") + @added(Versions.v2024_06_15_preview) + v6OverV4BgpSession?: V6OverV4BgpSessionState = V6OverV4BgpSessionState.Disabled; +} + +@doc("BGP configuration properties.") +model BgpPatchConfiguration { + ...AnnotationResource; + + @doc("BFD configuration properties") + bfdConfiguration?: BfdPatchConfiguration; + + @doc("Originate a defaultRoute. Ex: \"True\" | \"False\".") + defaultRouteOriginate?: BooleanEnumProperty; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2.") + @maxValue(10) + @minValue(0) + allowAS?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Enable Or Disable state.") + allowASOverride?: AllowASOverride; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of Network Fabric. Example: 65048.") + @visibility(Lifecycle.Read) + fabricASN?: int64; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Peer ASN. Example: 65047.") + @maxValue(4294967295) + @minValue(1) + peerASN?: int64; + + @doc("List of BGP IPv4 Listen Range prefixes.") + ipv4ListenRangePrefixes?: string[]; + + @doc("List of BGP IPv6 Listen Ranges prefixes.") + ipv6ListenRangePrefixes?: string[]; + + @doc("List with stringified IPv4 Neighbor Addresses.") + @Azure.ResourceManager.identifiers(#["address"]) + ipv4NeighborAddress?: NeighborAddressPatch[]; + + @doc("List with stringified IPv6 Neighbor Address.") + @Azure.ResourceManager.identifiers(#["address"]) + ipv6NeighborAddress?: NeighborAddressPatch[]; + + @doc("InternalNetwork BMP Configuration") + @added(Versions.v2024_06_15_preview) + bmpConfiguration?: InternalNetworkBmpPatchProperties; + + @added(Versions.v2024_06_15_preview) + @doc("V4 over V6 bgp session.") + v4OverV6BgpSession?: V4OverV6BgpSessionState; + + @doc("v6 over v4 bgp session.") + @added(Versions.v2024_06_15_preview) + v6OverV4BgpSession?: V6OverV4BgpSessionState; +} + +@doc("Neighbor Address properties.") +model NeighborAddress { + @doc("IP Address.") + @minLength(1) + address?: string; + + @doc("BFD Administrative State for each Neighbor Address. Example: Enabled | Disabled.") + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + bfdAdministrativeState?: BfdAdministrativeState; + + @doc("BGP Administrative State for each Neighbor Address. Example: Enabled | Disabled.") + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + bgpAdministrativeState?: BgpAdministrativeState; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; +} + +@doc("Neighbor Address properties.") +model NeighborAddressPatch is NeighborAddress; + +@doc("Connected Subnet properties.") +model ConnectedSubnet { + ...AnnotationResource; + + @doc("Prefix of the Connected Subnet.") + @minLength(1) + prefix: string; +} + +@doc("Connected Subnet properties.") +model ConnectedSubnetPatch is ConnectedSubnet; + +@doc("The InternalNetwork patch resource definition.") +model InternalNetworkPatch { + @doc("InternalNetwork Patch properties.") + properties?: InternalNetworkPatchProperties; +} + +@doc("InternalNetwork Patch properties.") +model InternalNetworkPatchProperties { + ...AnnotationResource; + + @doc("Maximum transmission unit. Default value is 1500.") + @maxValue(9200) + @minValue(64) + mtu?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("List of Connected IPv4 Subnets.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + connectedIPv4Subnets?: ConnectedSubnetPatch[]; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("List of connected IPv6 Subnets.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + connectedIPv6Subnets?: ConnectedSubnetPatch[]; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + importRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + exportRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importRoutePolicy") + importRoutePolicyDeprecated?: ImportRoutePolicy; + + @doc("Import Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + importRoutePolicy?: ImportRoutePolicy; + + @doc("Export Route Policy either IPv4 or IPv6.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportRoutePolicy") + exportRoutePolicyDeprecated?: ExportRoutePolicy; + + @doc("Export Route Policy either IPv4 or IPv6.") + @added(Versions.v2024_06_15_preview) + exportRoutePolicy?: ExportRoutePolicy; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "ingressAclId") + ingressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + ingressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "egressAclId") + egressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + egressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("To check whether monitoring of internal network is enabled or not.") + isMonitoringEnabled?: IsMonitoringEnabled; + + @doc("BGP configuration properties.") + bgpConfiguration?: BgpPatchConfiguration; + + @doc("Static Route Configuration properties.") + staticRouteConfiguration?: StaticRoutePatchConfiguration; + + @doc("Native IPv4 Prefix Limit Configuration properties.") + @added(Versions.v2024_06_15_preview) + nativeIpv4PrefixLimit?: NativeIpv4PrefixLimitPatchProperties; + + @doc("Native IPv6 Prefix Limit Configuration properties.") + @added(Versions.v2024_06_15_preview) + nativeIpv6PrefixLimit?: NativeIpv6PrefixLimitPatchProperties; +} + +@doc("Extension. Example: NoExtension | NPB.") +union Extension { + @doc("Extension-NoExtension") + NoExtension: "NoExtension", + + @doc("Extension-NPB") + NPB: "NPB", + + string, +} + +@doc("Enable Or Disable state.") +union AllowASOverride { + @doc("AllowASOverride-Enable") + Enable: "Enable", + + @doc("AllowASOverride-Disable") + Disable: "Disable", + + string, +} + +@doc("To check whether monitoring of internal network is enabled or not.") +union IsMonitoringEnabled { + @doc("IsMonitoringEnabled-True") + True: "True", + + @doc("IsMonitoringEnabled-False") + False: "False", + + string, +} + +@doc("Internal Network Administrative State Request") +@added(Versions.v2024_06_15_preview) +model InternalNetworkBgpAdministrativeStateRequest { + @doc("NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address.") + neighborAddress?: string; + + @doc("BGP Administrative state.") + administrativeState?: BgpAdministrativeState; +} + +@doc("Internal Network Administrative State Response") +@added(Versions.v2024_06_15_preview) +model InternalNetworkBgpAdministrativeStateResponse { + // The response contains an array of objects. Each object contains the neighbor address and the state. + // The response is an array of objects because the request can contain multiple neighbor addresses. + @doc("NeighborAddress administrative status") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + neighborAddressAdministrativeStatus?: NeighborAddressBgpAdministrativeStatus[]; + + ...ErrorResponse; +} + +@doc("Internal Network BFD Administrative State request") +@added(Versions.v2024_06_15_preview) +model InternalNetworkBfdAdministrativeStateRequest { + @doc("Route Type that helps to know which bfd we are updating.") + routeType?: InternalNetworkRouteType; + + @doc("NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address.") + neighborAddress?: string; + + @doc("BFD Administrative state.") + administrativeState?: BfdAdministrativeState; +} + +@doc("Internal Network BFD Administrative State response") +@added(Versions.v2024_06_15_preview) +model InternalNetworkBfdAdministrativeStateResponse { + // The response contains an array of objects. Each object contains the neighbor address and the state. + // The response is an array of objects because the request can contain multiple neighbor addresses. + @doc("NeighborAddress administrative status") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + neighborAddressAdministrativeStatus?: NeighborAddressBfdAdministrativeStatus[]; + + ...ErrorResponse; +} + +@doc("Internal Network RouteType.") +@added(Versions.v2024_06_15_preview) +union InternalNetworkRouteType { + @doc("InternalNetwork Static.") + Static: "Static", + + @doc("InternalNetwork Bgp.") + Bgp: "Bgp", + + string, +} + +@doc("Internal Network BMP Configuration") +@added(Versions.v2024_06_15_preview) +model InternalNetworkBmpProperties { + @doc("BMP Collector Address.") + @added(Versions.v2024_06_15_preview) + @minItems(1) + neighborIpExclusions?: string[]; + + @doc("BMP Monitoring configuration state.") + @added(Versions.v2024_06_15_preview) + bmpConfigurationState?: BmpConfigurationState; +} + +@doc("Internal Network BMP Configuration") +@added(Versions.v2024_06_15_preview) +model InternalNetworkBmpPatchProperties is InternalNetworkBmpProperties; + +@doc("Neighbor Address BGP Administrative Status") +@added(Versions.v2024_06_15_preview) +model NeighborAddressBgpAdministrativeStatus { + @doc("NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address.") + neighborAddress?: string; + + @doc("BGP Administrative state.") + administrativeState?: BgpAdministrativeState; + + @doc("Error message.") + error?: string; +} + +@doc("Neighbor Address Bidirectional Forwarding Detection (BFD) Administrative Status") +@added(Versions.v2024_06_15_preview) +model NeighborAddressBfdAdministrativeStatus { + @doc("NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address.") + neighborAddress?: string; + + @doc("BFD Administrative state.") + administrativeState?: BfdAdministrativeState; + + @doc("Error message.") + error?: string; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternetGateway.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternetGateway.tsp new file mode 100644 index 000000000000..eeec093625d5 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternetGateway.tsp @@ -0,0 +1,78 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Internet Gateway Properties defines the properties of the resource.") +model InternetGatewayProperties { + ...AnnotationResource; + + @doc("ARM Resource ID of the Internet Gateway Rule.") + internetGatewayRuleId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/internetGatewayRules"; + } + ]>; + + @doc("IPv4 Address of Internet Gateway.") + @visibility(Lifecycle.Read) + ipv4Address?: string; + + @doc("Port number of Internet Gateway.") + @visibility(Lifecycle.Read) + port?: int32; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "This is a valid property name." + @doc("Gateway Type of the resource.") + @madeOptional(Versions.v2024_06_15_preview) + type?: GatewayType; + + @doc("Gateway Type of the resource.") + @added(Versions.v2024_06_15_preview) + internetGatewayType?: GatewayType; + + @doc("ARM Resource ID of the Network Fabric Controller.") + networkFabricControllerId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabricControllers"; + } + ]>; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Provisioning state of resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("The Internet Gateway patch resource definition.") +model InternetGatewayPatch { + ...TagsUpdate; + + @doc("Resource properties.") + properties?: InternetGatewayPatchProperties; +} + +@doc("PatchProperties for InternetGateway ") +model InternetGatewayPatchProperties { + @doc("ARM Resource ID of the Internet Gateway Rule.") + internetGatewayRuleId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/internetGatewayRules"; + } + ]>; +} + +@doc("Gateway Type of the resource.") +union GatewayType { + @doc("GatewayType Infrastructure") + Infrastructure: "Infrastructure", + + @doc("GatewayType Workload") + Workload: "Workload", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternetGatewayRule.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternetGatewayRule.tsp new file mode 100644 index 000000000000..848dc1a63c11 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/InternetGatewayRule.tsp @@ -0,0 +1,89 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; +@doc("Internet Gateway Rule Properties defines the resource properties.") +model InternetGatewayRuleProperties { + ...AnnotationResource; + + @doc("Rules for the InternetGateways") + ruleProperties: RuleProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("List of Internet Gateway resource Id.") + @visibility(Lifecycle.Read) + internetGatewayIds?: string[]; +} + +@doc("Rules for the InternetGateways") +model RuleProperties { + @doc("Specify action.") + action: Action; + + @doc("List of Addresses to be allowed or denied.") + @madeOptional(Versions.v2024_06_15_preview) + addressList?: string[]; + + @doc("Specify rule condition.") + @added(Versions.v2024_06_15_preview) + condition?: RuleCondition; + + @doc("List of Addresses to be allowed or denied.") + @added(Versions.v2024_06_15_preview) + destinationAddressList?: string[]; + + @doc("List of source IPv4 and IPv6 address to be allowed or denied.") + @added(Versions.v2024_06_15_preview) + sourceAddressList?: string[]; + + @doc("List of header Name and source addresses associated with the header.") + @added(Versions.v2024_06_15_preview) + @Azure.ResourceManager.identifiers(#[]) + headerAddressList?: HeaderAddressProperties[]; +} + +@doc("The Internet Gateway Rules patch resource definition.") +model InternetGatewayRulePatch is TagsUpdate; + +@doc("Specify action.") +union Action { + @doc("Action Allow") + Allow: "Allow", + + @doc("Action Deny") + Deny: "Deny", + + string, +} + +@doc("Header name and source addresses associated with the header.") +@added(Versions.v2024_06_15_preview) +model HeaderAddressProperties { + @doc("Name of the header.") + headerName?: string; + + @doc("List of source remote IP to be allowed or denied.") + @minItems(1) + addressList?: string[]; +} + +@added(Versions.v2024_06_15_preview) +@doc("Specify Rule condition.") +union RuleCondition { + @doc("And Rule-Condition.") + And: "And", + + @doc("Or Rule-Condition.") + Or: "Or", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpCommunity.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpCommunity.tsp new file mode 100644 index 000000000000..ea1c3d7a9cab --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpCommunity.tsp @@ -0,0 +1,100 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; +@doc("IP Community Properties defines the resource properties.") +model IpCommunityProperties { + ...AnnotationResource; + + @added(Versions.v2024_06_15_preview) + @doc("ARM Resource ID of the Network Fabric.") + @visibility(Lifecycle.Read) + networkFabricId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("List of IP Community Rules.") + @Azure.ResourceManager.identifiers(#[]) + ipCommunityRules: IpCommunityRule[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("IP Community patchable properties.") +model IpCommunityPatchableProperties { + @doc("List of IP Community Rules.") + @Azure.ResourceManager.identifiers(#[]) + ipCommunityRules?: IpCommunityRule[]; +} + +@doc("IP Community patchable properties.") +model IpCommunityRule { + @doc("Action to be taken on the configuration. Example: Permit | Deny.") + action: CommunityActionTypes; + + @doc("Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber: int64; + + @doc("Supported well known Community List.") + wellKnownCommunities?: WellKnownCommunities[]; + + @doc("List the community members of IP Community.") + @minItems(1) + communityMembers: string[]; +} + +@doc("The IP Community patch resource definition.") +model IpCommunityPatch { + ...TagsUpdate; + + @doc("IP Community patchable properties.") + properties?: IpCommunityPatchableProperties; +} + +/** + * + * `Internet` - Advertise routes to internet community. + * `LocalAS` - Advertise routes to only localAS peers. + * `NoAdvertise` - Don't advertise routes to any peer. + * `NoExport` - Don't export to next AS. + * `GShut` - Graceful Shutdown (GSHUT) withdraw routes before terminating BGP connection. + * + */ +union WellKnownCommunities { + @doc("WellKnownCommunities-Internet") + Internet: "Internet", + + @doc("WellKnownCommunities-LocalAS") + LocalAS: "LocalAS", + + @doc("WellKnownCommunities-NoAdvertise") + NoAdvertise: "NoAdvertise", + + @doc("WellKnownCommunities-NoExport") + NoExport: "NoExport", + + @doc("WellKnownCommunities-GShut") + GShut: "GShut", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpExtendedCommunity.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpExtendedCommunity.tsp new file mode 100644 index 000000000000..71240e41950e --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpExtendedCommunity.tsp @@ -0,0 +1,72 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("IP Extended Community Properties defines the resource properties.") +model IpExtendedCommunityProperties { + ...AnnotationResource; + + @added(Versions.v2024_06_15_preview) + @doc("ARM Resource ID of the Network Fabric.") + @visibility(Lifecycle.Read) + networkFabricId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("List of IP Extended Community Rules.") + @Azure.ResourceManager.identifiers(#[]) + ipExtendedCommunityRules: IpExtendedCommunityRule[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("List of IP Extended Community Rules.") +model IpExtendedCommunityRule { + @doc("Action to be taken on the configuration. Example: Permit | Deny.") + action: CommunityActionTypes; + + @doc("Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber: int64; + + @doc("Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295.") + @minItems(1) + routeTargets: string[]; +} + +@doc("The IP Extended Communities patch resource definition.") +model IpExtendedCommunityPatch { + ...TagsUpdate; + + @doc("IP Extended Community patchable properties.") + properties?: IpExtendedCommunityPatchProperties; +} + +@doc("IP Extended Community patchable properties.") +model IpExtendedCommunityPatchProperties { + ...AnnotationResource; + + @doc("List of IP Extended Community Rules.") + @Azure.ResourceManager.identifiers(#[]) + ipExtendedCommunityRules?: IpExtendedCommunityRule[]; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpPrefix.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpPrefix.tsp new file mode 100644 index 000000000000..79bd659fe025 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/IpPrefix.tsp @@ -0,0 +1,94 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("IP Prefix Properties defines the properties of the resource.") +model IpPrefixProperties { + ...AnnotationResource; + + @added(Versions.v2024_06_15_preview) + @doc("ARM Resource ID of the Network Fabric.") + @visibility(Lifecycle.Read) + networkFabricId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("The list of IP Prefix Rules.") + @Azure.ResourceManager.identifiers(#[]) + ipPrefixRules: IpPrefixRule[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("IP Prefix Rule properties.") +model IpPrefixRule { + @doc("Action to be taken on the configuration. Example: Permit | Deny.") + action: CommunityActionTypes; + + @doc("Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber: int64; + + @doc("Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126") + networkPrefix: string; + + @doc("Specify prefix-list bounds.") + condition?: Condition; + + @doc("SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128.") + subnetMaskLength?: string; +} + +@doc("The IP Prefix patch resource definition.") +model IpPrefixPatch { + ...TagsUpdate; + + @doc("IP Prefix patchable properties.") + properties?: IpPrefixPatchProperties; +} + +@doc("IP Prefix patchable properties.") +model IpPrefixPatchProperties { + ...AnnotationResource; + + @doc("The list of IP Prefix Rules.") + @Azure.ResourceManager.identifiers(#[]) + ipPrefixRules?: IpPrefixRule[]; +} + +@doc("Specify prefix-list bounds.") +union Condition { + @doc("Condition-EqualTo") + EqualTo: "EqualTo", + + @doc("Condition-GreaterThanOrEqualTo") + GreaterThanOrEqualTo: "GreaterThanOrEqualTo", + + @doc("Condition-LesserThanOrEqualTo") + LesserThanOrEqualTo: "LesserThanOrEqualTo", + + @doc("Condition-Range") + Range: "Range", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/L2IsolationDomain.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/L2IsolationDomain.tsp new file mode 100644 index 000000000000..23131dbfc5e1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/L2IsolationDomain.tsp @@ -0,0 +1,99 @@ +import "./common.tsp"; +using Azure.ResourceManager; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("L2Isolation Domain Properties defines the properties of the resource.") +model L2IsolationDomainProperties { + ...AnnotationResource; + + @doc("ARM Resource ID of the Network Fabric.") + networkFabricId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("Vlan Identifier of the Network Fabric. Example: 501.") + @maxValue(4094) + @minValue(100) + vlanId: int32; + + @doc("Maximum transmission unit. Default value is 1500.") + @maxValue(9200) + @minValue(64) + mtu?: int32 = 1500; + + @added(Versions.v2024_06_15_preview) + @doc("Extended VLAN status, default value is Disabled.") + extendedVlan?: ExtendedVlan = ExtendedVlan.Disabled; + + @added(Versions.v2024_06_15_preview) + @doc("ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.") + networkToNetworkInterconnectId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("The L2 Isolation Domain patch resource definition.") +model L2IsolationDomainPatch { + ...TagsUpdate; + + @doc("Resource properties.") + properties?: L2IsolationDomainPatchProperties; +} + +@doc("L2 Isolation Domain Patch Properties defines the patchable properties of the resource.") +@withoutDefaultValues +model L2IsolationDomainPatchProperties { + ...AnnotationResource; + + @doc("Maximum transmission unit. Default value is 1500.") + @maxValue(9200) + @minValue(64) + mtu?: int32; + + @doc("Extended VLAN status.") + @added(Versions.v2024_06_15_preview) + extendedVlan?: ExtendedVlan; + + @added(Versions.v2024_06_15_preview) + @doc("ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.") + networkToNetworkInterconnectId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; +} + +@doc("Extended VLAN status.") +union ExtendedVlan { + @doc("Extended VLAN is enabled.") + Enabled: "Enabled", + + @doc("Extended VLAN is disabled.") + Disabled: "Disabled", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/L3IsolationDomain.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/L3IsolationDomain.tsp new file mode 100644 index 000000000000..fa2eb8764d4b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/L3IsolationDomain.tsp @@ -0,0 +1,273 @@ +import "./common.tsp"; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("L3 Isolation Domain Properties defines the properties of the resource.") +model L3IsolationDomainProperties { + ...AnnotationResource; + + @doc("Advertise Connected Subnets. Ex: \"True\" | \"False\".") + redistributeConnectedSubnets?: RedistributeConnectedSubnets = RedistributeConnectedSubnets.True; + + @doc("Advertise Static Routes. Ex: \"True\" | \"False\".") + redistributeStaticRoutes?: RedistributeStaticRoutes = RedistributeStaticRoutes.False; + + @doc("Aggregate route configurations.") + aggregateRouteConfiguration?: AggregateRouteConfiguration; + + @doc("Connected Subnet RoutePolicy") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "connectedSubnetRoutePolicy") + connectedSubnetRoutePolicyDeprecated?: ConnectedSubnetRoutePolicy; + + @doc("Connected Subnet RoutePolicy") + @added(Versions.v2024_06_15_preview) + connectedSubnetRoutePolicy?: ConnectedSubnetRoutePolicy; + + @doc("ARM Resource ID of the Network Fabric.") + @visibility(Lifecycle.Read, Lifecycle.Create) + networkFabricId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("Static Route - route policy.") + @added(Versions.v2024_06_15_preview) + staticRouteRoutePolicy?: StaticRouteRoutePolicy; + + @doc("Unique Route Distinguisher configuration") + @added(Versions.v2024_06_15_preview) + uniqueRdConfiguration?: L3UniqueRouteDistinguisherProperties; + + @doc("VRF Limit configuration.") + @added(Versions.v2024_06_15_preview) + routePrefixLimit?: RoutePrefixLimitProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("List of IPv4 and IPv6 aggregate routes.") +model AggregateRouteConfiguration { + @doc("List of IPv4 Route prefixes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + ipv4Routes?: AggregateRoute[]; + + @doc("List of Ipv6Routes prefixes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + ipv6Routes?: AggregateRoute[]; +} + +@doc("List of IPv4 and IPv6 aggregate routes.") +model AggregateRoutePatchConfiguration { + @doc("List of IPv4 Route prefixes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + ipv4Routes?: AggregateRoute[]; + + @doc("List of Ipv6Routes prefixes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + ipv6Routes?: AggregateRoute[]; +} + +@doc("aggregateIpv4Route model.") +model AggregateRoute { + @doc("IPv4 Prefix of the aggregate Ipv4Route.") + @minLength(1) + prefix: string; +} + +@doc("Aggregate Route Patch Model.") +model AggregateRoutePatch is AggregateRoute; + +@doc("Connected Subnet Route Policy properties.") +model ConnectedSubnetRoutePolicy { + @doc("ARM Resource ID of the Route Policy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + exportRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Array of ARM Resource ID of the RoutePolicies.") + exportRoutePolicy?: L3ExportRoutePolicy; +} + +@doc("Connected Subnet Route Policy properties.") +model ConnectedSubnetRoutePolicyPatch { + @doc("ARM Resource ID of the Route Policy. This is used for the backward compatibility.") + @removed(Versions.v2024_06_15_preview) + exportRoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Array of ARM Resource ID of the RoutePolicies.") + exportRoutePolicy?: L3ExportRoutePolicyPatch; +} + +@doc("Static Route - route policy properties.") +@added(Versions.v2024_06_15_preview) +model StaticRouteRoutePolicy { + @doc("Array of ARM Resource ID of the RoutePolicies.") + exportRoutePolicy?: L3ExportRoutePolicy; +} + +@doc("Static Route - route policy properties.") +@added(Versions.v2024_06_15_preview) +model StaticRouteRoutePolicyPatch { + @doc("Array of ARM Resource ID of the RoutePolicies.") + exportRoutePolicy?: L3ExportRoutePolicyPatch; +} + +@doc("Array of ARM Resource ID of the RoutePolicies.") +model L3ExportRoutePolicy { + @doc("ARM Resource ID of the RoutePolicy.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportIpv4RoutePolicyId") + exportIpv4RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy.") + @added(Versions.v2024_06_15_preview) + exportIpv4RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportIpv6RoutePolicyId") + exportIpv6RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM Resource ID of the RoutePolicy.") + @added(Versions.v2024_06_15_preview) + exportIpv6RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; +} + +@doc("Array of ARM Resource ID of the RoutePolicies.") +model L3ExportRoutePolicyPatch is L3ExportRoutePolicy; + +@doc("The L3 Isolation Domain patch resource definition.") +model L3IsolationDomainPatch { + ...TagsUpdate; + + @doc("Resource properties.") + properties?: L3IsolationDomainPatchProperties; +} + +@doc("Resource properties.") +model L3IsolationDomainPatchProperties { + ...AnnotationResource; + + @doc("Advertise Connected Subnets. Ex: \"True\" | \"False\".") + redistributeConnectedSubnets?: RedistributeConnectedSubnets; + + @doc("Advertise Static Routes. Ex: \"True\" | \"False\".") + redistributeStaticRoutes?: RedistributeStaticRoutes; + + @doc("Aggregate route configurations.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "aggregateRouteConfiguration") + aggregateRouteConfigurationDeprecated?: AggregateRouteConfiguration; + + @doc("Aggregate route configurations.") + @added(Versions.v2024_06_15_preview) + aggregateRouteConfiguration?: AggregateRoutePatchConfiguration; + + @doc("Connected Subnet RoutePolicy") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "connectedSubnetRoutePolicy") + connectedSubnetRoutePolicyDeprecated?: ConnectedSubnetRoutePolicy; + + @doc("Connected Subnet RoutePolicy") + @added(Versions.v2024_06_15_preview) + connectedSubnetRoutePolicy?: ConnectedSubnetRoutePolicyPatch; + + @doc("Static Route - route policy.") + @added(Versions.v2024_06_15_preview) + staticRouteRoutePolicy?: StaticRouteRoutePolicyPatch; + + @doc("Virtual Routing and Forwarding (VRF) Limit configuration.") + @added(Versions.v2024_06_15_preview) + routePrefixLimit?: RoutePrefixLimitPatchProperties; +} + +@doc("Advertise Connected Subnets. Ex: \"True\" | \"False\".") +union RedistributeConnectedSubnets { + @doc("RedistributeConnectedSubnets-True") + True: "True", + + @doc("RedistributeConnectedSubnets-False") + False: "False", + + string, +} + +@doc("Advertise Static Routes. Ex: \"True\" | \"False\".") +union RedistributeStaticRoutes { + @doc("RedistributeStaticRoutes-True") + True: "True", + + @doc("RedistributeStaticRoutes-False") + False: "False", + + string, +} + +@doc("Layer3 Route prefix limit configuration.") +@added(Versions.v2024_06_15_preview) +model RoutePrefixLimitProperties { + @doc("Hard limit for the routes.") + hardLimit?: int32; + + @doc("Threshold for the routes.") + threshold?: int32; +} + +@doc("VRP Limit patch configuration.") +@added(Versions.v2024_06_15_preview) +model RoutePrefixLimitPatchProperties is RoutePrefixLimitProperties; + +@doc("Unique Route Distinguisher properties.") +@added(Versions.v2024_06_15_preview) +model L3UniqueRouteDistinguisherProperties { + @doc("List of Unique Route Distinguisher addresses.") + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + uniqueRds?: string[]; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NeighborGroup.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NeighborGroup.tsp new file mode 100644 index 000000000000..f477e12257b9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NeighborGroup.tsp @@ -0,0 +1,67 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Neighbor Group Properties defines the properties of the resource.") +model NeighborGroupProperties { + ...AnnotationResource; + + @doc("An array of destination IPv4 Addresses or IPv6 Addresses.") + destination: NeighborGroupDestination; + + @doc("List of NetworkTap IDs where neighbor group is associated.") + @visibility(Lifecycle.Read) + networkTapIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTaps"; + } + ]>[]; + + @doc("List of Network Tap Rule IDs where neighbor group is associated.") + @visibility(Lifecycle.Read) + networkTapRuleIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTapRules"; + } + ]>[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("The provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("An array of destination IPv4 Addresses or IPv6 Addresses.") +model NeighborGroupDestination { + @doc("Array of IPv4 Addresses.") + @maxItems(16) + ipv4Addresses?: string[]; + + @doc("Array of IPv6 Addresses.") + @maxItems(16) + ipv6Addresses?: string[]; +} + +@doc("An array of destination IPv4 Addresses or IPv6 Addresses.") +model NeighborGroupDestinationPatch is NeighborGroupDestination; + +@doc("The Neighbor Group Patch definition.") +model NeighborGroupPatch { + ...TagsUpdate; + + @doc("Neighbor Group Patch properties.") + properties?: NeighborGroupPatchProperties; +} + +@doc("Neighbor Group Patch properties.") +model NeighborGroupPatchProperties { + ...AnnotationResource; + + @doc("An array of destination IPv4 Addresses or IPv6 Addresses.") + destination?: NeighborGroupDestinationPatch; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkDevice.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkDevice.tsp new file mode 100644 index 000000000000..ecf374c3d593 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkDevice.tsp @@ -0,0 +1,170 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Device Properties defines the properties of the resource.") +model NetworkDeviceProperties { + ...AnnotationResource; + + @doc("The host name of the device.") + @minLength(1) + hostName?: string; + + @doc("Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.") + @minLength(1) + serialNumber: string; + + @doc("Current version of the device as defined in SKU.") + @visibility(Lifecycle.Read) + version?: string; + + @doc("Network Device SKU name.") + @visibility(Lifecycle.Read, Lifecycle.Create) + networkDeviceSku?: string; + + @doc("NetworkDeviceRole is the device role: Example: CE | ToR.") + @visibility(Lifecycle.Read) + networkDeviceRole?: NetworkDeviceRole; + + @doc("Reference to network rack resource id.") + @visibility(Lifecycle.Read) + networkRackId?: string; + + @doc("Management IPv4 Address.") + @visibility(Lifecycle.Read) + managementIpv4Address?: string; + + @doc("Management IPv6 Address.") + @visibility(Lifecycle.Read) + managementIpv6Address?: string; + + @doc("User configured read-write configuration applied on the network devices.") + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + rwDeviceConfig?: string; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("The Network Device Patch Parameters defines the patch parameters of the resource.") +model NetworkDevicePatchParameters { + ...TagsUpdate; + + @doc("Network Device Patch properties.") + properties?: NetworkDevicePatchParametersProperties; +} + +@doc("Network Device Patch properties.") +model NetworkDevicePatchParametersProperties { + ...AnnotationResource; + + @doc("The host name of the device.") + @minLength(1) + hostName?: string; + + @doc("Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.") + @minLength(1) + serialNumber?: string; +} + +@doc("Reboot properties.") +model RebootProperties { + @doc("Type of reboot to be performed. Example: GracefulRebootWithZTP") + rebootType?: RebootType; +} + +@doc("Update the administrative state on list of resources.") +model UpdateDeviceAdministrativeState { + ...EnableDisableOnResources; + + @doc("Administrative state.") + state?: DeviceAdministrativeState; +} + +@doc("NetworkDeviceRole is the device role: Example: CE | ToR.") +union NetworkDeviceRole { + @doc("NetworkDeviceRole-CE(Customer Edge)") + CE: "CE", + + @doc("NetworkDeviceRole-ToR(top of rack)") + ToR: "ToR", + + @doc("NetworkDeviceRole-NPB(Network Packet Broker)") + NPB: "NPB", + + @doc("NetworkDeviceRole-TS(Terminal Server)") + TS: "TS", + + @doc("NetworkDeviceRole-Management") + Management: "Management", + + string, +} + +@doc("Type of reboot to be performed. Example: GracefulRebootWithZTP") +union RebootType { + @doc("RebootType GracefulRebootWithZTP") + GracefulRebootWithZTP: "GracefulRebootWithZTP", + + @doc("RebootType GracefulRebootWithoutZTP") + GracefulRebootWithoutZTP: "GracefulRebootWithoutZTP", + + @doc("RebootType UngracefulRebootWithZTP") + UngracefulRebootWithZTP: "UngracefulRebootWithZTP", + + @doc("RebootType UngracefulRebootWithoutZTP") + UngracefulRebootWithoutZTP: "UngracefulRebootWithoutZTP", + + string, +} + +@doc("Administrative state.") +union DeviceAdministrativeState { + @doc("Device AdministrativeState-RMA") + RMA: "RMA", + + @added(Versions.v2024_06_15_preview) + @doc("Device AdministrativeState-RMA(Return Material Authorization) Ungraceful") + UngracefulRMA: "UngracefulRMA", + + @doc("Device AdministrativeState-Resync") + Resync: "Resync", + + @doc("Device AdministrativeState-GracefulQuarantine") + GracefulQuarantine: "GracefulQuarantine", + + @added(Versions.v2024_06_15_preview) + @doc("Device AdministrativeState-UngracefulQuarantine") + UngracefulQuarantine: "UngracefulQuarantine", + + @doc("Device AdministrativeState-Quarantine") + Quarantine: "Quarantine", + + @doc("Device AdministrativeState-UnderMaintenance") + UnderMaintenance: "UnderMaintenance", + + @doc("Device AdministrativeState-Enable") + Enable: "Enable", + + @added(Versions.v2024_06_15_preview) + @doc("Device AdministrativeState-Disable") + Disable: "Disable", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkDeviceSku.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkDeviceSku.tsp new file mode 100644 index 000000000000..4e0c188276c8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkDeviceSku.tsp @@ -0,0 +1,84 @@ +import "./common.tsp"; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Device SKU Properties defines the properties of the resource.") +model NetworkDeviceSkuProperties { + @doc("Model of the network device.") + `model`: string; + + @doc("Manufacturer of the network device.") + manufacturer?: string; + + @doc("List of supported version details of network device.") + @Azure.ResourceManager.identifiers(#["version"]) + supportedVersions?: SupportedVersionProperties[]; + + @doc("Available roles for the network device.") + supportedRoleTypes?: NetworkDeviceRoleName[]; + + @doc("List of network device interfaces.") + @Azure.ResourceManager.identifiers(#["identifier"]) + interfaces?: DeviceInterfaceProperties[]; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("Supported version details of the network device.") +model SupportedVersionProperties { + @doc("Operating system and firmware combined versions.") + version?: string; + + @doc("Operating system version.") + vendorOsVersion?: string; + + @doc("Firmware version.") + vendorFirmwareVersion?: string; + + @doc("If true newly provisioned Fabric will use this device version by default to bootstrap the network devices for the first time.") + isDefault?: BooleanEnumProperty; +} + +@doc("Network device interface properties.") +model DeviceInterfaceProperties { + @doc("Interface identifier. Example: HundredGigE0/0.") + identifier?: string; + + @doc("Interface type.") + interfaceType?: string; + + @doc("List of supported connector types.") + @Azure.ResourceManager.identifiers(#["connectorType"]) + supportedConnectorTypes?: SupportedConnectorProperties[]; +} + +@doc("Supported connector properties.") +model SupportedConnectorProperties { + @doc("Type of connector used. Example: Optical.") + connectorType?: string; + + @doc("Maximum speed of the connector in Mbps.") + maxSpeedInMbps?: int32; +} + +@doc("Available roles for the network device.") +union NetworkDeviceRoleName { + @doc("NetworkDeviceRoleName-CE(Customer Edge)") + CE: "CE", + + @doc("NetworkDeviceRoleName-ToR(top of rack)") + ToR: "ToR", + + @doc("NetworkDeviceRoleName-NPB(Network Packet Broker)") + NPB: "NPB", + + @doc("NetworkDeviceRoleName-TS(Terminal Server)") + TS: "TS", + + @doc("NetworkDeviceRoleName-Management") + Management: "Management", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabric.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabric.tsp new file mode 100644 index 000000000000..fb91e2160a25 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabric.tsp @@ -0,0 +1,667 @@ +import "./common.tsp"; +using Azure.ResourceManager; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; +@doc("Network Fabric Properties defines the properties of the resource.") +model NetworkFabricProperties { + ...AnnotationResource; + + @doc("Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric.") + @visibility(Lifecycle.Read, Lifecycle.Create) + @minLength(1) + networkFabricSku: string; + + @doc("The version of Network Fabric.") + @minLength(1) + fabricVersion?: string; + + @doc("Array of router IDs.") + @visibility(Lifecycle.Read) + routerIds?: string[]; + + @doc("Bring your own storage account configurations for Network Fabric.") + @added(Versions.v2024_06_15_preview) + storageAccountConfiguration?: StorageAccountConfiguration; + + @doc("Network Fabric Lock details") + @Azure.ResourceManager.identifiers(#[]) + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + @minItems(1) + fabricLocks?: FabricLockProperties[]; + + @doc("Azure resource ID for the NetworkFabricController the NetworkFabric belongs.") + @visibility(Lifecycle.Read, Lifecycle.Create) + networkFabricControllerId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabricControllers"; + } + ]>; + + @doc("Number of compute racks associated to Network Fabric.") + @maxValue(8) + @minValue(1) + rackCount?: int32; + + @doc("Number of servers.Possible values are from 1-16.") + @maxValue(16) + @minValue(1) + serverCountPerRack: int32; + + @doc("IPv4Prefix for Management Network. Example: 10.1.0.0/19.") + @minLength(1) + ipv4Prefix: string; + + @doc("IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59") + @minLength(1) + ipv6Prefix?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of CE devices for CE/PE connectivity.") + @maxValue(4294967295) + @minValue(1) + fabricASN: int64; + + @doc("Network and credentials configuration currently applied to terminal server.") + terminalServerConfiguration: TerminalServerConfiguration; + + @doc("Configuration to be used to setup the management network.") + managementNetworkConfiguration: ManagementNetworkConfigurationProperties; + + @doc("List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU.") + @visibility(Lifecycle.Read) + racks?: string[]; + + @doc("List of L2 Isolation Domain resource IDs under the Network Fabric.") + @visibility(Lifecycle.Read) + l2IsolationDomains?: string[]; + + @doc("List of L3 Isolation Domain resource IDs under the Network Fabric.") + @visibility(Lifecycle.Read) + l3IsolationDomains?: string[]; + + @doc("Hardware alert threshold percentage. Possible values are from 20 to 100.") + @added(Versions.v2024_06_15_preview) + @maxValue(100) + @minValue(20) + hardwareAlertThreshold?: int32; + + @doc("Control Plane Access Control List ARM resource IDs.") + @added(Versions.v2024_06_15_preview) + controlPlaneAcls?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>[]; + + @doc("Feature flag status information") + @Azure.ResourceManager.identifiers(#[]) + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + featureFlags?: FeatureFlagProperties[]; + + @doc("Trusted IP Prefixes ARM resource IDs.") + @added(Versions.v2024_06_15_preview) + trustedIpPrefixes?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/ipPrefixes"; + } + ]>[]; + + @doc("Unique Route Distinguisher configuration") + @added(Versions.v2024_06_15_preview) + uniqueRdConfiguration?: UniqueRouteDistinguisherProperties; + + @doc("Number of Storage arrays associated with the Network Fabric.") + @added(Versions.v2024_06_15_preview) + @minValue(1) + @maxValue(2) + storageArrayCount?: int32; + + @doc("Active commit batch identifiers") + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + activeCommitBatches?: string[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("Network and credentials configuration currently applied to terminal server.") +model TerminalServerConfiguration { + @doc("Username for the terminal server connection.") + @minLength(1) + username: string; + + @doc("Password for the terminal server connection.") + @secret + @minLength(1) + password: string; + + @doc("Serial Number of Terminal server.") + @minLength(1) + serialNumber?: string; + + @doc("IPv4 Address Prefix.") + primaryIpv4Prefix: string; + + @doc("IPv6 Address Prefix.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "primaryIpv6Prefix") + primaryIpv6PrefixDeprecated?: string; + + @doc("IPv6 Address Prefix.") + @added(Versions.v2024_06_15_preview) + primaryIpv6Prefix?: string; + + @doc("Secondary IPv4 Address Prefix.") + secondaryIpv4Prefix: string; + + @doc("Secondary IPv6 Address Prefix.") + secondaryIpv6Prefix?: string; + + @doc("ARM Resource ID used for the NetworkDevice.") + @visibility(Lifecycle.Read) + networkDeviceId?: string; +} + +@doc("Network and credential configuration currently applied on terminal server.") +model VpnConfigurationProperties { + @doc("ARM Resource ID of the Network To Network Interconnect.") + networkToNetworkInterconnectId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; + + @doc("Peering option list.") + peeringOption: PeeringOption; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option B properties") + optionBProperties?: VpnOptionBProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option A properties") + optionAProperties?: VpnOptionAProperties; +} + +@doc("Configuration to be used to setup the management network.") +model ManagementNetworkConfigurationProperties { + @doc("VPN Configuration properties.") + infrastructureVpnConfiguration: VpnConfigurationProperties; + + @doc("VPN Configuration properties.") + workloadVpnConfiguration: VpnConfigurationProperties; +} + +@doc("Network and credential configuration currently applied on terminal server.") +model VpnConfigurationPatchableProperties { + @doc("ARM Resource ID of the Network To Network Interconnect.") + networkToNetworkInterconnectId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; + + @doc("Peering option list.") + peeringOption?: PeeringOption; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option B properties") + optionBProperties?: VpnOptionBPatchProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("option A properties") + optionAProperties?: VpnOptionAPatchProperties; +} + +@doc("The Network Fabric resource definition.") +model NetworkFabricPatch { + ...TagsUpdate; + + @doc("Network Fabric Patch properties.") + properties?: NetworkFabricPatchProperties; + + @added(Versions.v2024_06_15_preview) + @doc("The managed service identities assigned to this resource.") + identity?: ManagedServiceIdentityPatch; +} + +@doc("Network Fabric Patch properties.") +model NetworkFabricPatchProperties { + ...AnnotationResource; + + @doc("Number of compute racks associated to Network Fabric.") + @maxValue(8) + @minValue(1) + rackCount?: int32; + + @doc("Number of servers.Possible values are from 1-16.") + @maxValue(16) + @minValue(1) + serverCountPerRack?: int32; + + @doc("IPv4Prefix for Management Network. Example: 10.1.0.0/19.") + @minLength(1) + ipv4Prefix?: string; + + @doc("IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.") + @minLength(1) + ipv6Prefix?: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of CE devices for CE/PE connectivity.") + @maxValue(4294967295) + @minValue(1) + fabricASN?: int64; + + @doc("Bring your own storage account configurations for Network Fabric.") + @added(Versions.v2024_06_15_preview) + storageAccountConfiguration?: StorageAccountPatchConfiguration; + + @doc("Network and credentials configuration already applied to terminal server.") + terminalServerConfiguration?: TerminalServerPatchConfiguration; + + @doc("Configuration to be used to setup the management network.") + managementNetworkConfiguration?: ManagementNetworkPatchConfiguration; + + @doc("Hardware alert threshold percentage. Possible values are from 20 to 100.") + @added(Versions.v2024_06_15_preview) + @maxValue(100) + @minValue(20) + hardwareAlertThreshold?: int32; + + @doc("Control Plane Access Control List ARM resource IDs.") + @added(Versions.v2024_06_15_preview) + controlPlaneAcls?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>[]; + + @doc("Trusted IP Prefix ARM resource IDs.") + @added(Versions.v2024_06_15_preview) + trustedIpPrefixes?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/ipPrefixes"; + } + ]>[]; + + @doc("Unique Route Distinguisher configuration") + @added(Versions.v2024_06_15_preview) + uniqueRdConfiguration?: UniqueRouteDistinguisherPatchProperties; +} + +@doc("Network and credentials configuration already applied to terminal server.") +model TerminalServerPatchConfiguration { + @doc("Username for the terminal server connection.") + @minLength(1) + username?: string; + + @doc("Password for the terminal server connection.") + @secret + @minLength(1) + password?: string; + + @doc("Serial Number of Terminal server.") + @minLength(1) + serialNumber?: string; + + @doc("IPv4 Address Prefix.") + primaryIpv4Prefix?: string; + + @doc("IPv6 Address Prefix.") + primaryIpv6Prefix?: string; + + @doc("Secondary IPv4 Address Prefix.") + secondaryIpv4Prefix?: string; + + @doc("Secondary IPv6 Address Prefix.") + secondaryIpv6Prefix?: string; +} + +@doc("Configuration to be used to setup the management network.") +model ManagementNetworkPatchConfiguration { + @doc("VPN Configuration properties.") + infrastructureVpnConfiguration?: VpnConfigurationPatchableProperties; + + @doc("VPN Configuration properties.") + workloadVpnConfiguration?: VpnConfigurationPatchableProperties; +} + +@doc("Model used for Upgrade Network Fabric Properties") +model UpgradeNetworkFabricProperties { + ...UpdateVersion; + + @doc("Action to be performed while upgrading the fabric.") + action?: NetworkFabricUpgradeAction; +} + +@doc("Validation configuration properties.") +model ValidateConfigurationProperties { + @doc("Validate action that to be performed") + validateAction?: ValidateAction; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("option A properties") +model VpnOptionAProperties { + @doc("MTU to use for option A peering.") + @maxValue(9200) + @minValue(64) + mtu?: int32 = 1500; + + @doc("Vlan Id.Example : 501") + @maxValue(4094) + @minValue(501) + vlanId: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Peer ASN number.Example : 28") + @maxValue(4294967295) + @minValue(1) + peerASN: int64; + + @doc("BFD Configuration properties.") + bfdConfiguration?: BfdConfiguration; + + ...Layer3IpPrefixProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Peering optionA properties") +model VpnOptionAPatchProperties { + @doc("MTU to use for option A peering.") + @maxValue(9200) + @minValue(64) + mtu?: int32; + + @doc("Vlan Id.Example : 501") + @maxValue(4094) + @minValue(501) + vlanId?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Peer ASN number.Example : 28") + @maxValue(4294967295) + @minValue(1) + peerASN?: int64; + + @doc("BFD Configuration properties.") + bfdConfiguration?: BfdPatchConfiguration; + + ...Layer3IpPrefixPatchProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Option B configuration to be used for Management VPN.") +model VpnOptionBProperties { + @doc("Route Targets to be applied for incoming routes into CE. This is for backward compatibility.") + importRouteTargets?: string[]; + + @doc("Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.") + exportRouteTargets?: string[]; + + @doc("Route Targets to be applied.") + routeTargets?: RouteTargetInformation; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Option B configuration to be used for Management VPN.") +model VpnOptionBPatchProperties { + @doc("Route Targets to be applied for incoming routes into CE. This is for backward compatibility.") + importRouteTargets?: string[]; + + @doc("Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.") + exportRouteTargets?: string[]; + + @doc("Route Targets to be applied.") + routeTargets?: RouteTargetPatchInformation; +} + +@doc("Validate action that to be performed") +union ValidateAction { + @doc("ValidateAction-Cabling") + Cabling: "Cabling", + + @doc("ValidateAction-Configuration") + Configuration: "Configuration", + + @doc("ValidateAction-Connectivity") + Connectivity: "Connectivity", + + string, +} + +@doc("Action to be performed while upgrading the fabric.") +union NetworkFabricUpgradeAction { + @doc("UpgradeAction-Start") + Start: "Start", + + @doc("UpgradeAction -Complete") + Complete: "Complete", + + string, +} + +@doc("Network Fabric Lock Request.") +@added(Versions.v2024_06_15_preview) +model NetworkFabricLockRequest { + @doc("Type of lock to be applied") + lockType?: NetworkFabricLockType; + + @doc("Action to be performed on the lock") + action?: NetworkFabricLockAction; +} + +@doc("Storage account configuration.") +@added(Versions.v2024_06_15_preview) +model StorageAccountConfiguration { + @doc("Network Fabric storage account resource identifier.") + storageAccountId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Storage/storageAccounts"; + } + ]>; + + @doc("The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned.") + storageAccountIdentity?: IdentitySelector; +} + +@doc("Storage account configuration.") +@added(Versions.v2024_06_15_preview) +model StorageAccountPatchConfiguration { + @doc("Network Fabric storage account resource identifier.") + storageAccountId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Storage/storageAccounts"; + } + ]>; + + @doc("The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned.") + storageAccountIdentity?: IdentitySelectorPatch; +} + +@doc("Network Fabric Lock Configuration.") +@added(Versions.v2024_06_15_preview) +model FabricLockProperties { + @doc("NetworkFabric Lock State.") + lockState?: LockConfigurationState; + + @doc("NetworkFabric Lock Type.") + lockType?: NetworkFabricLockType; +} + +@doc("Lock Configuration State.") +@added(Versions.v2024_06_15_preview) +union LockConfigurationState { + @doc("LockConfigurationState Enabled") + Enabled: "Enabled", + + @doc("LockConfigurationState Disabled") + Disabled: "Disabled", + + string, +} + +@doc("Network fabric lock action") +@added(Versions.v2024_06_15_preview) +union NetworkFabricLockAction { + @doc("Perform lock operation") + Lock: "Lock", + + @doc("Perform unlock operation") + Unlock: "Unlock", + + string, +} + +@doc("Network fabric lock type") +@added(Versions.v2024_06_15_preview) +union NetworkFabricLockType { + @doc("A administrative lock/unlock operation will be performed") + Administrative: "Administrative", + + @doc("A lock/unlock operation will be performed on the configuration") + Configuration: "Configuration", + + string, +} + +@doc("Feature flag properties.") +@added(Versions.v2024_06_15_preview) +model FeatureFlagProperties { + @doc("Feature flag name.") + featureFlagName?: string; + + @doc("Feature flag value.") + featureFlagValue?: string; +} + +@doc("Arm Configuration Diff Response.") +@added(Versions.v2024_06_15_preview) +model ArmConfigurationDiffResponse { + @doc("Storage URL to the diff file.") + configurationDiffUrl?: string; + + ...ErrorResponse; +} + +@doc("View Device Configuration Response.") +@added(Versions.v2024_06_15_preview) +model ViewDeviceConfigurationResponse { + @doc("Storage URL to the device configuration file.") + deviceConfigurationUrl?: string; + + ...ErrorResponse; +} + +@doc("Unique Route Distinguisher properties.") +@added(Versions.v2024_06_15_preview) +model UniqueRouteDistinguisherProperties { + @doc("Unique Route Distinguisher configuration state. Default is Enabled.") + @added(Versions.v2024_06_15_preview) + uniqueRdConfigurationState?: UniqueRouteDistinguisherConfigurationState = UniqueRouteDistinguisherConfigurationState.Enabled; + + @doc("List of Unique Route Distinguisher addresses.") + @added(Versions.v2024_06_15_preview) + @visibility(Lifecycle.Read) + uniqueRds?: string[]; + + @doc("NNI derived unique Route Distinguisher state. Default is Disabled.") + @added(Versions.v2024_06_15_preview) + nniDerivedUniqueRdConfigurationState?: NNIDerivedUniqueRouteDistinguisherConfigurationState = NNIDerivedUniqueRouteDistinguisherConfigurationState.Disabled; +} + +@doc("Unique Route Distinguisher configuration properties.") +@added(Versions.v2024_06_15_preview) +model UniqueRouteDistinguisherPatchProperties { + @doc("Unique Route Distinguisher configuration state. Default is Enabled.") + @added(Versions.v2024_06_15_preview) + uniqueRdConfigurationState?: UniqueRouteDistinguisherConfigurationState; + + @doc("NNI derived unique Route Distinguisher state. Default is Disabled.") + @added(Versions.v2024_06_15_preview) + nniDerivedUniqueRdConfigurationState?: NNIDerivedUniqueRouteDistinguisherConfigurationState; +} + +@doc("Commit Batch Status Request.") +@added(Versions.v2024_06_15_preview) +model CommitBatchStatusRequest { + @doc("Commit Batch Identifier. If not provided, the latest commit batch status will be returned.") + commitBatchId?: string; +} + +@doc("Commit Batch Status Response.") +@added(Versions.v2024_06_15_preview) +model CommitBatchStatusResponse { + @doc("Commit Batch Identifier.") + commitBatchId?: string; + + @doc("Commit Batch State.") + commitBatchState?: CommitBatchState; + + @doc("Commit Batch Details.") + commitBatchDetails?: CommitBatchDetails; + + ...ErrorResponse; +} + +@doc("Discard Commit Batch Request.") +@added(Versions.v2024_06_15_preview) +model DiscardCommitBatchRequest { + @doc("Commit Batch Identifier. If not provided, the latest commit batch status will be returned.") + commitBatchId?: string; +} + +@doc("Discard Commit Batch Response.") +@added(Versions.v2024_06_15_preview) +model DiscardCommitBatchResponse { + @doc("Commit Batch Identifier.") + commitBatchId?: string; + + ...ErrorResponse; +} + +@doc("Commit Batch State.") +@added(Versions.v2024_06_15_preview) +union CommitBatchState { + @doc("CommitBatchState-PartialSuccess") + Processing: "Processing", + + @doc("CommitBatchState-Succeeded") + Succeeded: "Succeeded", + + @doc("CommitBatchState-Failed") + Failed: "Failed", + + string, +} + +@doc("Commit Batch Details.") +@added(Versions.v2024_06_15_preview) +model CommitBatchDetails { + @doc("List of devices for which the commit operation failed.") + failedDevices?: string[]; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabricController.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabricController.tsp new file mode 100644 index 000000000000..fbfc56815a46 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabricController.tsp @@ -0,0 +1,151 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; +using TypeSpec.Reflection; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("NetworkFabricControllerProperties defines the resource properties.") +model NetworkFabricControllerProperties { + ...AnnotationResource; + + @doc("As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute)") + @Azure.ResourceManager.identifiers(#["expressRouteCircuitId"]) + infrastructureExpressRouteConnections?: ExpressRouteConnectionInformation[]; + + @doc("As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).") + @Azure.ResourceManager.identifiers(#["expressRouteCircuitId"]) + workloadExpressRouteConnections?: ExpressRouteConnectionInformation[]; + + @doc("InfrastructureServices IP ranges.") + @visibility(Lifecycle.Read) + infrastructureServices?: ControllerServices; + + @doc("WorkloadServices IP ranges.") + @visibility(Lifecycle.Read) + workloadServices?: ControllerServices; + + @doc("Managed Resource Group configuration properties.") + managedResourceGroupConfiguration?: ManagedResourceGroupConfiguration; + + @doc("The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service.") + @visibility(Lifecycle.Read) + networkFabricIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>[]; + + @doc("A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility.") + @visibility(Lifecycle.Read) + @removed(Versions.v2024_06_15_preview) + workloadManagementNetwork?: boolean = true; + + @doc("A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints.") + isWorkloadManagementNetworkEnabled?: IsWorkloadManagementNetworkEnabled = IsWorkloadManagementNetworkEnabled.True; + + @doc("List of tenant InternetGateway resource IDs") + @visibility(Lifecycle.Read) + tenantInternetGatewayIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/internetGateways"; + } + ]>[]; + + @doc("IPv4 Network Fabric Controller Address Space.") + @minLength(1) + ipv4AddressSpace?: string = "10.0.0.0/19"; + + @doc("IPv6 Network Fabric Controller Address Space.") + @minLength(1) + ipv6AddressSpace?: string = "FC00::/59"; + + @doc("Network Fabric Controller SKU.") + nfcSku?: NfcSku = NfcSku.Standard; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("Network Fabric Controller services.") +model ControllerServices { + @doc("The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute.") + ipv4AddressSpaces?: string[]; + + @doc("The IPv6 is not supported right now.") + ipv6AddressSpaces?: string[]; +} + +@doc("Managed Resource Group configuration properties.") +model ManagedResourceGroupConfiguration { + @doc("The NFC service will be hosted in a Managed resource group.") + name?: string; + + @doc("Managed resource group location.") + @visibility(Lifecycle.Read, Lifecycle.Create) + location?: string; +} + +@doc("The ExpressRoute circuit ID and the Auth Key are required for you to successfully deploy NFC service.") +model ExpressRouteConnectionInformation { + @doc("The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute.") + expressRouteCircuitId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.Network/expressRouteCircuits"; + } + ]>; + + @doc("Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute.") + @secret + expressRouteAuthorizationKey: string; +} + +@doc("The Network Fabric Controller Patch payload definition.") +model NetworkFabricControllerPatch { + ...TagsUpdate; + + @doc("Network Fabric Controller patch properties.") + properties?: NetworkFabricControllerPatchProperties; +} + +@doc("Network Fabric Controller patch properties.") +model NetworkFabricControllerPatchProperties { + @doc("As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute)") + @Azure.ResourceManager.identifiers(#["expressRouteCircuitId"]) + infrastructureExpressRouteConnections?: ExpressRouteConnectionInformation[]; + + @doc("As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).") + @Azure.ResourceManager.identifiers(#["expressRouteCircuitId"]) + workloadExpressRouteConnections?: ExpressRouteConnectionInformation[]; +} + +@doc("A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints.") +union IsWorkloadManagementNetworkEnabled { + @doc("IsWorkloadManagementNetworkEnabled-True") + True: "True", + + @doc("IsWorkloadManagementNetworkEnabled-False") + False: "False", + + string, +} + +@doc("Network Fabric Controller SKU.") +union NfcSku { + @doc("NfcSku-Basic") + Basic: "Basic", + + @doc("NfcSku-Standard") + Standard: "Standard", + + @doc("NfcSku-HighPerformance") + HighPerformance: "HighPerformance", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabricSku.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabricSku.tsp new file mode 100644 index 000000000000..2d98f69a2da8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkFabricSku.tsp @@ -0,0 +1,40 @@ +import "./common.tsp"; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Fabric SKU Properties define properties of the resource.") +model NetworkFabricSkuProperties { + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property" "This is a valid property name." + @doc("Type of Network Fabric SKU.") + @visibility(Lifecycle.Read) + type?: FabricSkuType; + + @doc("Maximum number of compute racks available for this Network Fabric SKU. The value of max count racks is 4 for 4 rack SKU and 8 for 8 rack SKU.") + maxComputeRacks?: int32; + + @doc("Maximum number of servers available for this Network Fabric SKU.") + maximumServerCount?: int32; + + @doc("List of supported Network Fabric SKU versions.") + @visibility(Lifecycle.Read) + supportedVersions?: string[]; + + @doc("URL providing detailed configuration of the fabric SKU.") + @visibility(Lifecycle.Read) + details?: string; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("Type of Network Fabric SKU.") +union FabricSkuType { + @doc("FabricSkuType-SingleRack") + SingleRack: "SingleRack", + + @doc("FabricSkuType-MultiRack") + MultiRack: "MultiRack", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkInterface.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkInterface.tsp new file mode 100644 index 000000000000..2c65a65a63dd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkInterface.tsp @@ -0,0 +1,81 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Interface Properties defines the properties of the resource.") +model NetworkInterfaceProperties { + ...AnnotationResource; + + @doc("Physical Identifier of the network interface.") + @visibility(Lifecycle.Read) + physicalIdentifier?: string; + + @doc("The ARM resource id of the interface or compute server its connected to.") + @visibility(Lifecycle.Read) + connectedTo?: string; + + @doc("The Interface Type. Example: Management/Data") + @visibility(Lifecycle.Read) + interfaceType?: InterfaceType; + + @doc("IPv4Address of the interface.") + @visibility(Lifecycle.Read) + ipv4Address?: string; + + @doc("IPv6Address of the interface.") + @visibility(Lifecycle.Read) + ipv6Address?: string; + + @added(Versions.v2024_06_15_preview) + @doc("Description of the interface.") + description?: string; + + @added(Versions.v2024_06_15_preview) + @doc("Additional description of the interface.") + additionalDescription?: string; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("The NetworkInterfacePatch resource definition.") +model NetworkInterfacePatch { + @doc("Network Interface Patch properties.") + properties?: NetworkInterfacePatchProperties; +} + +@doc("Network Interface Patch properties.") +model NetworkInterfacePatchProperties { + ...AnnotationResource; + + @added(Versions.v2024_06_15_preview) + @doc("Description of the interface.") + description?: string; + + @added(Versions.v2024_06_15_preview) + @doc("Additional description of the interface.") + additionalDescription?: string; +} + +@doc("The Interface Type. Example: Management/Data") +union InterfaceType { + @doc("InterfaceType-Management") + Management: "Management", + + @doc("InterfaceType-Data") + Data: "Data", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkMonitor.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkMonitor.tsp new file mode 100644 index 000000000000..9075c68defbf --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkMonitor.tsp @@ -0,0 +1,248 @@ +import "./common.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Monitor Properties defines the properties of the resource.") +@added(Versions.v2024_06_15_preview) +model NetworkMonitorProperties { + ...AnnotationResource; + + @doc("BMP Configurations for the Network Fabric.") + bmpConfiguration?: BmpConfigurationProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provides you the latest status of the NetworkMonitor resource") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("Station Configuration State.") +union StationConfigurationState { + @doc("StationConfigurationState Enabled") + Enabled: "Enabled", + + @doc("StationConfigurationState Disabled") + Disabled: "Disabled", + + string, +} + +@doc("Station Connection Mode.") +union StationConnectionMode { + @doc("StationConnectionMode Active") + Active: "Active", + + @doc("StationConnectionMode Passive") + Passive: "Passive", + + string, +} + +@doc("Station Connection Properties.") +model StationConnectionProperties { + @doc("Connection keepalive idle time in seconds") + @maxValue(3600) + @minValue(1) + keepaliveIdleTime?: int32 = 180; + + @doc("Probe interval in seconds, default value is 60") + @maxValue(3600) + @minValue(1) + probeInterval?: int32 = 60; + + @doc("Probe count, default value is 10") + @maxValue(100) + @minValue(1) + probeCount?: int32 = 10; +} + +@doc("Station Connection PATCH Properties.") +model StationConnectionPatchProperties { + @doc("Connection keepalive idle time in seconds") + @maxValue(3600) + @minValue(1) + keepaliveIdleTime?: int32; + + @doc("Probe interval in seconds, default value is 60") + @maxValue(3600) + @minValue(1) + probeInterval?: int32; + + @doc("Probe count, default value is 10") + @maxValue(100) + @minValue(1) + probeCount?: int32; +} + +@doc("Export Policy for the BGP Monitoring Protocol (BMP) Configuration.") +union BmpExportPolicy { + @doc("BMP ExportPolicy Pre-Policy") + PrePolicy: "Pre-Policy", + + @doc("BMP ExportPolicy Post-Policy") + PostPolicy: "Post-Policy", + + @doc("BMP ExportPolicy All") + All: "All", + + string, +} + +@doc("Monitored Address Family.") +union BmpMonitoredAddressFamily { + @doc("IPv4 Unicast") + ipv4Unicast: "ipv4Unicast", + + @doc("IPv6 Unicast") + ipv6Unicast: "ipv6Unicast", + + @doc("VPN IPv4") + vpnIpv4: "vpnIpv4", + + @doc("VPN IPv6") + vpnIpv6: "vpnIpv6", + + @doc("All Address Families") + All: "All", + + string, +} + +@doc("BGP Monitoring Protocol (BMP) Configuration properties.") +model BmpConfigurationProperties { + @doc("Enabling a station. Either True/False.") + stationConfigurationState?: StationConfigurationState; + + @doc("Scope resource ARM Identifier.") + scopeResourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("Name of the station.") + stationName?: string; + + @doc("IP Address of the station.") + stationIp?: string; + + @doc("Port of the station. Default value is 5000.") + @maxValue(65535) + @minValue(1) + stationPort?: int32 = 5000; + + @doc("Station Connection Mode.") + stationConnectionMode?: StationConnectionMode; + + @doc("Station Connection Properties.") + stationConnectionProperties?: StationConnectionProperties; + + @doc("Network of the station") + stationNetwork?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/l3Isolationdomains/internalNetwork"; + }, + { + type: "Microsoft.ManagedNetworkFabric/l3Isolationdomains/externalNetwork"; + } + ]>; + + @doc("The List of Network ID's that need to be monitored.") + monitoredNetworks?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/l3IsolationDomains"; + } + ]>[]; + + @doc("Export Policy for the BMP Configuration.") + exportPolicy?: BmpExportPolicy = BmpExportPolicy.All; + + @doc("Monitored Address Families for the BMP Configuration.") + monitoredAddressFamilies?: BmpMonitoredAddressFamily[] = #[ + BmpMonitoredAddressFamily.All + ]; +} + +@doc("BMP Configuration patch properties.") +model BmpConfigurationPatchProperties { + @doc("Enabling a station. Either True/False.") + stationConfigurationState?: StationConfigurationState; + + @doc("Scope resource ARM Identifier.") + scopeResourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("Name of the station.") + stationName?: string; + + @doc("IP Address of the station.") + stationIp?: string; + + @doc("Port of the station. Default value is 5000.") + @maxValue(65535) + @minValue(1) + stationPort?: int32; + + @doc("Station Connection Mode.") + stationConnectionMode?: StationConnectionMode; + + @doc("Station Connection Properties.") + stationConnectionProperties?: StationConnectionPatchProperties; + + @doc("Network of the station") + stationNetwork?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/l3Isolationdomains/internalNetwork"; + }, + { + type: "Microsoft.ManagedNetworkFabric/l3Isolationdomains/externalNetwork"; + } + ]>; + + @doc("The List of Network ID's that need to be monitored.") + monitoredNetworks?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/l3IsolationDomains"; + } + ]>[]; + + @doc("Export Policy for the BMP Configuration.") + exportPolicy?: BmpExportPolicy; + + @doc("Monitored Address Families for the BMP Configuration.") + monitoredAddressFamilies?: BmpMonitoredAddressFamily[]; +} + +@doc("The Network Monitor Patch resource definition.") +@added(Versions.v2024_06_15_preview) +model NetworkMonitorPatch { + ...TagsUpdate; + + @doc("Network Monitor Patch properties.") + properties?: NetworkMonitorPatchProperties; +} + +@doc("The Network Monitor Patch Properties.") +model NetworkMonitorPatchProperties { + @doc("BGP Monitoring Protocol (BMP) Configurations for the Network Monitor.") + bmpConfiguration?: BmpConfigurationPatchProperties; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkPacketBroker.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkPacketBroker.tsp new file mode 100644 index 000000000000..27309154ef8c --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkPacketBroker.tsp @@ -0,0 +1,59 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Packet Broker Properties defines the properties of the resource.") +model NetworkPacketBrokerProperties { + @doc("ARM resource ID of the Network Fabric.") + @visibility(Lifecycle.Read, Lifecycle.Create) + networkFabricId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("List of ARM resource IDs of Network Devices [NPB].") + @visibility(Lifecycle.Read) + networkDeviceIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkDevices"; + } + ]>[]; + + @doc("List of network interfaces across NPB devices that are used to mirror source traffic.") + @visibility(Lifecycle.Read) + sourceInterfaceIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces"; + } + ]>[]; + + @doc("List of network Tap IDs configured on NPB.") + @visibility(Lifecycle.Read) + networkTapIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTaps"; + } + ]>[]; + + @doc("List of neighbor group IDs configured on NPB.") + @visibility(Lifecycle.Read) + neighborGroupIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTaps"; + } + ]>[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("The NetworkPacketBroker patch resource definition.") +model NetworkPacketBrokerPatch is TagsUpdate; diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkRack.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkRack.tsp new file mode 100644 index 000000000000..61e02e848429 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkRack.tsp @@ -0,0 +1,53 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Rack Properties defines the properties of the resource.") +model NetworkRackProperties { + ...AnnotationResource; + + @doc("Network Rack SKU name.") + networkRackType?: NetworkRackType; + + @doc("ARM resource ID of the Network Fabric.") + networkFabricId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("List of network device ARM resource IDs.") + @visibility(Lifecycle.Read) + networkDevices?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkDevices"; + } + ]>[]; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +@doc("Network Rack patch resource definition.") +model NetworkRackPatch is TagsUpdate; + +@doc("Network Rack SKU name.") +union NetworkRackType { + @doc("NetworkRackType-Aggregate") + Aggregate: "Aggregate", + + @doc("NetworkRackType-Compute") + Compute: "Compute", + + @doc("NetworkRackType-Combined") + Combined: "Combined", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkTap.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkTap.tsp new file mode 100644 index 000000000000..61804a3d586d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkTap.tsp @@ -0,0 +1,167 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Tap Properties defines the properties of the resource.") +model NetworkTapProperties { + ...AnnotationResource; + + @doc("ARM resource ID of the Network Packet Broker.") + @visibility(Lifecycle.Read, Lifecycle.Create) + networkPacketBrokerId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("Source Tap Rule Id. ARM Resource ID of the Network Tap Rule.") + @visibility(Lifecycle.Read) + sourceTapRuleId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTapRules"; + } + ]>; + + @doc("List of destinations to send the filter traffic.") + @Azure.ResourceManager.identifiers(#[]) + destinations: DestinationProperties[]; + + @doc("Polling type.") + pollingType?: PollingType = PollingType.Pull; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Gets the configurations state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource. Example -Enabled/Disabled") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("The network tap destination properties.") +model DestinationProperties { + @doc("Destination name.") + @minLength(1) + name: string; + + @doc("Type of destination. Input can be IsolationDomain or Direct.") + destinationType: DestinationType; + + @doc("The destination Id. ARM Resource ID of either NNI or Internal Networks.") + destinationId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkToNetworkInterconnects"; + }, + { + type: "Microsoft.ManagedNetworkFabric/l3IsolationDomains/internalNetworks"; + } + ]>; + + @doc("Isolation Domain Properties.") + isolationDomainProperties?: IsolationDomainProperties; + + @doc("ARM Resource ID of destination Tap Rule that contains match configurations.") + destinationTapRuleId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTapRules"; + } + ]>; +} + +@doc("The network tap destination properties.") +model DestinationPatchProperties { + @doc("Destination name.") + @minLength(1) + name?: string; + + @doc("Type of destination. Input can be IsolationDomain or Direct.") + destinationType?: DestinationType; + + @doc("The destination Id. ARM Resource ID of either NNI or Internal Networks.") + destinationId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkToNetworkInterconnects"; + }, + { + type: "Microsoft.ManagedNetworkFabric/l3IsolationDomains/internalNetworks"; + } + ]>; + + @doc("Isolation Domain Properties.") + isolationDomainProperties?: IsolationDomainPatchProperties; + + @doc("ARM Resource ID of destination Tap Rule that contains match configurations.") + destinationTapRuleId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkTapRules"; + } + ]>; +} + +@doc("Isolation Domain Properties.") +model IsolationDomainProperties { + @doc("Type of encapsulation.") + encapsulation?: Encapsulation; + + @doc("List of Neighbor Group IDs.") + neighborGroupIds?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/neighborGroups"; + } + ]>[]; +} + +@doc("Isolation Domain Properties.") +model IsolationDomainPatchProperties is IsolationDomainProperties; + +@doc("The NetworkFabric resource definition.") +model NetworkTapPatch { + ...TagsUpdate; + + @doc("Resource properties.") + properties?: NetworkTapPatchProperties; +} + +@doc("The Network Tap resource patch definition.") +model NetworkTapPatchProperties { + ...AnnotationResource; + + @doc("Polling type.") + pollingType?: PollingType; + + @doc("List of destination properties to send the filter traffic.") + @Azure.ResourceManager.identifiers(#[]) + destinations?: DestinationPatchProperties[]; +} + +@doc("Type of destination. Input can be IsolationDomain or Direct.") +union DestinationType { + @doc("DestinationType-IsolationDomain") + IsolationDomain: "IsolationDomain", + + @doc("DestinationType-Direct") + Direct: "Direct", + + string, +} + +@doc("Type of encapsulation.") +union Encapsulation { + @doc("Encapsulation-None") + None: "None", + + @doc("Encapsulation-GRE") + GRE: "GRE", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkTapRule.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkTapRule.tsp new file mode 100644 index 000000000000..30cd64e596fb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkTapRule.tsp @@ -0,0 +1,274 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Network Tap Rule Properties defines the resource properties.") +model NetworkTapRuleProperties { + ...AnnotationResource; + + @doc("Input method to configure Network Tap Rule.") + configurationType: ConfigurationType; + + @doc("Network Tap Rules file URL.") + tapRulesUrl?: url; + + @doc("List of match configurations.") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + matchConfigurations?: NetworkTapRuleMatchConfiguration[]; + + @doc("List of dynamic match configurations.") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + dynamicMatchConfigurations?: CommonDynamicMatchConfiguration[]; + + @doc("The ARM resource Id of the NetworkTap.") + @visibility(Lifecycle.Read) + networkTapId?: string; + + @doc("Polling interval in seconds.") + pollingIntervalInSeconds?: PollingIntervalInSeconds = PollingIntervalInSeconds.Thirty; + + @doc("The last sync timestamp.") + @visibility(Lifecycle.Read) + lastSyncedTime?: utcDateTime; + + @doc("Global network tap rule actions") + @added(Versions.v2024_06_15_preview) + globalNetworkTapRuleActions?: GlobalNetworkTapRuleActionProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("Defines the match configuration that are supported to filter the traffic.") +model NetworkTapRuleMatchConfiguration { + @doc("The name of the match configuration.") + @minLength(1) + matchConfigurationName?: string; + + @doc("Sequence Number of the match configuration..") + @maxValue(4294967295) + @minValue(1) + sequenceNumber?: int64; + + @doc("Type of IP Address. IPv4 or IPv6") + ipAddressType?: IPAddressType; + + @doc("List of the match conditions.") + @Azure.ResourceManager.identifiers(#[]) + matchConditions?: NetworkTapRuleMatchCondition[]; + + @doc("List of actions that need to be performed for the matched conditions.") + @Azure.ResourceManager.identifiers(#[]) + actions?: NetworkTapRuleAction[]; +} + +@doc("Defines the match configuration that are supported to filter the traffic.") +model NetworkTapRuleMatchConfigurationPatch { + @doc("The name of the match configuration.") + @minLength(1) + matchConfigurationName?: string; + + @doc("Sequence Number of the match configuration..") + @maxValue(4294967295) + @minValue(1) + sequenceNumber?: int64; + + @doc("Type of IP Address. IPv4 or IPv6") + ipAddressType?: IPAddressType; + + @doc("List of the match conditions.") + @Azure.ResourceManager.identifiers(#[]) + matchConditions?: NetworkTapRuleMatchConditionPatch[]; + + @doc("List of actions that need to be performed for the matched conditions.") + @Azure.ResourceManager.identifiers(#[]) + actions?: NetworkTapRuleActionPatch[]; +} + +@doc("Defines the match condition that is supported to filter the traffic.") +model NetworkTapRuleMatchCondition { + ...CommonMatchConditions; + + @doc("Encapsulation Type that needs to be matched.") + encapsulationType?: EncapsulationType = EncapsulationType.None; + + @doc("Defines the port condition that needs to be matched.") + portCondition?: PortCondition; +} + +@doc("Defines the match condition that is supported to filter the traffic.") +model NetworkTapRuleMatchConditionPatch { + ...CommonMatchConditionsPatch; + + @doc("Encapsulation Type that needs to be matched.") + encapsulationType?: EncapsulationType; + + @doc("Defines the port condition that needs to be matched.") + portCondition?: PortConditionPatch; +} + +@doc("Action that need to performed.") +model NetworkTapRuleAction { + @doc("Type of actions that can be performed.") + type?: TapRuleActionType; + + @doc("Truncate. 0 indicates do not truncate.") + @minLength(1) + truncate?: string; + + @doc("The parameter to enable or disable the timestamp.") + isTimestampEnabled?: BooleanEnumProperty; + + @doc("Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup.") + destinationId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/neighborGroups"; + }, + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects"; + } + ]>; + + // This is property is present in the older version of the API. However the description for this field is changed + // Hence this property is removed and added with a same name but with a different description + @doc("The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "matchConfigurationName") + @minLength(1) + matchConfigurationNameDeprecated?: string; + + @doc("The name of the match configuration. This is used when Goto type is provided.") + @added(Versions.v2024_06_15_preview) + @minLength(1) + matchConfigurationName?: string; +} + +@doc("Action that need to performed.") +model NetworkTapRuleActionPatch is NetworkTapRuleAction; + +@doc("The NetworkTapRule resource definition.") +model NetworkTapRulePatch { + ...TagsUpdate; + + @doc("Network Tap Rule Patch properties.") + properties?: NetworkTapRulePatchProperties; +} + +@doc("Network Tap Rule Patch properties.") +model NetworkTapRulePatchProperties { + ...AnnotationResource; + + @doc("Input method to configure Network Tap Rule.") + configurationType?: ConfigurationType; + + @doc("Network Tap Rules file URL.") + tapRulesUrl?: url; + + @doc("Global network tap rule actions") + @added(Versions.v2024_06_15_preview) + globalNetworkTapRuleActions?: GlobalNetworkTapRuleActionPatchProperties; + + @doc("List of match configurations.") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + matchConfigurations?: NetworkTapRuleMatchConfigurationPatch[]; + + @doc("List of dynamic match configurations.") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + dynamicMatchConfigurations?: CommonDynamicMatchConfigurationPatch[]; +} + +@doc("Polling interval in seconds.") +union PollingIntervalInSeconds { + @doc("30 PollingIntervalInSeconds") + Thirty: 30, + + @doc("60 PollingIntervalInSeconds") + sixty: 60, + + @doc("90 PollingIntervalInSeconds") + Ninety: 90, + + @doc("120 PollingIntervalInSeconds") + OneTwenty: 120, + + int32, +} + +@doc("Type of actions that can be performed.") +union TapRuleActionType { + @doc("TapRuleActionType-Drop") + Drop: "Drop", + + @doc("TapRuleActionType-Count") + Count: "Count", + + @doc("TapRuleActionType-Log") + Log: "Log", + + @doc("TapRuleActionType-Replicate") + Replicate: "Replicate", + + @doc("TapRuleActionType-Goto") + Goto: "Goto", + + @doc("TapRuleActionType-Redirect") + Redirect: "Redirect", + + @doc("TapRuleActionType-Mirror") + Mirror: "Mirror", + + string, +} + +@doc("Encapsulation Type that needs to be matched.") +union EncapsulationType { + @doc("None EncapsulationType") + None: "None", + + @doc("GTPv1 EncapsulationType") + GTPv1: "GTPv1", + + string, +} + +@doc("Global network tap rule actions properties") +@added(Versions.v2024_06_15_preview) +model GlobalNetworkTapRuleActionProperties { + @doc("Configuration to enable network tap rule counter.") + enableCount?: BooleanEnumProperty = BooleanEnumProperty.False; + + @doc("Truncate. 0 indicates do not truncate.") + @minLength(1) + truncate?: string; +} + +@doc("Global network tap rule actions patch properties") +@added(Versions.v2024_06_15_preview) +model GlobalNetworkTapRuleActionPatchProperties { + @doc("Configuration to enable network tap rule counter.") + enableCount?: BooleanEnumProperty; + + @doc("Truncate. 0 indicates do not truncate.") + @minLength(1) + truncate?: string; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkToNetworkInterconnect.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkToNetworkInterconnect.tsp new file mode 100644 index 000000000000..f8923ad76a49 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/NetworkToNetworkInterconnect.tsp @@ -0,0 +1,469 @@ +import "./common.tsp"; + +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; +using Azure.ResourceManager; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("Configuration used to setup CE-PE connectivity.") +model NetworkToNetworkInterconnectProperties { + @doc("Type of NNI used. Example: CE | NPB") + nniType?: NniType = NniType.CE; + + @doc("Configuration to use NNI for Infrastructure Management. Example: True/False.") + isManagementType?: IsManagementType = IsManagementType.True; + + @doc("Based on this option layer3 parameters are mandatory. Example: True/False") + useOptionB: BooleanEnumProperty; + + @doc("Common properties for Layer2 Configuration.") + layer2Configuration?: Layer2Configuration; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Common properties for Layer3Configuration.") + optionBLayer3Configuration?: OptionBLayer3Configuration; + + @doc("NPB Static Route Configuration properties.") + npbStaticRouteConfiguration?: NpbStaticRouteConfiguration; + + @added(Versions.v2024_06_15_preview) + @doc("Static Route Configuration.") + staticRouteConfiguration?: NniStaticRouteConfiguration; + + @doc("Import Route Policy information.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importRoutePolicy") + importRoutePolicyDeprecated?: ImportRoutePolicyInformation; + + @doc("Import Route Policy information.") + @added(Versions.v2024_06_15_preview) + importRoutePolicy?: ImportRoutePolicyInformation; + + @doc("Export Route Policy information") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportRoutePolicy") + exportRoutePolicyDeprecated?: ExportRoutePolicyInformation; + + @doc("Export Route Policy information") + @added(Versions.v2024_06_15_preview) + exportRoutePolicy?: ExportRoutePolicyInformation; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "egressAclId") + egressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + egressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "ingressAclId") + ingressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + ingressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state.") + @added(Versions.v2024_06_15_preview) + microBfdState?: MicroBfdState; + + @doc("Conditional Default Route Configuration properties.") + @added(Versions.v2024_06_15_preview) + conditionalDefaultRouteConfiguration?: ConditionalDefaultRouteProperties; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("Common properties for Layer2 Configuration.") +model Layer2Configuration { + @doc("MTU of the packets between PE & CE.") + @maxValue(9200) + @minValue(64) + mtu?: int32 = 1500; + + @doc("List of network device interfaces resource IDs.") + @minItems(1) + interfaces?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces"; + } + ]>[]; +} + +@doc("Common properties for Layer2 Configuration.") +model Layer2ConfigurationPatch { + @doc("MTU of the packets between PE & CE.") + @maxValue(9200) + @minValue(64) + mtu?: int32; + + @doc("List of network device interfaces resource IDs.") + @minItems(1) + interfaces?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces"; + } + ]>[]; +} + +@doc("The Network To Network Interconnect resource patch definition.") +model NetworkToNetworkInterconnectPatch { + ...ProxyResourceBase; + + @doc("Resource properties.") + properties?: NetworkToNetworkInterconnectPatchProperties; +} + +@doc("Network Tap Rule Patch properties.") +model NetworkToNetworkInterconnectPatchProperties { + @doc("Common properties for Layer2Configuration.") + layer2Configuration?: Layer2ConfigurationPatch; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("Common properties for Layer3Configuration.") + optionBLayer3Configuration?: OptionBLayer3ConfigurationPatchProperties; + + @doc("NPB Static Route Configuration properties.") + npbStaticRouteConfiguration?: NpbStaticRouteConfigurationPatch; + + @added(Versions.v2024_06_15_preview) + @doc("Static Route Configuration.") + staticRouteConfiguration?: NniStaticRoutePatchConfiguration; + + @doc("Import Route Policy information.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importRoutePolicy") + importRoutePolicyDeprecated?: ImportRoutePolicyInformationPatch; + + @doc("Import Route Policy information.") + @added(Versions.v2024_06_15_preview) + importRoutePolicy?: ImportRoutePolicyInformationPatch; + + @doc("Export Route Policy information") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportRoutePolicy") + exportRoutePolicyDeprecated?: ExportRoutePolicyInformationPatch; + + @doc("Export Route Policy information") + @added(Versions.v2024_06_15_preview) + exportRoutePolicy?: ExportRoutePolicyInformationPatch; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "egressAclId") + egressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Egress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + egressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "ingressAclId") + ingressAclIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Ingress Acl. ARM resource ID of Access Control Lists.") + @added(Versions.v2024_06_15_preview) + ingressAclId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/accessControlLists"; + } + ]>; + + @doc("Micro BFD enabled/disabled state.") + @added(Versions.v2024_06_15_preview) + microBfdState?: MicroBfdState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Common properties for Layer3Configuration.") +@withOptionalProperties +model OptionBLayer3ConfigurationPatchProperties { + ...Layer3IpPrefixPatchProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of PE devices for CE/PE connectivity.Example : 28") + @maxValue(4294967295) + @minValue(1) + peerASN?: int64; + + @doc("VLAN for CE/PE Layer 3 connectivity.Example : 501") + @maxValue(4094) + @minValue(100) + vlanId?: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of CE devices for CE/PE connectivity.") + @visibility(Lifecycle.Read) + fabricASN?: int64; + + @doc("Provider Edge (PE) Loopback IP Address.") + @added(Versions.v2024_06_15_preview) + peLoopbackIpAddress?: string[]; + + @doc("BGP Monitoring Protocol (BMP) Configuration.") + @added(Versions.v2024_06_15_preview) + bmpConfiguration?: NniBmpPatchProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("OptionB Layer3 prefix limit configuration.") + @added(Versions.v2024_06_15_preview) + @minItems(1) + @Azure.ResourceManager.identifiers(#[]) + prefixLimits?: OptionBLayer3PrefixLimitPatchProperties[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("OptionB Layer3 Configuration properties.") +model OptionBLayer3Configuration { + ...Layer3IpPrefixProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of PE devices for CE/PE connectivity.Example : 28") + @maxValue(4294967295) + @minValue(1) + peerASN: int64; + + @doc("VLAN for CE/PE Layer 3 connectivity.Example : 501") + @maxValue(4094) + @minValue(100) + vlanId: int32; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("ASN of CE devices for CE/PE connectivity.") + @visibility(Lifecycle.Read) + fabricASN?: int64; + + @doc("Provider Edge (PE) Loopback IP Address.") + @added(Versions.v2024_06_15_preview) + peLoopbackIpAddress?: string[]; + + @doc("BGP Monitoring Protocol (BMP) Configuration.") + @added(Versions.v2024_06_15_preview) + bmpConfiguration?: NniBmpProperties; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." + @doc("OptionB Layer3 prefix limit configuration.") + @added(Versions.v2024_06_15_preview) + @minItems(1) + @Azure.ResourceManager.identifiers(#[]) + prefixLimits?: OptionBLayer3PrefixLimitProperties[]; +} + +@doc("NPB Static Route Configuration properties.") +model NpbStaticRouteConfiguration { + @doc("BFD Configuration properties.") + bfdConfiguration?: BfdConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + ipv4Routes?: StaticRouteProperties[]; + + @doc("List of IPv6 Routes.") + @minItems(1) + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRouteProperties[]; +} + +@doc("NPB Static Route Configuration properties.") +model NpbStaticRouteConfigurationPatch { + @doc("BFD Configuration properties.") + bfdConfiguration?: BfdPatchConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + @minItems(1) + ipv4Routes?: StaticRoutePatchProperties[]; + + @doc("List of IPv6 Routes.") + @minItems(1) + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRoutePatchProperties[]; +} + +@doc("Type of NNI used. Example: CE | NPB") +union NniType { + @doc("NniType-CE(Customer Edge).") + CE: "CE", + + @doc("NniType-NPB(Network Packet Broker).") + NPB: "NPB", + + string, +} + +@doc("Configuration to use NNI for Infrastructure Management. Example: True/False.") +union IsManagementType { + @doc("IsManagementType-True") + True: "True", + + @doc("IsManagementType-False") + False: "False", + + string, +} + +@doc("NNI Bidirectional Forwarding Detection (BFD) Administrative State request.") +@added(Versions.v2024_06_15_preview) +model NniBfdAdministrativeStateRequest { + @doc("Route Type. Choose either Static or OptionA.") + routeType?: RouteType; + + @doc("State. Select either enable or disable.") + administrativeState?: BfdAdministrativeState; +} + +@doc("NNI Bidirectional Forwarding Detection (BFD) Administrative State response.") +@added(Versions.v2024_06_15_preview) +model NniBfdAdministrativeStateResponse { + @doc("Route Type. Choose either Static or OptionA.") + routeType?: RouteType; + + @doc("State. Select either enable or disable.") + administrativeState?: BfdAdministrativeState; + + ...ErrorResponse; +} + +@added(Versions.v2024_06_15_preview) +@doc("Route type to be used.") +union RouteType { + @doc("RouteType-Static") + Static: "Static", + + @doc("RouteType-OptionA") + OptionA: "OptionA", + + string, +} + +@doc("Static Route Configuration properties for NNI.") +@added(Versions.v2024_06_15_preview) +model NniStaticRouteConfiguration { + @doc("BFD configuration properties") + bfdConfiguration?: BfdConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRouteProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRouteProperties[]; +} + +@doc("Static Route Configuration properties for NNI.") +@added(Versions.v2024_06_15_preview) +model NniStaticRoutePatchConfiguration { + @doc("Bidirectional Forwarding Detection (BFD) configuration properties") + bfdConfiguration?: BfdPatchConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRoutePatchProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRoutePatchProperties[]; +} + +@doc("Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state.") +@added(Versions.v2024_06_15_preview) +union MicroBfdState { + @doc("MicroBfdState-Enabled") + Enabled: "Enabled", + + @doc("MicroBfdState-Disabled") + Disabled: "Disabled", + + string, +} + +@doc("Conditional Default Route Configuration properties.") +@added(Versions.v2024_06_15_preview) +model ConditionalDefaultRouteProperties { + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRouteProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRouteProperties[]; +} + +@doc("BGP Monitoring Protocol (BMP) properties.") +@added(Versions.v2024_06_15_preview) +model NniBmpProperties { + @doc("BGP Monitoring Protocol (BMP) Configuration State.") + configurationState: BmpConfigurationState = BmpConfigurationState.Disabled; +} + +@doc("BGP Monitoring Protocol (BMP) patch properties.") +@added(Versions.v2024_06_15_preview) +model NniBmpPatchProperties { + @doc("(BGP Monitoring Protocol (BMP) configuration state.") + configurationState?: BmpConfigurationState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("OptionB Layer3 prefix limit properties.") +@added(Versions.v2024_06_15_preview) +model OptionBLayer3PrefixLimitProperties { + @doc("Maximum number of routes allowed.") + @added(Versions.v2024_06_15_preview) + maximumRoutes?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("OptionB Layer3 prefix limit patch properties.") +@added(Versions.v2024_06_15_preview) +model OptionBLayer3PrefixLimitPatchProperties + is OptionBLayer3PrefixLimitProperties; diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/RoutePolicy.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/RoutePolicy.tsp new file mode 100644 index 000000000000..e6541aa1d64b --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/RoutePolicy.tsp @@ -0,0 +1,246 @@ +import "./common.tsp"; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; + +@doc("RoutePolicyProperties defines the resource properties.") +model RoutePolicyProperties { + ...AnnotationResource; + + @doc("Default action that needs to be applied when no condition is matched. Example: Permit | Deny.") + defaultAction?: CommunityActionTypes = CommunityActionTypes.Deny; + + @doc("Route Policy statements.") + @Azure.ResourceManager.identifiers(#["sequenceNumber"]) + statements: RoutePolicyStatementProperties[]; + + @doc("Arm Resource ID of Network Fabric.") + networkFabricId: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkFabrics"; + } + ]>; + + @doc("AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.") + addressFamilyType?: AddressFamilyType = AddressFamilyType.IPv4; + + @doc("Details of the last operation performed on the resource") + @visibility(Lifecycle.Read) + @added(Versions.v2024_06_15_preview) + lastOperation?: LastOperationProperties; + + @doc("Configuration state of the resource.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Provisioning state of the resource.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + @doc("Administrative state of the resource.") + @visibility(Lifecycle.Read) + administrativeState?: AdministrativeState; +} + +@doc("Route Policy patchable properties.") +@withoutDefaultValues +model RoutePolicyPatchableProperties { + @doc("Default action that needs to be applied when no condition is matched. Example: Permit | Deny.") + defaultAction?: CommunityActionTypes; + + @doc("Route Policy statements.") + @Azure.ResourceManager.identifiers(#[]) + statements?: RoutePolicyStatementPatchProperties[]; +} + +@doc("Route Policy Statement properties.") +model RoutePolicyStatementProperties { + ...AnnotationResource; + + @doc("Sequence to insert to/delete from existing route.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber: int64; + + @doc("Route policy condition properties.") + condition: StatementConditionProperties; + + @doc("Route policy action properties.") + action: StatementActionProperties; +} + +@doc("Route Policy Statement properties.") +model RoutePolicyStatementPatchProperties { + ...AnnotationResource; + + @doc("Sequence to insert to/delete from existing route.") + @maxValue(4294967295) + @minValue(1) + sequenceNumber: int64; + + @doc("Route policy condition properties.") + condition: StatementConditionPatchProperties; + + @doc("Route policy action properties.") + action: StatementActionPatchProperties; +} + +@doc("Route policy statement condition properties.") +model StatementConditionProperties { + @doc("List of IP Community resource IDs.") + ipCommunityIds?: string[]; + + @doc("List of IP Extended Community resource IDs.") + ipExtendedCommunityIds?: string[]; + + @doc("Type of the condition used.") + type?: RoutePolicyConditionType = RoutePolicyConditionType.Or; + + @doc("Arm Resource Id of IpPrefix.") + ipPrefixId?: string; +} + +@doc("Route policy statement condition properties.") +model StatementConditionPatchProperties { + @doc("List of IP Community resource IDs.") + ipCommunityIds?: string[]; + + @doc("List of IP Extended Community resource IDs.") + ipExtendedCommunityIds?: string[]; + + @doc("Type of the condition used.") + type?: RoutePolicyConditionType; + + @doc("Arm Resource Id of IpPrefix.") + ipPrefixId?: string; +} + +@doc("IP Community ID list properties.") +model IpCommunityIdList { + @doc("List of IP Community resource IDs.") + ipCommunityIds?: string[]; +} + +@doc("IP Extended Community Id list properties.") +model IpExtendedCommunityIdList { + @doc("List of IP Extended Community resource IDs.") + ipExtendedCommunityIds?: string[]; +} + +@doc("Route policy action properties.") +model StatementActionProperties { + @doc("Local Preference of the route policy.") + @maxValue(4294967295) + @minValue(0) + localPreference?: int64; + + @doc("Action type. Example: Permit | Deny | Continue.") + actionType: RoutePolicyActionType; + + @doc("IP Community Properties.") + ipCommunityProperties?: ActionIpCommunityProperties; + + @doc("IP Extended Community Properties.") + ipExtendedCommunityProperties?: ActionIpExtendedCommunityProperties; +} + +@doc("Route policy action properties") +model StatementActionPatchProperties { + @doc("Local Preference of the route policy.") + @maxValue(4294967295) + @minValue(0) + localPreference?: int64; + + @doc("Action type. Example: Permit | Deny | Continue.") + actionType: RoutePolicyActionType; + + @doc("IP Community Properties.") + ipCommunityProperties?: ActionIpCommunityPatchProperties; + + @doc("IP Extended Community Properties.") + ipExtendedCommunityProperties?: ActionIpExtendedCommunityPatchProperties; +} + +@doc("IP Community Properties.") +model ActionIpCommunityProperties { + @doc("List of IP Community IDs.") + add?: IpCommunityIdList; + + @doc("List of IP Community IDs.") + delete?: IpCommunityIdList; + + @doc("List of IP Community IDs.") + set?: IpCommunityIdList; +} + +@doc("IP Community Properties.") +model ActionIpCommunityPatchProperties is ActionIpCommunityProperties; + +@doc("IP Extended Community Properties.") +model ActionIpExtendedCommunityProperties { + @doc("List of IP Extended Community IDs.") + add?: IpExtendedCommunityIdList; + + @doc("List of IP Extended Community IDs.") + delete?: IpExtendedCommunityIdList; + + @doc("List of IP Extended Community IDs.") + set?: IpExtendedCommunityIdList; +} + +@doc("IP Extended Community Properties.") +model ActionIpExtendedCommunityPatchProperties + is ActionIpExtendedCommunityProperties; + +@doc("The Route Policy patch resource definition.") +model RoutePolicyPatch { + ...TagsUpdate; + + @doc("The RoutePolicy patchable properties.") + properties?: RoutePolicyPatchableProperties; +} + +@doc("The extended location.") +model ExtendedLocation { + @doc("The extended location type.") + type?: string; + + @doc("The extended location name.") + name?: string; +} + +@doc("Type of the condition used.") +union RoutePolicyConditionType { + @doc("RoutePolicyConditionType-Or") + Or: "Or", + + @doc("RoutePolicyConditionType-And") + And: "And", + + string, +} + +@doc("Action type. Example: Permit | Deny | Continue.") +union RoutePolicyActionType { + @doc("RoutePolicyActionType-Permit") + Permit: "Permit", + + @doc("RoutePolicyActionType-Deny") + Deny: "Deny", + + @doc("RoutePolicyActionType-Continue") + Continue: "Continue", + + string, +} + +@doc("Polling type.") +union PollingType { + @doc("PollingType-Pull") + Pull: "Pull", + + @doc("PollingType-Push") + Push: "Push", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/common.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/common.tsp new file mode 100644 index 000000000000..9811d476202a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/common.tsp @@ -0,0 +1,1072 @@ +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("Configuration state for the resource.") +union ConfigurationState { + @doc("Success Configuration State") + Succeeded: "Succeeded", + + @doc("Failed Configuration State") + Failed: "Failed", + + @doc("Rejected Configuration State") + Rejected: "Rejected", + + @doc("Accepted Configuration State") + Accepted: "Accepted", + + @doc("Provisioned Configuration State") + Provisioned: "Provisioned", + + @doc("ErrorProvisioning Configuration State") + ErrorProvisioning: "ErrorProvisioning", + + @doc("Deprovisioning Configuration State") + Deprovisioning: "Deprovisioning", + + @doc("Deprovisioned Configuration State") + Deprovisioned: "Deprovisioned", + + @doc("ErrorDeprovisioning Configuration State") + ErrorDeprovisioning: "ErrorDeprovisioning", + + @doc("DeferredControl Configuration State") + DeferredControl: "DeferredControl", + + @doc("Provisioning Configuration State") + Provisioning: "Provisioning", + + @doc("PendingCommit Configuration State") + PendingCommit: "PendingCommit", + + string, +} + +@doc("The current provisioning state.") +union ProvisioningState { + @doc("Accepted Provisioning State") + Accepted: "Accepted", + + @doc("Succeeded Provisioning State") + Succeeded: "Succeeded", + + @doc("Updating Provisioning State") + Updating: "Updating", + + @doc("Deleting Provisioning State") + Deleting: "Deleting", + + @doc("Failed Provisioning State") + Failed: "Failed", + + @doc("Canceled Provisioning State") + Canceled: "Canceled", + + string, +} + +@doc("State defined to represent administrative actions or post actions on a particular resource.") +union AdministrativeState { + @doc("Enabled Administrative State") + Enabled: "Enabled", + + @doc("Disabled Administrative State") + Disabled: "Disabled", + + @doc("MAT(Manual Action Taken) Administrative State") + MAT: "MAT", + + @doc("RMA(Return Material Authorization) Administrative State") + RMA: "RMA", + + @doc("UnderMaintenance Administrative State") + UnderMaintenance: "UnderMaintenance", + + string, +} + +@doc("Input method to configure Access Control List.") +union ConfigurationType { + @doc("File Configuration Type") + File: "File", + + @doc("Inline Configuration Type") + Inline: "Inline", + + string, +} + +@doc("Community action types. Example: Permit | Deny.") +union CommunityActionTypes { + @doc("Permit Community Action Types") + Permit: "Permit", + + @doc("Deny Community Action Types") + Deny: "Deny", + + string, +} + +@doc("IP Address type.") +union IPAddressType { + @doc("IPv4 IP address") + IPv4: "IPv4", + + @doc("IPv6 IP address") + IPv6: "IPv6", + + string, +} + +@doc("Port type that needs to be matched.") +union PortType { + @doc("PortType SourcePort") + SourcePort: "SourcePort", + + @doc("PortType DestinationPort") + DestinationPort: "DestinationPort", + + @added(Versions.v2024_06_15_preview) + @doc("PortType Bidirectional") + Bidirectional: "Bidirectional", + + string, +} + +@doc("Layer4 protocol type that needs to be matched.") +union Layer4Protocol { + @doc("TCP(Transmission Control Protocol) Protocol") + TCP: "TCP", + + @doc("UDP(User Datagram Protocol) Protocol") + UDP: "UDP", + + @doc("SCTP(Streaming Control Transmission Protocol) Protocol") + @added(Versions.v2024_06_15_preview) + SCTP: "SCTP", + + string, +} + +@doc("IP Address type that needs to be matched.") +union SourceDestinationType { + @doc("SourceDestinationType SourceIP") + SourceIP: "SourceIP", + + @doc("SourceDestinationType DestinationIP") + DestinationIP: "DestinationIP", + + @added(Versions.v2024_06_15_preview) + @doc("SourceDestinationType Bidirectional") + Bidirectional: "Bidirectional", + + string, +} + +@doc("IP Prefix Type that needs to be matched.") +union PrefixType { + @doc("PrefixType Prefix") + Prefix: "Prefix", + + @doc("PrefixType LongestPrefix") + LongestPrefix: "LongestPrefix", + + string, +} + +@doc("Administrative state.") +union EnableDisableState { + @doc("AdministrativeState Enable") + Enable: "Enable", + + @doc("AdministrativeState Disable") + Disable: "Disable", + + @doc("AdministrativeState UnderMaintenance") + UnderMaintenance: "UnderMaintenance", + + string, +} + +@doc("Administrative state of the BfdConfiguration. Example: Enabled | Disabled.") +union BfdAdministrativeState { + @doc("Represents the enabled state of BFD administrative state.") + Enabled: "Enabled", + + @doc("Represents the disabled state of BFD administrative state.") + Disabled: "Disabled", + + @doc("Represents the MAT(Manual Action Taken) state of BFD administrative state.") + MAT: "MAT", + + @doc("Represents the RMA(Return Material Authorization) state of BFD administrative state.") + RMA: "RMA", + + string, +} + +@doc("Boolean union. Example- True/False") +union BooleanEnumProperty { + @doc("EnumProperty-True") + True: "True", + + @doc("EnumProperty-False") + False: "False", + + string, +} + +@doc("Peering option list.") +union PeeringOption { + @doc("PeeringOption-OptionA") + OptionA: "OptionA", + + @doc("PeeringOption-OptionB") + OptionB: "OptionB", + + string, +} + +@doc("AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.") +union AddressFamilyType { + @doc("AddressType-IPv4") + IPv4: "IPv4", + + @doc("AddressType-IPv6") + IPv6: "IPv6", + + string, +} + +@doc("Switch configuration entries require a description to discern between configuration group") +model AnnotationResource { + @doc("Switch configuration description.") + annotation?: string; +} + +@doc("Details of the last operations performed on the resource") +@added(Versions.v2024_06_15_preview) +model LastOperationProperties { + @doc("Details status of the last operation performed on the resource.") + @visibility(Lifecycle.Read) + details?: string; +} + +@doc("Port condition that needs to be matched.") +model PortCondition { + @doc("Port type that needs to be matched.") + portType?: PortType; + + @doc("Layer4 protocol type that needs to be matched.") + layer4Protocol: Layer4Protocol; + + @doc("List of the Ports that need to be matched.") + ports?: string[]; + + @doc("List of the port Group Names that need to be matched.") + portGroupNames?: string[]; +} + +@doc("Port condition that needs to be matched.") +model PortConditionPatch { + @doc("Port type that needs to be matched.") + portType?: PortType; + + @doc("Layer4 protocol type that needs to be matched.") + layer4Protocol?: Layer4Protocol; + + @doc("List of the Ports that need to be matched.") + ports?: string[]; + + @doc("List of the port Group Names that need to be matched.") + portGroupNames?: string[]; +} + +@doc("Defines the common match conditions of the ACL and Network Tap Rule.") +model CommonMatchConditions { + @doc("List of the protocols that need to be matched.") + @minItems(1) + protocolTypes?: string[]; + + @doc("Vlan match condition that needs to be matched.") + vlanMatchCondition?: VlanMatchCondition; + + @doc("IP condition that needs to be matched.") + ipCondition?: IpMatchCondition; +} + +@doc("Defines the common match conditions of the ACL and Network Tap Rule.") +model CommonMatchConditionsPatch { + @doc("List of the protocols that need to be matched.") + @minItems(1) + protocolTypes?: string[]; + + @doc("Vlan match condition that needs to be matched.") + vlanMatchCondition?: VlanMatchConditionPatch; + + @doc("IP condition that needs to be matched.") + ipCondition?: IpMatchConditionPatch; +} + +@doc("The vlan match conditions that need to be matched.") +model VlanMatchCondition { + @doc("List of vlans that need to be matched. Inputs can be single vlan or the range of vlans.") + @minItems(1) + vlans?: string[]; + + @doc("List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans.") + @minItems(1) + innerVlans?: string[]; + + @doc("List of vlan group names that need to be matched.") + @minItems(1) + vlanGroupNames?: string[]; +} + +@doc("The vlan match conditions that need to be matched.") +model VlanMatchConditionPatch is VlanMatchCondition; + +@doc("Defines the condition that can be filtered using the selected IPs.") +model IpMatchCondition { + @doc("IP Address type that needs to be matched.") + type?: SourceDestinationType; + + @doc("IP Prefix Type that needs to be matched.") + prefixType?: PrefixType; + + @doc("The list of IP Prefixes that need to be matched.") + @minItems(1) + ipPrefixValues?: string[]; + + @doc("The List of IP Group Names that need to be matched.") + @minItems(1) + ipGroupNames?: string[]; +} + +@doc("Defines the condition that can be filtered using the selected IPs.") +model IpMatchConditionPatch is IpMatchCondition; + +@doc("Dynamic match configuration object.") +model CommonDynamicMatchConfiguration { + @Azure.ResourceManager.identifiers(#[]) + @doc("List of IP Groups.") + ipGroups?: IpGroupProperties[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of vlan groups.") + vlanGroups?: VlanGroupProperties[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of the port groups.") + portGroups?: PortGroupProperties[]; +} + +@doc("Dynamic match configuration object.") +model CommonDynamicMatchConfigurationPatch { + @Azure.ResourceManager.identifiers(#[]) + @doc("List of IP Groups.") + ipGroups?: IpGroupPatchProperties[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of vlan groups.") + vlanGroups?: VlanGroupPatchProperties[]; + + @Azure.ResourceManager.identifiers(#[]) + @doc("List of the port groups.") + portGroups?: PortGroupPatchProperties[]; +} + +@doc("IP Group properties.") +model IpGroupProperties { + @doc("IP Group name.") + @minLength(1) + name?: string; + + @doc("IP Address type.") + ipAddressType?: IPAddressType; + + @doc("List of IP Prefixes.") + ipPrefixes?: string[]; +} + +@doc("IP Group properties.") +model IpGroupPatchProperties is IpGroupProperties; + +@doc("Vlan group properties.") +model VlanGroupProperties { + @doc("Vlan group name.") + @minLength(1) + name?: string; + + @doc("List of vlans.") + vlans?: string[]; +} + +@doc("Vlan group properties.") +model VlanGroupPatchProperties is VlanGroupProperties; + +@doc("Port Group properties.") +model PortGroupProperties { + @doc("The name of the port group.") + @minLength(1) + name?: string; + + @doc("List of the ports that need to be matched.") + ports?: string[]; +} + +@doc("Port Group Properties") +model PortGroupPatchProperties is PortGroupProperties; + +@doc("Common fields that are returned in the response for all Azure Resource Manager resources") +model Resource { + @doc("Fully qualified resource ID for the resource. E.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'") + @visibility(Lifecycle.Read) + id?: Azure.Core.armResourceIdentifier; + + @doc("The name of the resource") + @visibility(Lifecycle.Read) + name?: string; + + @doc("The type of the resource. E.g. 'Microsoft.Compute/virtualMachines' or 'Microsoft.Storage/storageAccounts'") + @visibility(Lifecycle.Read) + type?: string; + + @doc("Azure Resource Manager metadata containing createdBy and modifiedBy information.") + @visibility(Lifecycle.Read) + systemData?: SystemData; +} + +@doc("Update administrative state on list of resources.") +model UpdateAdministrativeState { + ...EnableDisableOnResources; + + @doc("Administrative state.") + state?: EnableDisableState; +} + +@doc("Update administrative state on list of resources.") +model EnableDisableOnResources { + @doc("Network Fabrics or Network Rack resource Id.") + resourceIds?: string[]; +} + +@doc("Common response for the state updates.") +model CommonPostActionResponseForStateUpdate { + ...ErrorResponse; + + @doc("Gets the configuration state.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; +} + +@doc("The response of the action validate configuration.") +model ValidateConfigurationResponse { + ...ErrorResponse; + + @doc("Gets the configuration state.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("URL for the details of the response.") + url?: string; +} + +@doc("Common response for device updates.") +model CommonPostActionResponseForDeviceUpdate { + ...ErrorResponse; + + @doc("Gets the configuration state.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("List of ARM Resource IDs for which the given action applied successfully.") + successfulDevices?: string[]; + + @doc("List of ARM Resource IDs for which the given action failed to apply.") + failedDevices?: string[]; +} + +@doc("Update version properties.") +model UpdateVersion { + @doc("Specify the version.") + version?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Provide the RO command") +model DeviceRoCommand { + @doc("Specify the command.") + command?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("The current status of an async operation.") +model CommonPostActionResponseForDeviceROCommandsOperationStatusResult { + ...ErrorResponse; + + @doc("The end time of the operation.") + @visibility(Lifecycle.Read) + endTime?: utcDateTime; + + @doc("Fully qualified ID for the async operation.") + @visibility(Lifecycle.Read) + id?: string; + + @doc("Name of the async operation.") + @visibility(Lifecycle.Read) + name?: string; + + @doc("The additional properties of the operation status result.") + properties?: CommonPostActionResponseForDeviceROCommands; + + @doc("Fully qualified ID of the resource against which the original async operation was started.") + @visibility(Lifecycle.Read) + resourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/networkDevices"; + } + ]>; + + @doc("The start time of the operation.") + @visibility(Lifecycle.Read) + startTime?: utcDateTime; + + @doc("Operation status.") + status: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Common response for device Ro Commands.") +@removed(Versions.v2024_06_15_preview) +@renamedFrom( + Versions.v2024_06_15_preview, + "CommonPostActionResponseForDeviceROCommands" +) +model CommonPostActionResponseForDeviceROCommandsDeprecated { + ...ErrorResponse; + + @doc("Gets the configuration state.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Predefined link containing Device RO Command output.") + outputUrl?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Common response for device Ro Commands.") +model CommonPostActionResponseForDeviceROCommands { + @doc("Gets the configuration state.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Predefined link containing Device RO Command output.") + outputUrl?: string; + + @doc("Device RO command Response limited to 4000 characters.") + deviceConfigurationPreview?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Provide the Rw command") +model DeviceRwCommand { + @doc("Specify the command.") + command?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "This is a valid resource name." +@doc("Common response for device Rw Commands.") +model CommonPostActionResponseForDeviceRWCommands { + ...ErrorResponse; + + @doc("Gets the configuration state.") + @visibility(Lifecycle.Read) + configurationState?: ConfigurationState; + + @doc("Predefined link containing Device Rw Command output.") + outputUrl?: string; +} + +@doc("Import Route Policy Configuration.") +model ImportRoutePolicyInformation { + @doc("Import IPv4 Route Policy Id.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importIpv4RoutePolicyId") + importIpv4RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import IPv4 Route Policy Id.") + @added(Versions.v2024_06_15_preview) + importIpv4RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import IPv6 Route Policy Id.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importIpv6RoutePolicyId") + importIpv6RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Import IPv6 Route Policy Id.") + @added(Versions.v2024_06_15_preview) + importIpv6RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; +} + +@doc("Import Route Policy Configuration.") +model ImportRoutePolicyInformationPatch is ImportRoutePolicyInformation; + +@doc("Export Route Policy Configuration.") +model ExportRoutePolicyInformation { + @doc("Export IPv4 Route Policy Id.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportIpv4RoutePolicyId") + exportIpv4RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Export IPv4 Route Policy Id.") + @added(Versions.v2024_06_15_preview) + exportIpv4RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Export IPv6 Route Policy Id.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportIpv6RoutePolicyId") + exportIpv6RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("Export IPv6 Route Policy Id.") + @added(Versions.v2024_06_15_preview) + exportIpv6RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; +} + +@doc("Export Route Policy Configuration.") +model ExportRoutePolicyInformationPatch is ExportRoutePolicyInformation; + +@doc("ProxyResourceBase with no property bag") +model ProxyResourceBase { + @doc("Fully qualified resource ID for the resource. E.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'") + @visibility(Lifecycle.Read) + id?: Azure.Core.armResourceIdentifier; + + @doc("The type of the resource. E.g. 'Microsoft.Compute/virtualMachines' or 'Microsoft.Storage/storageAccounts'") + @visibility(Lifecycle.Read) + type?: string; + + @doc("Azure Resource Manager metadata containing createdBy and modifiedBy information.") + @visibility(Lifecycle.Read) + systemData?: SystemData; +} + +@doc("Base tracked resource type for PATCH updates.") +model TagsUpdate { + ...ArmTagsProperty; +} + +@doc("Layer 3 primary and secondary IP Address prefixes.") +model Layer3IpPrefixPatchProperties is Layer3IpPrefixProperties; + +@doc("Layer 3 primary and secondary IP Address prefixes.") +model Layer3IpPrefixProperties { + @doc("IPv4 Address Prefix.") + primaryIpv4Prefix?: string; + + @doc("IPv6 Address Prefix.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "primaryIpv6Prefix") + primaryIpv6PrefixPreview?: string; + + @doc("IPv6 Address Prefix.") + @added(Versions.v2024_06_15_preview) + primaryIpv6Prefix?: string; + + @doc("Secondary IPv4 Address Prefix.") + secondaryIpv4Prefix?: string; + + @doc("Secondary IPv6 Address Prefix.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "secondaryIpv6Prefix") + secondaryIpv6PrefixPreview?: string; + + @doc("Secondary IPv6 Address Prefix.") + @added(Versions.v2024_06_15_preview) + secondaryIpv6Prefix?: string; +} + +@doc("BFD configuration properties") +model BfdConfiguration { + @doc("Administrative state of the BfdConfiguration. Example: Enabled | Disabled.") + @visibility(Lifecycle.Read) + administrativeState?: BfdAdministrativeState = BfdAdministrativeState.Disabled; + + @doc("Interval in milliseconds. Example: 300.") + intervalInMilliSeconds?: int32 = 300; + + @doc("Multiplier for the Bfd Configuration. Example: 5.") + multiplier?: int32 = 5; +} + +@doc("BFD configuration properties") +model BfdPatchConfiguration { + @doc("Administrative state of the BfdConfiguration. Example: Enabled | Disabled.") + @visibility(Lifecycle.Read) + administrativeState?: BfdAdministrativeState; + + @doc("Interval in milliseconds. Example: 300.") + intervalInMilliSeconds?: int32; + + @doc("Multiplier for the Bfd Configuration. Example: 5.") + multiplier?: int32; +} + +@doc("Route Properties.") +model StaticRouteProperties { + @doc("Prefix of the route.") + @minLength(1) + prefix: string; + + @doc("List of next hop addresses.") + @minItems(1) + nextHop: string[]; +} + +@doc("Route Properties.") +model StaticRoutePatchProperties is StaticRouteProperties; + +@doc("Route Target Configuration.") +model RouteTargetInformation { + @doc("Route Targets to be applied for incoming routes into CE.") + importIpv4RouteTargets?: string[]; + + @doc("Route Targets to be applied for incoming routes from CE.") + importIpv6RouteTargets?: string[]; + + @doc("Route Targets to be applied for outgoing routes into CE.") + exportIpv4RouteTargets?: string[]; + + @doc("Route Targets to be applied for outgoing routes from CE.") + exportIpv6RouteTargets?: string[]; +} + +@doc("Route Target Configuration.") +model RouteTargetPatchInformation is RouteTargetInformation; + +@doc("Import Route Policy either IPv4 or IPv6.") +model ImportRoutePolicy { + @doc("ARM resource ID of RoutePolicy.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importIpv4RoutePolicyId") + importIpv4RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM resource ID of RoutePolicy.") + @added(Versions.v2024_06_15_preview) + importIpv4RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM resource ID of RoutePolicy.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "importIpv6RoutePolicyId") + importIpv6RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM resource ID of RoutePolicy.") + @added(Versions.v2024_06_15_preview) + importIpv6RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; +} + +@doc("Import Route Policy either IPv4 or IPv6.") +model ImportRoutePolicyPatch is ImportRoutePolicy; + +@doc("Export Route Policy either IPv4 or IPv6.") +model ExportRoutePolicy { + @doc("ARM resource ID of RoutePolicy.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportIpv4RoutePolicyId") + exportIpv4RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM resource ID of RoutePolicy.") + @added(Versions.v2024_06_15_preview) + exportIpv4RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM resource ID of RoutePolicy.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "exportIpv6RoutePolicyId") + exportIpv6RoutePolicyIdDeprecated?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; + + @doc("ARM resource ID of RoutePolicy.") + @added(Versions.v2024_06_15_preview) + exportIpv6RoutePolicyId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedNetworkFabric/routePolicies"; + } + ]>; +} + +@doc("Export Route Policy either IPv4 or IPv6.") +model ExportRoutePolicyPatch is ExportRoutePolicy; + +@doc("Static Route Configuration properties.") +model StaticRouteConfiguration { + @doc("BFD configuration properties") + bfdConfiguration?: BfdConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRouteProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRouteProperties[]; + + @doc("Extension. Example: NoExtension | NPB.") + extension?: Extension = Extension.NoExtension; +} + +@doc("Static Route Configuration properties.") +model StaticRoutePatchConfiguration { + @doc("BFD configuration properties") + bfdConfiguration?: BfdPatchConfiguration; + + @doc("List of IPv4 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv4Routes?: StaticRoutePatchProperties[]; + + @doc("List of IPv6 Routes.") + @Azure.ResourceManager.identifiers(#["prefix"]) + ipv6Routes?: StaticRoutePatchProperties[]; +} + +@added(Versions.v2024_06_15_preview) +@doc("The managed service identities assigned to this resource.") +model ManagedServiceIdentityPatch + is OptionalProperties>; + +@added(Versions.v2024_06_15_preview) +@doc("IdentitySelector represents the selection of a managed identity for use.") +model IdentitySelector { + @doc("The type of managed identity that is being selected.") + identityType: ManagedServiceIdentitySelectorType; + + @doc("The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.") + userAssignedIdentityResourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedIdentity/userAssignedIdentities"; + } + ]>; +} + +@added(Versions.v2024_06_15_preview) +@doc("IdentitySelector represents the selection of a managed identity for use.") +model IdentitySelectorPatch { + @doc("The type of managed identity that is being selected.") + identityType?: ManagedServiceIdentitySelectorType; + + @doc("The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.") + userAssignedIdentityResourceId?: Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.ManagedIdentity/userAssignedIdentities"; + } + ]>; +} + +@doc("The type of managed identity.") +@added(Versions.v2024_06_15_preview) +union ManagedServiceIdentitySelectorType { + @doc("System Assigned Identity.") + SystemAssignedIdentity: "SystemAssignedIdentity", + + @doc("User Assigned Identity.") + UserAssignedIdentity: "UserAssignedIdentity", + + string, +} + +@doc("Unique Route Distinguisher Configuration State.") +@added(Versions.v2024_06_15_preview) +union UniqueRouteDistinguisherConfigurationState { + @doc("UniqueRouteDistinguisherConfigurationState Enabled") + Enabled: "Enabled", + + @doc("UniqueRouteDistinguisherConfigurationState Disabled") + Disabled: "Disabled", + + string, +} + +@doc("NNI Derived Unique Route Distinguisher Configuration State.") +@added(Versions.v2024_06_15_preview) +union NNIDerivedUniqueRouteDistinguisherConfigurationState { + @doc("NNI derived unique route distinguisher configuration state Enabled") + Enabled: "Enabled", + + @doc("NNI derived unique route distinguisher configuration state Disabled") + Disabled: "Disabled", + + string, +} + +@doc("BGP Monitoring Protocol (BMP) configuration state.") +@added(Versions.v2024_06_15_preview) +union BmpConfigurationState { + @doc("BGP Monitoring Protocol (BMP) ConfigurationState - Enabled") + Enabled: "Enabled", + + @doc("BGP Monitoring Protocol (BMP) ConfigurationState - Disabled") + Disabled: "Disabled", + + string, +} + +@doc("Border Gateway Protocol (BGP) Administrative State values") +@added(Versions.v2024_06_15_preview) +union BgpAdministrativeState { + @doc("BgpAdministrativeState-Enabled") + Enabled: "Enabled", + + @doc("BgpAdministrativeState-Disabled") + Disabled: "Disabled", + + string, +} + +@doc("External Network native IPv4 prefix limit properties") +@added(Versions.v2024_06_15_preview) +model NativeIpv4PrefixLimitProperties { + @doc("Prefix limits") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + prefixLimits?: PrefixLimitProperties[]; +} + +@doc("External Network native IPv4 prefix limits patch properties") +@added(Versions.v2024_06_15_preview) +model NativeIpv4PrefixLimitPatchProperties { + @doc("Prefix limits") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + prefixLimits?: PrefixLimitPatchProperties[]; +} + +@doc("External Network native IPv6 prefix limit properties") +@added(Versions.v2024_06_15_preview) +model NativeIpv6PrefixLimitProperties { + @doc("Prefix limits") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + prefixLimits?: PrefixLimitProperties[]; +} + +@doc("External Network native IPv6 prefix limits patch properties") +@added(Versions.v2024_06_15_preview) +model NativeIpv6PrefixLimitPatchProperties { + @doc("Prefix limits") + @Azure.ResourceManager.identifiers(#[]) + @minItems(1) + prefixLimits?: PrefixLimitPatchProperties[]; +} + +@doc("Prefix Limit properties.") +@added(Versions.v2024_06_15_preview) +model PrefixLimitProperties { + @doc("Maximum routes allowed.") + maximumRoutes?: int32; + + @doc("Limit at which route prefixes a warning is generate.") + threshold?: int32; + + @doc("Idle Time Expiry in seconds, default is 60.") + idleTimeExpiry?: int32 = 60; +} + +@doc("Prefix Limit Patch properties.") +@added(Versions.v2024_06_15_preview) +model PrefixLimitPatchProperties { + @doc("Maximum routes allowed.") + maximumRoutes?: int32; + + @doc("Limit at which route prefixes a warning is generate.") + threshold?: int32; + + @doc("Idle time expiry in seconds.") + idleTimeExpiry?: int32; +} + +@doc("V4 over V6 BGP session state") +@added(Versions.v2024_06_15_preview) +union V4OverV6BgpSessionState { + @doc("V4OverV6BgpSessionState-Enabled") + Enabled: "Enabled", + + @doc("V4OverV6BgpSessionState-Disabled") + Disabled: "Disabled", + + string, +} + +@doc("V6 over V4 BGP session state") +@added(Versions.v2024_06_15_preview) +union V6OverV4BgpSessionState { + @doc("V6OverV4BgpSessionState-Enabled") + Enabled: "Enabled", + + @doc("V6OverV4BgpSessionState-Disabled") + Disabled: "Disabled", + + string, +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/AccessControlList.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/AccessControlList.tsp new file mode 100644 index 000000000000..ba9397403738 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/AccessControlList.tsp @@ -0,0 +1,76 @@ +import "../models/common.tsp"; +import "../models/AccessControlList.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Access Control List resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model AccessControlList + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Access Control List.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("accessControlListName") + @segment("accessControlLists") + @visibility(Lifecycle.Read) + name: string; + + /** The Access ControlList properties */ + properties: AccessControlListProperties; +} + +@armResourceOperations +interface AccessControlLists { + @doc("Implements Access Control List GET method.") + get is ArmResourceRead; + + @doc("Implements Access Control List PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the Access Control List resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements Access Control List DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements AccessControlLists list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Implements AccessControlLists list by subscription GET method.") + listBySubscription is ArmListBySubscription; + + @doc("Implements the operation to the underlying resources.") + updateAdministrativeState is ArmResourceActionAsync< + AccessControlList, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Implements the operation to the underlying resources.") + resync is ArmResourceActionAsync< + AccessControlList, + void, + CommonPostActionResponseForStateUpdate + >; + + @doc("Implements the operation to the underlying resources.") + validateConfiguration is ArmResourceActionAsync< + AccessControlList, + void, + ValidateConfigurationResponse + >; +} + +@@doc(AccessControlLists.create::parameters.resource, "Request payload."); +@@doc(AccessControlLists.update::parameters.properties, + "Access Control List properties to update." +); +@@doc(AccessControlLists.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/ExternalNetwork.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/ExternalNetwork.tsp new file mode 100644 index 000000000000..47b13d019ec2 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/ExternalNetwork.tsp @@ -0,0 +1,84 @@ +import "../models/common.tsp"; +import "./L3IsolationDomain.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("Defines the External Network resource.") +@parentResource(L3IsolationDomain) +@Http.Private.includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal(ExternalNetworkProperties) +model ExternalNetwork extends Azure.ResourceManager.Foundations.ProxyResource { + @doc("Name of the External Network.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("externalNetworkName") + @segment("externalNetworks") + @visibility(Lifecycle.Read) + name: string; + + /** External Network Properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: ExternalNetworkProperties; +} + +@armResourceOperations +interface ExternalNetworks { + @doc("Implements ExternalNetworks GET method.") + get is ArmResourceRead; + + @doc("Creates ExternalNetwork PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the ExternalNetworks resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements ExternalNetworks DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements External Networks list by resource group GET method.") + listByL3IsolationDomain is ArmResourceListByParent; + + @doc("Executes update operation to enable or disable administrative State for externalNetwork.") + updateAdministrativeState is ArmResourceActionAsync< + ExternalNetwork, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Update Static Route BFD for external Network.") + @removed(Versions.v2024_06_15_preview) + updateStaticRouteBfdAdministrativeState is ArmResourceActionAsync< + ExternalNetwork, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("BFD administrative state for either static or bgp for internalNetwork.") + @added(Versions.v2024_06_15_preview) + updateBfdAdministrativeState is ArmResourceActionAsync< + ExternalNetwork, + ExternalNetworkBfdAdministrativeStateRequest, + ExternalNetworkBfdAdministrativeStateResponse + >; +} + +@@doc(ExternalNetworks.create::parameters.resource, "Request payload."); +@@doc(ExternalNetworks.update::parameters.properties, + "ExternalNetwork properties to update. Only annotations are supported." +); +@@doc(ExternalNetworks.updateAdministrativeState::parameters.body, + "Request payload." +); +@@doc(ExternalNetworks.updateStaticRouteBfdAdministrativeState::parameters.body, + "Request payload." +); +@@doc(ExternalNetworks.updateBfdAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternalNetwork.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternalNetwork.tsp new file mode 100644 index 000000000000..0217d85c9be9 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternalNetwork.tsp @@ -0,0 +1,112 @@ +import "../models/common.tsp"; +import "./L3IsolationDomain.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("Defines the Internal Network resource.") +@parentResource(L3IsolationDomain) +@Http.Private.includeInapplicableMetadataInPayload(false) +@Azure.ResourceManager.Private.armResourceInternal(InternalNetworkProperties) +model InternalNetwork extends Azure.ResourceManager.Foundations.ProxyResource { + @doc("Name of the Internal Network.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("internalNetworkName") + @segment("internalNetworks") + @visibility(Lifecycle.Read) + name: string; + + /** The Internal Network Properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: InternalNetworkProperties; +} + +@armResourceOperations +interface InternalNetworks { + @doc("Gets a InternalNetworks.") + get is ArmResourceRead; + + @doc("Creates InternalNetwork PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Updates a InternalNetworks.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements InternalNetworks DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays InternalNetworks list by resource group GET method.") + listByL3IsolationDomain is ArmResourceListByParent; + + @doc("Update Administrative state of InternalNetworks on resources referred by their resource ids.") + updateAdministrativeState is ArmResourceActionAsync< + InternalNetwork, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Update BGP state for internalNetwork. Allowed only on edge devices.") + @added(Versions.v2024_06_15_preview) + @sharedRoute + @action("updateBgpAdministrativeState") + updateBgpAdministrativeState is ArmResourceActionAsync< + InternalNetwork, + InternalNetworkBgpAdministrativeStateRequest, + InternalNetworkBgpAdministrativeStateResponse + >; + + @doc("Update BGP state for internalNetwork. Allowed only on edge devices.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "updateBgpAdministrativeState") + @sharedRoute + @action("updateBgpAdministrativeState") + updateBgpAdministrativeStateDeprecated is ArmResourceActionAsync< + InternalNetwork, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Update Static Route BFD administrative state for internalNetwork.") + @removed(Versions.v2024_06_15_preview) + updateStaticRouteBfdAdministrativeState is ArmResourceActionAsync< + InternalNetwork, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("BFD administrative state for either static or bgp for internalNetwork.") + @added(Versions.v2024_06_15_preview) + updateBfdAdministrativeState is ArmResourceActionAsync< + InternalNetwork, + InternalNetworkBfdAdministrativeStateRequest, + InternalNetworkBfdAdministrativeStateResponse + >; +} + +@@doc(InternalNetworks.create::parameters.resource, "Request payload."); +@@doc(InternalNetworks.update::parameters.properties, + "InternalNetwork properties to update. Only annotations are supported." +); +@@doc(InternalNetworks.updateAdministrativeState::parameters.body, + "Request payload." +); +@@doc(InternalNetworks.updateBgpAdministrativeStateDeprecated::parameters.body, + "Request payload." +); +@@doc(InternalNetworks.updateBgpAdministrativeState::parameters.body, + "Request payload." +); +@@doc(InternalNetworks.updateStaticRouteBfdAdministrativeState::parameters.body, + "Request payload." +); +@@doc(InternalNetworks.updateBfdAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternetGateway.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternetGateway.tsp new file mode 100644 index 000000000000..5f9cf8da8d93 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternetGateway.tsp @@ -0,0 +1,53 @@ +import "../models/common.tsp"; +import "../models/InternetGateway.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Internet Gateway resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model InternetGateway + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Internet Gateway.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("internetGatewayName") + @segment("internetGateways") + @visibility(Lifecycle.Read) + name: string; + + /** The Internet Gateway Properties */ + properties: InternetGatewayProperties; +} + +@armResourceOperations +interface InternetGateways { + @doc("Implements Gateway GET method.") + get is ArmResourceRead; + + @doc("Creates a Network Fabric Service Internet Gateway resource instance.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Execute patch on Network Fabric Service Internet Gateway.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Execute a delete on Network Fabric Service Internet Gateway.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays Internet Gateways list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays Internet Gateways list by subscription GET method.") + listBySubscription is ArmListBySubscription; +} + +@@doc(InternetGateways.create::parameters.resource, "Request payload."); +@@doc(InternetGateways.update::parameters.properties, + "API to update certain properties of the InternetGateway resource.." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternetGatewayRule.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternetGatewayRule.tsp new file mode 100644 index 000000000000..b8db05fdeebe --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/InternetGatewayRule.tsp @@ -0,0 +1,53 @@ +import "../models/common.tsp"; +import "../models/InternetGatewayRule.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Internet Gateway Rule resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model InternetGatewayRule + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Internet Gateway rule.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("internetGatewayRuleName") + @segment("internetGatewayRules") + @visibility(Lifecycle.Read) + name: string; + + /** The Internet Gateway Rule properties */ + properties: InternetGatewayRuleProperties; +} + +@armResourceOperations +interface InternetGatewayRules { + @doc("Gets an Internet Gateway Rule resource.") + get is ArmResourceRead; + + @doc("Creates an Internet Gateway rule resource.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the Internet Gateway Rule resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements Internet Gateway Rules DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements Internet Gateway Rules list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("List all Internet Gateway rules in the given subscription.") + listBySubscription is ArmListBySubscription; +} + +@@doc(InternetGatewayRules.create::parameters.resource, "Request payload."); +@@doc(InternetGatewayRules.update::parameters.properties, + "Internet Gateway Rule properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpCommunity.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpCommunity.tsp new file mode 100644 index 000000000000..488c014a8f5a --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpCommunity.tsp @@ -0,0 +1,51 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The IP Community resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model IpCommunity extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the IP Community.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("ipCommunityName") + @segment("ipCommunities") + @visibility(Lifecycle.Read) + name: string; + + /** The IP Community Properties */ + properties: IpCommunityProperties; +} + +@armResourceOperations +interface IpCommunities { + @doc("Implements an IP Community GET method.") + get is ArmResourceRead; + + @doc("Implements an IP Community PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the IP Community resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements IP Community DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements IP Communities list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Implements IP Communities list by subscription GET method.") + listBySubscription is ArmListBySubscription; +} + +@@doc(IpCommunities.create::parameters.resource, "Request payload."); +@@doc(IpCommunities.update::parameters.properties, + "IP Community properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpExtendedCommunity.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpExtendedCommunity.tsp new file mode 100644 index 000000000000..1789ba27f1c1 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpExtendedCommunity.tsp @@ -0,0 +1,52 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The IP Extended Community resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model IpExtendedCommunity + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the IP Extended Community.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("ipExtendedCommunityName") + @segment("ipExtendedCommunities") + @visibility(Lifecycle.Read) + name: string; + + /** The IpExtendedCommunity properties */ + properties: IpExtendedCommunityProperties; +} + +@armResourceOperations +interface IpExtendedCommunities { + @doc("Implements IP Extended Community GET method.") + get is ArmResourceRead; + + @doc("Implements IP Extended Community PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the IP Extended Community resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements IP Extended Community DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements IpExtendedCommunities list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Implements IpExtendedCommunities list by subscription GET method.") + listBySubscription is ArmListBySubscription; +} + +@@doc(IpExtendedCommunities.create::parameters.resource, "Request payload."); +@@doc(IpExtendedCommunities.update::parameters.properties, + "IP Extended Community properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpPrefix.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpPrefix.tsp new file mode 100644 index 000000000000..7bd4f29c7941 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/IpPrefix.tsp @@ -0,0 +1,51 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The IP Prefix resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model IpPrefix extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the IP Prefix.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("ipPrefixName") + @segment("ipPrefixes") + @visibility(Lifecycle.Read) + name: string; + + /** The IP Prefix properties */ + properties: IpPrefixProperties; +} + +@armResourceOperations +interface IpPrefixes { + @doc("Implements IP Prefix GET method.") + get is ArmResourceRead; + + @doc("Implements IP Prefix PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the IP Prefix resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements IP Prefix DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements IpPrefixes list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Implements IpPrefixes list by subscription GET method.") + listBySubscription is ArmListBySubscription; +} + +@@doc(IpPrefixes.create::parameters.resource, "Request payload."); +@@doc(IpPrefixes.update::parameters.properties, + "IP Prefix properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/L2IsolationDomain.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/L2IsolationDomain.tsp new file mode 100644 index 000000000000..fdc6cdce2e80 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/L2IsolationDomain.tsp @@ -0,0 +1,78 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The L2 Isolation Domain resource definition.") +@Azure.ResourceManager.Private.armResourceInternal(L2IsolationDomainProperties) +@Http.Private.includeInapplicableMetadataInPayload(false) +model L2IsolationDomain + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the L2 Isolation Domain.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("l2IsolationDomainName") + @segment("l2IsolationDomains") + @visibility(Lifecycle.Read) + name: string; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + @doc("The L2IsolationDomain properties") + properties: L2IsolationDomainProperties; +} + +@armResourceOperations +interface L2IsolationDomains { + @doc("Implements L2 Isolation Domain GET method.") + get is ArmResourceRead; + + @doc("Creates layer 2 network connectivity between compute nodes within a rack and across racks.The configuration is applied on the devices only after the isolation domain is enabled.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the L2 Isolation Domain resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Deletes layer 2 connectivity between compute nodes by managed by named L2 Isolation name.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays L2IsolationDomains list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays L2IsolationDomains list by subscription GET method.") + listBySubscription is ArmListBySubscription; + + @doc("Enables isolation domain across the fabric or on specified racks.") + updateAdministrativeState is ArmResourceActionAsync< + L2IsolationDomain, + UpdateAdministrativeState, + CommonPostActionResponseForDeviceUpdate + >; + + @doc("Validates the configuration of the resources.") + validateConfiguration is ArmResourceActionAsync< + L2IsolationDomain, + void, + ValidateConfigurationResponse + >; + + @doc("Commits the configuration of the given resources.") + commitConfiguration is ArmResourceActionAsync< + L2IsolationDomain, + void, + CommonPostActionResponseForStateUpdate + >; +} + +@@doc(L2IsolationDomains.create::parameters.resource, "Request payload."); +@@doc(L2IsolationDomains.update::parameters.properties, + "API to update certain properties of the L2 Isolation Domain resource.." +); +@@doc(L2IsolationDomains.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/L3IsolationDomain.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/L3IsolationDomain.tsp new file mode 100644 index 000000000000..bcd33786e3ff --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/L3IsolationDomain.tsp @@ -0,0 +1,79 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using Azure.ResourceManager.Private; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The L3 Isolation Domain resource definition.") +@Azure.ResourceManager.Private.armResourceInternal(L3IsolationDomainProperties) +@Http.Private.includeInapplicableMetadataInPayload(false) +model L3IsolationDomain + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the L3 Isolation Domain.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("l3IsolationDomainName") + @segment("l3IsolationDomains") + @visibility(Lifecycle.Read) + name: string; + + /** The L3 Isolation Domain Properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: L3IsolationDomainProperties; +} + +@armResourceOperations +interface L3IsolationDomains { + @doc("Retrieves details of this L3 Isolation Domain.") + get is ArmResourceRead; + + @doc("Create isolation domain resources for layer 3 connectivity between compute nodes and for communication with external services .This configuration is applied on the devices only after the creation of networks is completed and isolation domain is enabled.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the L3 Isolation Domain resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays L3IsolationDomains list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays L3IsolationDomains list by subscription GET method.") + listBySubscription is ArmListBySubscription; + + @doc("Enables racks for this Isolation Domain.") + updateAdministrativeState is ArmResourceActionAsync< + L3IsolationDomain, + UpdateAdministrativeState, + CommonPostActionResponseForDeviceUpdate + >; + + @doc("Validates the configuration of the resources.") + validateConfiguration is ArmResourceActionAsync< + L3IsolationDomain, + void, + ValidateConfigurationResponse + >; + + @doc("Commits the configuration of the given resources.") + commitConfiguration is ArmResourceActionAsync< + L3IsolationDomain, + void, + CommonPostActionResponseForStateUpdate + >; +} + +@@doc(L3IsolationDomains.create::parameters.resource, "Request payload."); +@@doc(L3IsolationDomains.update::parameters.properties, + "API to update certain properties of the L3 Isolation Domain resource." +); +@@doc(L3IsolationDomains.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NeighborGroup.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NeighborGroup.tsp new file mode 100644 index 000000000000..2d05f73c85d7 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NeighborGroup.tsp @@ -0,0 +1,51 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("Defines the Neighbor Group.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model NeighborGroup extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Neighbor Group.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("neighborGroupName") + @segment("neighborGroups") + @visibility(Lifecycle.Read) + name: string; + + /** The NeighborGroup Properties */ + properties: NeighborGroupProperties; +} + +@armResourceOperations +interface NeighborGroups { + @doc("Gets the Neighbor Group.") + get is ArmResourceRead; + + @doc("Implements the Neighbor Group PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Updates the Neighbor Group.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements Neighbor Group DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays NeighborGroups list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays NeighborGroups list by subscription GET method.") + listBySubscription is ArmListBySubscription; +} + +@@doc(NeighborGroups.create::parameters.resource, "Request payload."); +@@doc(NeighborGroups.update::parameters.properties, + "Neighbor Group properties to update. Only annotations are supported." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkDevice.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkDevice.tsp new file mode 100644 index 000000000000..1f71fcf371f3 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkDevice.tsp @@ -0,0 +1,120 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Versioning; +using TypeSpec.OpenAPI; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network Device resource definition.") +@Azure.ResourceManager.Private.armResourceInternal(NetworkDeviceProperties) +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkDevice extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Device.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkDeviceName") + @segment("networkDevices") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkDevice properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: NetworkDeviceProperties; +} + +@armResourceOperations +interface NetworkDevices { + @doc("Gets the Network Device resource details.") + get is ArmResourceRead; + + @doc("Create a Network Device resource") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Update certain properties of the Network Device resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Delete the Network Device resource.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("List all the Network Device resources in a given resource group.") + listByResourceGroup is ArmResourceListByParent; + + @doc("List all the Network Device resources in a given subscription.") + listBySubscription is ArmListBySubscription; + + @doc("Reboot the Network Device.") + reboot is ArmResourceActionAsync< + NetworkDevice, + RebootProperties, + CommonPostActionResponseForStateUpdate + >; + + @doc("Refreshes the configuration the Network Device.") + refreshConfiguration is ArmResourceActionAsync< + NetworkDevice, + void, + CommonPostActionResponseForStateUpdate + >; + + @doc("Updates the Administrative state of the Network Device.") + updateAdministrativeState is ArmResourceActionAsync< + NetworkDevice, + UpdateDeviceAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Upgrades the version of the Network Device.") + upgrade is ArmResourceActionAsync< + NetworkDevice, + UpdateVersion, + CommonPostActionResponseForStateUpdate + >; + + @doc("Run the RO Command on the Network Device.") + @removed(Versions.v2024_06_15_preview) + @renamedFrom(Versions.v2024_06_15_preview, "runRoCommand") + @sharedRoute + @action("runRoCommand") + runRoCommandDeprecated is ArmResourceActionAsync< + NetworkDevice, + DeviceRoCommand, + CommonPostActionResponseForDeviceROCommandsDeprecated + >; + + @doc("Run the RO Command on the Network Device.") + @added(Versions.v2024_06_15_preview) + @sharedRoute + @action("runRoCommand") + runRoCommand is ArmResourceActionAsync< + NetworkDevice, + DeviceRoCommand, + CommonPostActionResponseForDeviceROCommandsOperationStatusResult + >; + + @doc("Run the RW Command on the Network Device.") + runRwCommand is ArmResourceActionAsync< + NetworkDevice, + DeviceRwCommand, + CommonPostActionResponseForDeviceRWCommands + >; +} + +@@doc(NetworkDevices.create::parameters.resource, "Request payload."); +@@doc(NetworkDevices.update::parameters.properties, + "Network Device properties to update." +); +@@doc(NetworkDevices.reboot::parameters.body, "Request payload."); +@@doc(NetworkDevices.updateAdministrativeState::parameters.body, + "Request payload." +); +@@doc(NetworkDevices.upgrade::parameters.body, "Request payload."); +@@doc(NetworkDevices.runRoCommand::parameters.body, "Request the command."); +@@doc(NetworkDevices.runRoCommandDeprecated::parameters.body, + "Request the command." +); +@@doc(NetworkDevices.runRwCommand::parameters.body, "Request the command."); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkDeviceSku.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkDeviceSku.tsp new file mode 100644 index 000000000000..4b7a42390bfb --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkDeviceSku.tsp @@ -0,0 +1,35 @@ +import "../models/common.tsp"; +import "../models/NetworkDeviceSku.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The NetworkDeviceSku resource definition.") +@subscriptionResource +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkDeviceSku extends Azure.ResourceManager.Foundations.ProxyResource { + @doc("Name of the Network Device SKU.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkDeviceSkuName") + @segment("networkDeviceSkus") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkDeviceSku properties */ + properties: NetworkDeviceSkuProperties; +} + +@armResourceOperations +interface NetworkDeviceSkus { + @doc("Get a Network Device SKU details.") + get is ArmResourceRead; + + @doc("List Network Device SKUs for the given subscription.") + listBySubscription is ArmResourceListByParent; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabric.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabric.tsp new file mode 100644 index 000000000000..963966572598 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabric.tsp @@ -0,0 +1,177 @@ +import "../models/common.tsp"; +import "../models/NetworkFabric.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network Fabric resource definition.") +@Azure.ResourceManager.Private.armResourceInternal(NetworkFabricProperties) +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkFabric extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Fabric.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkFabricName") + @segment("networkFabrics") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkFabric Properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: NetworkFabricProperties; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + @added(Versions.v2024_06_15_preview) + @doc("The managed service identities assigned to this resource.") + identity?: Azure.ResourceManager.Foundations.ManagedServiceIdentity; +} + +@armResourceOperations +interface NetworkFabrics { + @doc("Get Network Fabric resource details.") + get is ArmResourceRead; + + @doc("Create Network Fabric resource.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Update certain properties of the Network Fabric resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Delete Network Fabric resource.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("List all the Network Fabric resources in the given resource group.") + listByResourceGroup is ArmResourceListByParent; + + @doc("List all the Network Fabric resources in the given subscription.") + listBySubscription is ArmListBySubscription; + + @doc("Provisions the underlying resources in the given Network Fabric instance.") + provision is ArmResourceActionAsync< + NetworkFabric, + void, + CommonPostActionResponseForDeviceUpdate + >; + + @doc("Deprovisions the underlying resources in the given Network Fabric instance.") + deprovision is ArmResourceActionAsync< + NetworkFabric, + void, + CommonPostActionResponseForDeviceUpdate + >; + + @doc("Upgrades the version of the underlying resources in the given Network Fabric instance.") + upgrade is ArmResourceActionAsync< + NetworkFabric, + UpgradeNetworkFabricProperties, + CommonPostActionResponseForStateUpdate + >; + + @doc("Refreshes the configuration of the underlying resources in the given Network Fabric instance.") + refreshConfiguration is ArmResourceActionAsync< + NetworkFabric, + void, + CommonPostActionResponseForStateUpdate + >; + + @doc("Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.") + updateWorkloadManagementBfdConfiguration is ArmResourceActionAsync< + NetworkFabric, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.") + updateInfraManagementBfdConfiguration is ArmResourceActionAsync< + NetworkFabric, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Validates the configuration of the underlying resources in the given Network Fabric instance.") + validateConfiguration is ArmResourceActionAsync< + NetworkFabric, + ValidateConfigurationProperties, + ValidateConfigurationResponse + >; + + @doc("Gets Topology of the underlying resources in the given Network Fabric instance.") + getTopology is ArmResourceActionAsync< + NetworkFabric, + void, + ValidateConfigurationResponse + >; + + @doc("Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.") + commitConfiguration is ArmResourceActionAsync< + NetworkFabric, + void, + CommonPostActionResponseForStateUpdate + >; + + @doc("Post action: Returns a status of commit batch operation.") + @added(Versions.v2024_06_15_preview) + commitBatchStatus is ArmResourceActionAsync< + NetworkFabric, + CommitBatchStatusRequest, + CommitBatchStatusResponse + >; + + @doc("Post action: Discards a Batch operation in progress.") + @added(Versions.v2024_06_15_preview) + discardCommitBatch is ArmResourceActionAsync< + NetworkFabric, + DiscardCommitBatchRequest, + DiscardCommitBatchResponse + >; + + @doc("Post action: Triggers network fabric lock operation.") + @added(Versions.v2024_06_15_preview) + lockFabric is ArmResourceActionAsync< + NetworkFabric, + NetworkFabricLockRequest, + CommonPostActionResponseForStateUpdate + >; + + @doc("Post action: Triggers view of network fabric configuration.") + @added(Versions.v2024_06_15_preview) + viewDeviceConfiguration is ArmResourceActionAsync< + NetworkFabric, + void, + ViewDeviceConfigurationResponse + >; + + @doc("Post action: Triggers diff of NetworkFabric ARM Configuration.") + @added(Versions.v2024_06_15_preview) + armConfigurationDiff is ArmResourceActionAsync< + NetworkFabric, + void, + ArmConfigurationDiffResponse + >; +} + +@@doc(NetworkFabrics.create::parameters.resource, "Request payload."); +@@doc(NetworkFabrics.update::parameters.properties, + "Network Fabric properties to update." +); +@@doc(NetworkFabrics.upgrade::parameters.body, + "Network Fabric properties to update." +); +@@doc(NetworkFabrics.updateWorkloadManagementBfdConfiguration::parameters.body, + "Request payload." +); +@@doc(NetworkFabrics.updateInfraManagementBfdConfiguration::parameters.body, + "Request payload." +); +@@doc(NetworkFabrics.validateConfiguration::parameters.body, + "Validate configuration properties." +); +@@doc(NetworkFabrics.commitBatchStatus::parameters.body, "Request payload."); +@@doc(NetworkFabrics.lockFabric::parameters.body, "Request payload."); +@@doc(NetworkFabrics.discardCommitBatch::parameters.body, "Request payload."); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabricController.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabricController.tsp new file mode 100644 index 000000000000..79a460ca0b0f --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabricController.tsp @@ -0,0 +1,56 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network Fabric Controller resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkFabricController + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Fabric Controller.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkFabricControllerName") + @segment("networkFabricControllers") + @visibility(Lifecycle.Read) + name: string; + + @doc("The NetworkFabricController Properties") + properties: NetworkFabricControllerProperties; +} + +@armResourceOperations +interface NetworkFabricControllers { + @doc("Shows the provisioning status of Network Fabric Controller.") + get is ArmResourceRead; + + @doc("Creates a Network Fabric Controller.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Updates are currently not supported for the Network Fabric Controller resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + NetworkFabricController, + NetworkFabricControllerPatch + >; + + @doc("Deletes the Network Fabric Controller resource.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Lists all the NetworkFabricControllers thats available in the resource group.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Lists all the NetworkFabricControllers by subscription.") + listBySubscription is ArmListBySubscription; +} + +@@doc(NetworkFabricControllers.create::parameters.resource, "Request payload."); +@@doc(NetworkFabricControllers.update::parameters.properties, + "Network Fabric Controller properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabricSku.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabricSku.tsp new file mode 100644 index 000000000000..47bf975ba1db --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkFabricSku.tsp @@ -0,0 +1,34 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network Fabric SKU resource definition.") +@subscriptionResource +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkFabricSku extends Azure.ResourceManager.Foundations.ProxyResource { + @doc("Name of the Network Fabric SKU.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkFabricSkuName") + @segment("networkFabricSkus") + @visibility(Lifecycle.Read) + name: string; + + /** The Network Fabric Sku properties */ + properties: NetworkFabricSkuProperties; +} + +@armResourceOperations +interface NetworkFabricSkus { + @doc("Implements Network Fabric SKU GET method.") + get is ArmResourceRead; + + @doc("Implements Network Fabric SKUs list by subscription GET method.") + listBySubscription is ArmResourceListByParent; +} diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkInterface.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkInterface.tsp new file mode 100644 index 000000000000..6372c922c837 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkInterface.tsp @@ -0,0 +1,62 @@ +import "../models/common.tsp"; +import "./NetworkDevice.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("Defines the NetworkInterface resource.") +@parentResource(NetworkDevice) +@Azure.ResourceManager.Private.armResourceInternal(NetworkInterfaceProperties) +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkInterface extends Azure.ResourceManager.Foundations.ProxyResource { + @doc("Name of the Network Interface.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkInterfaceName") + @segment("networkInterfaces") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkInterface properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: NetworkInterfaceProperties; +} + +@armResourceOperations +interface NetworkInterfaces { + @doc("Get the Network Interface resource details.") + get is ArmResourceRead; + + @doc("Create a Network Interface resource.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Update certain properties of the Network Interface resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Delete the Network Interface resource.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("List all the Network Interface resources in a given resource group.") + listByNetworkDevice is ArmResourceListByParent; + + @doc("Update the admin state of the Network Interface.") + updateAdministrativeState is ArmResourceActionAsync< + NetworkInterface, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; +} + +@@doc(NetworkInterfaces.create::parameters.resource, "Request payload."); +@@doc(NetworkInterfaces.update::parameters.properties, + "NetworkInterface properties to update. Only tags are supported." +); +@@doc(NetworkInterfaces.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkMonitor.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkMonitor.tsp new file mode 100644 index 000000000000..2fdffe644761 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkMonitor.tsp @@ -0,0 +1,62 @@ +import "../models/common.tsp"; +import "../models/NetworkMonitor.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Versioning; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The NetworkMonitor resource definition.") +@added(Versions.v2024_06_15_preview) +@Azure.ResourceManager.Private.armResourceInternal(NetworkMonitorProperties) +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkMonitor extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Monitor.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkMonitorName") + @segment("networkMonitors") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkFabric Properties */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + properties: NetworkMonitorProperties; +} + +@armResourceOperations +@added(Versions.v2024_06_15_preview) +interface NetworkMonitors { + @doc("Implements NetworkMonitor GET method.") + get is ArmResourceRead; + + @doc("Creates NetworkMonitor resource.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the NetworkMonitor resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Deletes layer 2 connectivity between compute nodes by managed by named NetworkMonitor name.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays NetworkMonitors list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays NetworkMonitors list by subscription GET method.") + listBySubscription is ArmListBySubscription; + + @doc("Enables isolation domain across the fabric or on specified racks.") + updateAdministrativeState is ArmResourceActionAsync< + NetworkMonitor, + UpdateAdministrativeState, + CommonPostActionResponseForDeviceUpdate + >; +} + +@@doc(NetworkMonitors.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkPacketBroker.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkPacketBroker.tsp new file mode 100644 index 000000000000..bfeae67d12d8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkPacketBroker.tsp @@ -0,0 +1,52 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The NetworkPacketBroker resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkPacketBroker + extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Packet Broker.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkPacketBrokerName") + @segment("networkPacketBrokers") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkPacketBroker properties */ + properties: NetworkPacketBrokerProperties; +} + +@armResourceOperations +interface NetworkPacketBrokers { + @doc("Retrieves details of this Network Packet Broker.") + get is ArmResourceRead; + + @doc("Creates a Network Packet Broker.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the Network Packet Broker resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Deletes Network Packet Broker.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays NetworkPacketBrokers list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays Network Packet Brokers list by subscription GET method.") + listBySubscription is ArmListBySubscription; +} + +@@doc(NetworkPacketBrokers.create::parameters.resource, "Request payload."); +@@doc(NetworkPacketBrokers.update::parameters.properties, + "Network Packet Broker properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkRack.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkRack.tsp new file mode 100644 index 000000000000..050edc36d7c6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkRack.tsp @@ -0,0 +1,51 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network Rack resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkRack extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Rack.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkRackName") + @segment("networkRacks") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkRack properties */ + properties: NetworkRackProperties; +} + +@armResourceOperations +interface NetworkRacks { + @doc("Get Network Rack resource details.") + get is ArmResourceRead; + + @doc("Create Network Rack resource.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Update certain properties of the Network Rack resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Delete Network Rack resource.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("List all Network Rack resources in the given resource group.") + listByResourceGroup is ArmResourceListByParent; + + @doc("List all Network Rack resources in the given subscription") + listBySubscription is ArmListBySubscription; +} + +@@doc(NetworkRacks.create::parameters.resource, "Request payload."); +@@doc(NetworkRacks.update::parameters.properties, + "Network Rack properties to update." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkTap.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkTap.tsp new file mode 100644 index 000000000000..982cfc8accc8 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkTap.tsp @@ -0,0 +1,68 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network Tap resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkTap extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Tap.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkTapName") + @segment("networkTaps") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkTap Properties */ + properties: NetworkTapProperties; +} + +@armResourceOperations +interface NetworkTaps { + @doc("Retrieves details of this Network Tap.") + get is ArmResourceRead; + + @doc("Creates a Network Tap.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the Network Tap resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Deletes Network Tap.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Displays Network Taps list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Displays Network Taps list by subscription GET method.") + listBySubscription is ArmListBySubscription; + + @doc("Implements the operation to the underlying resources.") + updateAdministrativeState is ArmResourceActionAsync< + NetworkTap, + UpdateAdministrativeState, + CommonPostActionResponseForDeviceUpdate + >; + + @doc("Implements the operation to the underlying resources.") + resync is ArmResourceActionAsync< + NetworkTap, + void, + CommonPostActionResponseForStateUpdate + >; +} + +@@doc(NetworkTaps.create::parameters.resource, "Request payload."); +@@doc(NetworkTaps.update::parameters.properties, + "Network Tap properties to update." +); +@@doc(NetworkTaps.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkTapRule.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkTapRule.tsp new file mode 100644 index 000000000000..c28d822f31dd --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkTapRule.tsp @@ -0,0 +1,75 @@ +import "../models/common.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; + +using TypeSpec.Http; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The NetworkTapRule resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkTapRule extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Network Tap Rule.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkTapRuleName") + @segment("networkTapRules") + @visibility(Lifecycle.Read) + name: string; + + /** The NetworkTapRule Properties */ + properties: NetworkTapRuleProperties; +} + +@armResourceOperations +interface NetworkTapRules { + @doc("Get Network Tap Rule resource details.") + get is ArmResourceRead; + + @doc("Create Network Tap Rule resource.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Update certain properties of the Network Tap Rule resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Delete Network Tap Rule resource.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("List all the Network Tap Rule resources in the given resource group.") + listByResourceGroup is ArmResourceListByParent; + + @doc("List all the Network Tap Rule resources in the given subscription.") + listBySubscription is ArmListBySubscription; + + @doc("Implements the operation to the underlying resources.") + updateAdministrativeState is ArmResourceActionAsync< + NetworkTapRule, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Implements the operation to the underlying resources.") + resync is ArmResourceActionAsync< + NetworkTapRule, + void, + CommonPostActionResponseForStateUpdate + >; + + @doc("Implements the operation to the underlying resources.") + validateConfiguration is ArmResourceActionAsync< + NetworkTapRule, + void, + ValidateConfigurationResponse + >; +} + +@@doc(NetworkTapRules.create::parameters.resource, "Request payload."); +@@doc(NetworkTapRules.update::parameters.properties, + "Network Tap Rule properties to update." +); +@@doc(NetworkTapRules.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkToNetworkInterconnect.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkToNetworkInterconnect.tsp new file mode 100644 index 000000000000..fa29a44e7b1d --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/NetworkToNetworkInterconnect.tsp @@ -0,0 +1,92 @@ +import "./NetworkFabric.tsp"; +import "../models/common.tsp"; +import "../models/NetworkToNetworkInterconnect.tsp"; + +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.Versioning; +using TypeSpec.Rest; + +namespace Microsoft.ManagedNetworkFabric; + +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The Network To Network Interconnect resource definition.") +@Azure.ResourceManager.Private.armResourceInternal(L2IsolationDomainProperties) +@parentResource(NetworkFabric) +@Http.Private.includeInapplicableMetadataInPayload(false) +model NetworkToNetworkInterconnect + extends Azure.ResourceManager.Foundations.ProxyResource { + @doc("Name of the Network to Network Interconnect.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("networkToNetworkInterconnectName") + @segment("networkToNetworkInterconnects") + @visibility(Lifecycle.Read) + name: string; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "Need custom inheritance" + @doc("The NetworkToNetworkInterconnect Properties") + properties: NetworkToNetworkInterconnectProperties; +} + +@armResourceOperations +interface NetworkToNetworkInterconnects { + @doc("Implements NetworkToNetworkInterconnects GET method.") + get is ArmResourceRead; + + @doc("Configuration used to setup CE-PE connectivity PUT Method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("Update certain properties of the Network To NetworkInterconnects resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + NetworkToNetworkInterconnect, + NetworkToNetworkInterconnectPatch + >; + + @doc("Implements NetworkToNetworkInterconnects DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements Network To Network Interconnects list by Network Fabric GET method.") + listByNetworkFabric is ArmResourceListByParent; + + @doc("Updates the NPB Static Route BFD Administrative State.") + @removed(Versions.v2024_06_15_preview) + updateNpbStaticRouteBfdAdministrativeState is ArmResourceActionAsync< + NetworkToNetworkInterconnect, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Updates the Admin State.") + updateAdministrativeState is ArmResourceActionAsync< + NetworkToNetworkInterconnect, + UpdateAdministrativeState, + CommonPostActionResponseForStateUpdate + >; + + @doc("Updates the Admin State.") + @added(Versions.v2024_06_15_preview) + updateBfdAdministrativeState is ArmResourceActionAsync< + NetworkToNetworkInterconnect, + NniBfdAdministrativeStateRequest, + NniBfdAdministrativeStateResponse + >; +} + +@@doc(NetworkToNetworkInterconnects.create::parameters.resource, + "Request payload." +); +@@doc(NetworkToNetworkInterconnects.update::parameters.properties, + "Network to Network Interconnect properties to update." +); +@@doc(NetworkToNetworkInterconnects.updateNpbStaticRouteBfdAdministrativeState::parameters.body, + "Request payload." +); +@@doc(NetworkToNetworkInterconnects.updateAdministrativeState::parameters.body, + "Request payload." +); +@@doc(NetworkToNetworkInterconnects.updateBfdAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/RoutePolicy.tsp b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/RoutePolicy.tsp new file mode 100644 index 000000000000..7e0f78b6af47 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/resources/RoutePolicy.tsp @@ -0,0 +1,76 @@ +import "../models/common.tsp"; +import "../models/RoutePolicy.tsp"; + +using TypeSpec.Http; +using TypeSpec.OpenAPI; +using TypeSpec.Rest; +using Azure.ResourceManager; + +namespace Microsoft.ManagedNetworkFabric; +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "" +#suppress "@azure-tools/typespec-azure-core/no-private-usage" "Unsupported common type" +@doc("The RoutePolicy resource definition.") +@Http.Private.includeInapplicableMetadataInPayload(false) +model RoutePolicy extends Azure.ResourceManager.Foundations.TrackedResource { + @doc("Name of the Route Policy.") + @pattern("^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$") + @path + @key("routePolicyName") + @segment("routePolicies") + @visibility(Lifecycle.Read) + name: string; + + /** The RoutePolicy properties */ + properties: RoutePolicyProperties; +} + +@armResourceOperations +interface RoutePolicies { + @doc("Implements Route Policy GET method.") + get is ArmResourceRead; + + @doc("Implements Route Policy PUT method.") + create is ArmResourceCreateOrReplaceAsync; + + @doc("API to update certain properties of the Route Policy resource.") + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync; + + @doc("Implements Route Policy DELETE method.") + delete is ArmResourceDeleteWithoutOkAsync; + + @doc("Implements RoutePolicies list by resource group GET method.") + listByResourceGroup is ArmResourceListByParent; + + @doc("Implements RoutePolicies list by subscription GET method.") + listBySubscription is ArmListBySubscription; + + @doc("Updated the admin state for this Route Policy.") + updateAdministrativeState is ArmResourceActionAsync< + RoutePolicy, + UpdateAdministrativeState, + CommonPostActionResponseForDeviceUpdate + >; + + @doc("Validates the configuration of the resources.") + validateConfiguration is ArmResourceActionAsync< + RoutePolicy, + void, + ValidateConfigurationResponse + >; + + @doc("Commits the configuration of the given resources.") + commitConfiguration is ArmResourceActionAsync< + RoutePolicy, + void, + CommonPostActionResponseForStateUpdate + >; +} + +@@doc(RoutePolicies.create::parameters.resource, "Request payload."); +@@doc(RoutePolicies.update::parameters.properties, + "Route Policy properties to update." +); +@@doc(RoutePolicies.updateAdministrativeState::parameters.body, + "Request payload." +); diff --git a/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/tspconfig.yaml b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/tspconfig.yaml new file mode 100644 index 000000000000..d1550f6387f6 --- /dev/null +++ b/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/tspconfig.yaml @@ -0,0 +1,49 @@ +parameters: + "service-dir": + default: "sdk/managednetworkfabric" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/managednetworkfabric.json" + "@azure-tools/typespec-csharp": + emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" + flavor: azure + clear-output-folder: true + model-namespace: true + namespace: "Azure.ResourceManager.ManagedNetworkFabric" + "@azure-tools/typespec-python": + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-managednetworkfabric" + namespace: "azure.mgmt.managednetworkfabric" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-managednetworkfabric" + namespace: "com.azure.resourcemanager.managednetworkfabric" + service-name: "fileshares" + flavor: azure + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/managednetworkfabric" + emitter-output-dir: "{output-dir}/{service-dir}/armmanagednetworkfabric" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armmanagednetworkfabric" + fix-const-stuttering: true + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + "@azure-tools/typespec-ts": + emitter-output-dir: "{output-dir}/{service-dir}/arm-managednetworkfabric" + is-modular-library: true + flavor: "azure" + experimental-extensible-enums: true + package-details: + name: "@azure/arm-managednetworkfabric" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/managednetworkfabric/cspell.yaml b/specification/managednetworkfabric/cspell.yaml index 3b6ec32a60be..c72e5a6e16e6 100644 --- a/specification/managednetworkfabric/cspell.yaml +++ b/specification/managednetworkfabric/cspell.yaml @@ -4,10 +4,17 @@ # Spell checking is not case sensitive # Keep word lists in alphabetical order so the file is easier to manage -version: '0.2' import: - ../../cspell.yaml words: - dscp + - evpn + - gbps - gshut + - kbps +overrides: + - filename: >- + **/specification/managednetworkfabric/ManagedNetworkFabric.ResourceManager.Management/models/common.tsp + words: + - updateable diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Create.json new file mode 100644 index 000000000000..e2981841f545 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Create.json @@ -0,0 +1,379 @@ +{ + "title": "AccessControlLists_Create_MaximumSet_Gen", + "operationId": "AccessControlLists_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + }, + "tags": { + "keyID": "keyValue" + }, + "location": "eastUs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled", + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "flags": [ + "established" + ], + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ] + }, + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Delete.json new file mode 100644 index 000000000000..af3bdca682f4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AccessControlLists_Delete_MaximumSet_Gen", + "operationId": "AccessControlLists_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Get.json new file mode 100644 index 000000000000..f7ed24e975d1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Get.json @@ -0,0 +1,139 @@ +{ + "title": "AccessControlLists_Get_MaximumSet_Gen", + "operationId": "AccessControlLists_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ListByResourceGroup.json new file mode 100644 index 000000000000..bd804ce29803 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ListByResourceGroup.json @@ -0,0 +1,143 @@ +{ + "title": "AccessControlLists_ListByResourceGroup_MaximumSet_Gen", + "operationId": "AccessControlLists_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ListBySubscription.json new file mode 100644 index 000000000000..1301c9cb6295 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ListBySubscription.json @@ -0,0 +1,142 @@ +{ + "title": "AccessControlLists_ListBySubscription_MaximumSet_Gen", + "operationId": "AccessControlLists_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Resync.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Resync.json new file mode 100644 index 000000000000..f79c7d0440e4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "AccessControlLists_Resync_MaximumSet_Gen", + "operationId": "AccessControlLists_Resync", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Update.json new file mode 100644 index 000000000000..99a8b9b28361 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_Update.json @@ -0,0 +1,253 @@ +{ + "title": "AccessControlLists_Update_MaximumSet_Gen", + "operationId": "AccessControlLists_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "configurationType": "File", + "aclsUrl": "https://microsoft.com/a", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "flags": [ + "established" + ], + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_UpdateAdministrativeState.json new file mode 100644 index 000000000000..5e1c0b468217 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "AccessControlLists_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "AccessControlLists_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ValidateConfiguration.json new file mode 100644 index 000000000000..35c1d0774d10 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/AccessControlLists_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "AccessControlLists_ValidateConfiguration_MaximumSet_Gen", + "operationId": "AccessControlLists_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Create.json new file mode 100644 index 000000000000..8435757ed6ba --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Create.json @@ -0,0 +1,214 @@ +{ + "title": "ExternalNetworks_Create_MaximumSet_Gen", + "operationId": "ExternalNetworks_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "resource": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Delete.json new file mode 100644 index 000000000000..b5115f3fd1ff --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "ExternalNetworks_Delete_MaximumSet_Gen", + "operationId": "ExternalNetworks_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Get.json new file mode 100644 index 000000000000..05c7faa76ea0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Get.json @@ -0,0 +1,85 @@ +{ + "title": "ExternalNetworks_Get_MaximumSet_Gen", + "operationId": "ExternalNetworks_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..b91889ca930d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,89 @@ +{ + "title": "ExternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "ExternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Update.json new file mode 100644 index 000000000000..ab2c984f940b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_Update.json @@ -0,0 +1,144 @@ +{ + "title": "ExternalNetworks_Update_MaximumSet_Gen", + "operationId": "ExternalNetworks_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "properties": { + "properties": { + "annotation": "annotation1", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..ef8f566b574e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "ExternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "ExternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..b9ade0923cc5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "ExternalNetworks_UpdateStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "ExternalNetworks_UpdateStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Create.json new file mode 100644 index 000000000000..59347e9d5ac8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Create.json @@ -0,0 +1,307 @@ +{ + "title": "InternalNetworks_Create_MaximumSet_Gen", + "operationId": "InternalNetworks_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "resource": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Delete.json new file mode 100644 index 000000000000..9fab8dfddc2b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "InternalNetworks_Delete_MaximumSet_Gen", + "operationId": "InternalNetworks_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Get.json new file mode 100644 index 000000000000..35ccdbb97d0a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Get.json @@ -0,0 +1,117 @@ +{ + "title": "InternalNetworks_Get_MaximumSet_Gen", + "operationId": "InternalNetworks_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..61946d006328 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,121 @@ +{ + "title": "InternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "InternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Update.json new file mode 100644 index 000000000000..1202c83d54ee --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_Update.json @@ -0,0 +1,202 @@ +{ + "title": "InternalNetworks_Update_MaximumSet_Gen", + "operationId": "InternalNetworks_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "properties": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0" + } + ], + "ipv6NeighborAddress": [ + { + "address": "10.1.0.0" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "configurationState": "Succeeded" + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..cf9a63327ad8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateBgpAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateBgpAdministrativeState.json new file mode 100644 index 000000000000..5c192ffccb0e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateBgpAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateBgpAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateBgpAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..aa0716adbbfa --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Create.json new file mode 100644 index 000000000000..4d58ba055872 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Create.json @@ -0,0 +1,94 @@ +{ + "title": "InternetGatewayRules_Create_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "resource": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + } + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Delete.json new file mode 100644 index 000000000000..65056d6e5815 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGatewayRules_Delete_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Get.json new file mode 100644 index 000000000000..e874f87557d2 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Get.json @@ -0,0 +1,44 @@ +{ + "title": "InternetGatewayRules_Get_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_ListByResourceGroup.json new file mode 100644 index 000000000000..b5adb9b10f5d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "title": "InternetGatewayRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_ListBySubscription.json new file mode 100644 index 000000000000..10288cbdeacf --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "title": "InternetGatewayRules_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Update.json new file mode 100644 index 000000000000..a14bbaf8a375 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGatewayRules_Update.json @@ -0,0 +1,54 @@ +{ + "title": "InternetGatewayRules_Update_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "properties": { + "tags": { + "KeyID": "KeyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Create.json new file mode 100644 index 000000000000..51ba8c7ac127 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Create.json @@ -0,0 +1,83 @@ +{ + "title": "InternetGateways_Create_MaximumSet_Gen", + "operationId": "InternetGateways_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "resource": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Delete.json new file mode 100644 index 000000000000..c3871f28599d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGateways_Delete_MaximumSet_Gen", + "operationId": "InternetGateways_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Get.json new file mode 100644 index 000000000000..533aa77d29d3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Get.json @@ -0,0 +1,40 @@ +{ + "title": "InternetGateways_Get_MaximumSet_Gen", + "operationId": "InternetGateways_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_ListByResourceGroup.json new file mode 100644 index 000000000000..aa66a8cb4c68 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "InternetGateways_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGateways_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_ListBySubscription.json new file mode 100644 index 000000000000..c3dc1f4e3e6b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "InternetGateways_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGateways_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Update.json new file mode 100644 index 000000000000..27ffbae1e2d5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/InternetGateways_Update.json @@ -0,0 +1,53 @@ +{ + "title": "InternetGateways_Update_MaximumSet_Gen", + "operationId": "InternetGateways_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Create.json new file mode 100644 index 000000000000..1595d7cde39e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Create.json @@ -0,0 +1,111 @@ +{ + "title": "IpCommunities_Create_MaximumSet_Gen", + "operationId": "IpCommunities_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Delete.json new file mode 100644 index 000000000000..a512af5dadc9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpCommunities_Delete_MaximumSet_Gen", + "operationId": "IpCommunities_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Get.json new file mode 100644 index 000000000000..1bda305934a4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Get.json @@ -0,0 +1,49 @@ +{ + "title": "IpCommunities_Get_MaximumSet_Gen", + "operationId": "IpCommunities_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..358037fa9ce7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "IpCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_ListBySubscription.json new file mode 100644 index 000000000000..40d5f27cc5f0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "IpCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Update.json new file mode 100644 index 000000000000..a4f1dd442a56 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpCommunities_Update.json @@ -0,0 +1,73 @@ +{ + "title": "IpCommunities_Update_MaximumSet_Gen", + "operationId": "IpCommunities_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "properties": { + "tags": { + "keyID": "KeyValue" + }, + "properties": { + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Create.json new file mode 100644 index 000000000000..9784c4d841f9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Create.json @@ -0,0 +1,102 @@ +{ + "title": "IpExtendedCommunities_Create_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Delete.json new file mode 100644 index 000000000000..5f9d0eff1c00 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpExtendedCommunities_Delete_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Get.json new file mode 100644 index 000000000000..ec299f320b42 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Get.json @@ -0,0 +1,46 @@ +{ + "title": "IpExtendedCommunities_Get_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..2da21b7e47d6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "IpExtendedCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_ListBySubscription.json new file mode 100644 index 000000000000..12cb789b5f91 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "IpExtendedCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Update.json new file mode 100644 index 000000000000..fd353be61c9f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpExtendedCommunities_Update.json @@ -0,0 +1,68 @@ +{ + "title": "IpExtendedCommunities_Update_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Create.json new file mode 100644 index 000000000000..a30c6e3b6e3f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Create.json @@ -0,0 +1,102 @@ +{ + "title": "IpPrefixes_Create_MaximumSet_Gen", + "operationId": "IpPrefixes_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "resource": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Delete.json new file mode 100644 index 000000000000..027a12c980a5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpPrefixes_Delete_MaximumSet_Gen", + "operationId": "IpPrefixes_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Get.json new file mode 100644 index 000000000000..038749b88065 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Get.json @@ -0,0 +1,46 @@ +{ + "title": "IpPrefixes_Get_MaximumSet_Gen", + "operationId": "IpPrefixes_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_ListByResourceGroup.json new file mode 100644 index 000000000000..ddfeff34510f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "IpPrefixes_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpPrefixes_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_ListBySubscription.json new file mode 100644 index 000000000000..a8800a55e0b6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "IpPrefixes_ListBySubscription_MaximumSet_Gen", + "operationId": "IpPrefixes_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Update.json new file mode 100644 index 000000000000..ed11bbef6c01 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/IpPrefixes_Update.json @@ -0,0 +1,68 @@ +{ + "title": "IpPrefixes_Update_MaximumSet_Gen", + "operationId": "IpPrefixes_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..ee171335ad5a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L2IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Create.json new file mode 100644 index 000000000000..1de2ad9ab7a2 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Create.json @@ -0,0 +1,84 @@ +{ + "title": "L2IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Delete.json new file mode 100644 index 000000000000..f155078736b3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L2IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Get.json new file mode 100644 index 000000000000..aee14a158a8a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Get.json @@ -0,0 +1,40 @@ +{ + "title": "L2IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..b58030db7cf4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "L2IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..8166ad90af19 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "L2IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Update.json new file mode 100644 index 000000000000..574cf8c6e427 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_Update.json @@ -0,0 +1,54 @@ +{ + "title": "L2IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "mtu": 6000 + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..4c41075e244a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L2IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L2IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..c2c5404c4d12 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L2IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L2IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..aa19da8b7db9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L3IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Create.json new file mode 100644 index 000000000000..97258c850bbb --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Create.json @@ -0,0 +1,141 @@ +{ + "title": "L3IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "resource": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Delete.json new file mode 100644 index 000000000000..3e7e92d99f82 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L3IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Get.json new file mode 100644 index 000000000000..45a422ec262a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Get.json @@ -0,0 +1,59 @@ +{ + "title": "L3IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..762800d137ca --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "title": "L3IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..3ae67b0153cc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ListBySubscription.json @@ -0,0 +1,62 @@ +{ + "title": "L3IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Update.json new file mode 100644 index 000000000000..edf53b33053b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_Update.json @@ -0,0 +1,93 @@ +{ + "title": "L3IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "False", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..f66155236fa4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L3IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L3IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..5c2bb706532c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/L3IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L3IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "mg" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Create.json new file mode 100644 index 000000000000..49ceed7a8eb8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Create.json @@ -0,0 +1,130 @@ +{ + "title": "NeighborGroups_Create_MaximumSet_Gen", + "operationId": "NeighborGroups_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "resource": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Delete.json new file mode 100644 index 000000000000..cfdd3f3059a3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NeighborGroups_Delete_MaximumSet_Gen", + "operationId": "NeighborGroups_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Get.json new file mode 100644 index 000000000000..a32e9f8367ac --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Get.json @@ -0,0 +1,57 @@ +{ + "title": "NeighborGroups_Get_MaximumSet_Gen", + "operationId": "NeighborGroups_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..4bf98890980d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "NeighborGroups_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NeighborGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_ListBySubscription.json new file mode 100644 index 000000000000..aeaada7a7baf --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "NeighborGroups_ListBySubscription_MaximumSet_Gen", + "operationId": "NeighborGroups_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Update.json new file mode 100644 index 000000000000..3e56806ea0f4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NeighborGroups_Update.json @@ -0,0 +1,86 @@ +{ + "title": "NeighborGroups_Update_MaximumSet_Gen", + "operationId": "NeighborGroups_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "Updating", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDeviceSkus_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDeviceSkus_Get.json new file mode 100644 index 000000000000..46d749b6cd00 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDeviceSkus_Get.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkDeviceSkus_Get_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkDeviceSkuName": "example-deviceSku" + }, + "responses": { + "200": { + "body": { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDeviceSkus_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDeviceSkus_ListBySubscription.json new file mode 100644 index 000000000000..3ae43e057f80 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDeviceSkus_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "NetworkDeviceSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Create.json new file mode 100644 index 000000000000..b5993dc3080d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Create.json @@ -0,0 +1,95 @@ +{ + "title": "NetworkDevices_Create_MaximumSet_Gen", + "operationId": "NetworkDevices_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "resource": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Delete.json new file mode 100644 index 000000000000..4d483128670a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkDevices_Delete_MaximumSet_Gen", + "operationId": "NetworkDevices_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Get.json new file mode 100644 index 000000000000..be1f976e9898 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Get.json @@ -0,0 +1,45 @@ +{ + "title": "NetworkDevices_Get_MaximumSet_Gen", + "operationId": "NetworkDevices_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..e8c7c84bbdc0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "title": "NetworkDevices_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_ListBySubscription.json new file mode 100644 index 000000000000..8559a3beb510 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "NetworkDevices_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDevices_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Reboot.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Reboot.json new file mode 100644 index 000000000000..6f3a91cbb09d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Reboot.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Reboot_MaximumSet_Gen", + "operationId": "NetworkDevices_Reboot", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "rebootType": "GracefulRebootWithZTP" + } + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RefreshConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RefreshConfiguration.json new file mode 100644 index 000000000000..93586a346895 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkDevices_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkDevices_RefreshConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RunRoCommand.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RunRoCommand.json new file mode 100644 index 000000000000..91025ecd7805 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RunRoCommand.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkDevices_RunRoCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRoCommand", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "sigtufivipqdapgglzi" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "svvzwijqaghjlelhr", + "message": "kgttomemzowwdiqvbtqlrd", + "target": "txdqddgrezjihhhrmdovikhm", + "details": [], + "additionalInfo": [ + { + "type": "vcaekwfqlkfzcjompti", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "outputUrl": "dxzpukpwdgo" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RunRwCommand.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RunRwCommand.json new file mode 100644 index 000000000000..4a9ea97ea83f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_RunRwCommand.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkDevices_RunRwCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRwCommand", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "yzuabghycngqmqtfacvoh" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "svvzwijqaghjlelhr", + "message": "kgttomemzowwdiqvbtqlrd", + "target": "txdqddgrezjihhhrmdovikhm", + "details": [], + "additionalInfo": [ + { + "type": "vcaekwfqlkfzcjompti", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "outputUrl": "hypjtiwzhevuc" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Update.json new file mode 100644 index 000000000000..392bf8fe6175 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Update.json @@ -0,0 +1,60 @@ +{ + "title": "NetworkDevices_Update_MaximumSet_Gen", + "operationId": "NetworkDevices_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_UpdateAdministrativeState.json new file mode 100644 index 000000000000..e1bd7f7794e6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkDevices_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkDevices_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "resourceIds": [ + "" + ], + "state": "RMA" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Upgrade.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Upgrade.json new file mode 100644 index 000000000000..28c627fccf75 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkDevices_Upgrade.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Upgrade_MaximumSet_Gen", + "operationId": "NetworkDevices_Upgrade", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "version": "1.0.0" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Create.json new file mode 100644 index 000000000000..b1c6ab25f476 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Create.json @@ -0,0 +1,176 @@ +{ + "title": "NetworkFabricControllers_Create_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "resource": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "isWorkloadManagementNetworkEnabled": "True", + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Delete.json new file mode 100644 index 000000000000..8f91ec82c5a4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabricControllers_Delete_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Get.json new file mode 100644 index 000000000000..2e7178462006 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Get.json @@ -0,0 +1,72 @@ +{ + "title": "NetworkFabricControllers_Get_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_ListByResourceGroup.json new file mode 100644 index 000000000000..3541ae52cc03 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_ListByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "title": "NetworkFabricControllers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_ListBySubscription.json new file mode 100644 index 000000000000..bad557fcec40 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_ListBySubscription.json @@ -0,0 +1,75 @@ +{ + "title": "NetworkFabricControllers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Update.json new file mode 100644 index 000000000000..9ab3eba8b2a8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricControllers_Update.json @@ -0,0 +1,96 @@ +{ + "title": "NetworkFabricControllers_Update_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "workloadManagementNetwork": true, + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricSkus_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricSkus_Get.json new file mode 100644 index 000000000000..c8172a76d1f6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricSkus_Get.json @@ -0,0 +1,36 @@ +{ + "title": "NetworkFabricSkus_Get_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkFabricSkuName": "wxample-fabricsku" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricSkus_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricSkus_ListBySubscription.json new file mode 100644 index 000000000000..ad538f69e92f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabricSkus_ListBySubscription.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabricSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_CommitConfiguration.json new file mode 100644 index 000000000000..deed3be982e5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_CommitConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-networkFabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Create.json new file mode 100644 index 000000000000..975097cf74f7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Create.json @@ -0,0 +1,397 @@ +{ + "title": "NetworkFabrics_Create_MaximumSet_Gen", + "operationId": "NetworkFabrics_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "password": "xxx-xx-xx", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Delete.json new file mode 100644 index 000000000000..d0c139f7c23c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabrics_Delete_MaximumSet_Gen", + "operationId": "NetworkFabrics_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Deprovision.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Deprovision.json new file mode 100644 index 000000000000..140aa94f5019 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Deprovision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Deprovision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Deprovision", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Get.json new file mode 100644 index 000000000000..fe9da64b52d9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Get.json @@ -0,0 +1,150 @@ +{ + "title": "NetworkFabrics_Get_MaximumSet_Gen", + "operationId": "NetworkFabrics_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_GetTopology.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_GetTopology.json new file mode 100644 index 000000000000..c71871703bdd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_GetTopology.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkFabrics_GetTopology_MaximumSet_Gen", + "operationId": "NetworkFabrics_GetTopology", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ListByResourceGroup.json new file mode 100644 index 000000000000..b4d37a7c3ecc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ListByResourceGroup.json @@ -0,0 +1,154 @@ +{ + "title": "NetworkFabrics_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ListBySubscription.json new file mode 100644 index 000000000000..829492311a93 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ListBySubscription.json @@ -0,0 +1,153 @@ +{ + "title": "NetworkFabrics_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Provision.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Provision.json new file mode 100644 index 000000000000..45c3065d6248 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Provision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Provision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Provision", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_RefreshConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_RefreshConfiguration.json new file mode 100644 index 000000000000..bd34a828d128 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_RefreshConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Update.json new file mode 100644 index 000000000000..14dd18529410 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Update.json @@ -0,0 +1,257 @@ +{ + "title": "NetworkFabrics_Update_MaximumSet_Gen", + "operationId": "NetworkFabrics_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation1", + "rackCount": 6, + "serverCountPerRack": 10, + "ipv4Prefix": "10.18.0.0/17", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/60", + "fabricASN": 12345, + "terminalServerConfiguration": { + "username": "username1", + "password": "xxxxxxxx", + "serialNumber": "1234567", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json new file mode 100644 index 000000000000..3478e9396b91 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateInfraManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateInfraManagementBfdConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json new file mode 100644 index 000000000000..435d85e516b3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Upgrade.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Upgrade.json new file mode 100644 index 000000000000..518795125fd7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_Upgrade.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_Upgrade_MaximumSet_Gen", + "operationId": "NetworkFabrics_Upgrade", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "version": "3.x.x", + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ValidateConfiguration.json new file mode 100644 index 000000000000..f18b605ff9b0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkFabrics_ValidateConfiguration.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "validateAction": "Cabling" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Create.json new file mode 100644 index 000000000000..7b5c37e90538 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Create.json @@ -0,0 +1,73 @@ +{ + "title": "NetworkInterfaces_Create_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "resource": { + "properties": { + "annotation": "annotation", + "interfaceType": "Management", + "administrativeState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..71f733e6e126 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkInterfaces_Delete_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..0efe58de95b2 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Get.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkInterfaces_Get_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_ListByNetworkDevice.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_ListByNetworkDevice.json new file mode 100644 index 000000000000..788fce977a3a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_ListByNetworkDevice.json @@ -0,0 +1,42 @@ +{ + "title": "NetworkInterfaces_ListByNetworkDevice_MaximumSet_Gen", + "operationId": "NetworkInterfaces_ListByNetworkDevice", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..0d58ef795203 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_Update.json @@ -0,0 +1,48 @@ +{ + "title": "NetworkInterfaces_Update_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "properties": { + "properties": { + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_UpdateAdministrativeState.json new file mode 100644 index 000000000000..52003d2e427d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkInterfaces_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkInterfaces_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkInterfaces_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Create.json new file mode 100644 index 000000000000..4084af2eda20 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Create.json @@ -0,0 +1,94 @@ +{ + "title": "NetworkPacketBrokers_Create_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "resource": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Delete.json new file mode 100644 index 000000000000..b1aa7b0ea835 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkPacketBrokers_Delete_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Get.json new file mode 100644 index 000000000000..8eedd3e13ca3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Get.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkPacketBrokers_Get_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_ListByResourceGroup.json new file mode 100644 index 000000000000..79b74669e55d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "NetworkPacketBrokers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_ListBySubscription.json new file mode 100644 index 000000000000..a827dfdc412a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkPacketBrokers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Update.json new file mode 100644 index 000000000000..cb133c0cdab6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkPacketBrokers_Update.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkPacketBrokers_Update_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Create.json new file mode 100644 index 000000000000..9a01bbe9eb53 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Create.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkRacks_Create_MaximumSet_Gen", + "operationId": "NetworkRacks_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "resource": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Delete.json new file mode 100644 index 000000000000..90584c3a3af3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkRacks_Delete_MaximumSet_Gen", + "operationId": "NetworkRacks_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Get.json new file mode 100644 index 000000000000..91f7bd200a8c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Get.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkRacks_Get_MaximumSet_Gen", + "operationId": "NetworkRacks_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_ListByResourceGroup.json new file mode 100644 index 000000000000..8a1330a9c76b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "title": "NetworkRacks_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkRacks_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_ListBySubscription.json new file mode 100644 index 000000000000..af7bd05d13f1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkRacks_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkRacks_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Update.json new file mode 100644 index 000000000000..99fbed98d4cd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkRacks_Update.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkRacks_Update_MaximumSet_Gen", + "operationId": "NetworkRacks_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Create.json new file mode 100644 index 000000000000..00dc44691afe --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Create.json @@ -0,0 +1,340 @@ +{ + "title": "NetworkTapRules_Create_MaximumSet_Gen", + "operationId": "NetworkTapRules_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "pollingIntervalInSeconds": 30, + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Delete.json new file mode 100644 index 000000000000..cb2fbbb2943a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTapRules_Delete_MaximumSet_Gen", + "operationId": "NetworkTapRules_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Get.json new file mode 100644 index 000000000000..9edce7cd0d27 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Get.json @@ -0,0 +1,126 @@ +{ + "title": "NetworkTapRules_Get_MaximumSet_Gen", + "operationId": "NetworkTapRules_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ListByResourceGroup.json new file mode 100644 index 000000000000..2128f9c21a45 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ListByResourceGroup.json @@ -0,0 +1,130 @@ +{ + "title": "NetworkTapRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ListBySubscription.json new file mode 100644 index 000000000000..82c413a364d5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ListBySubscription.json @@ -0,0 +1,129 @@ +{ + "title": "NetworkTapRules_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Resync.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Resync.json new file mode 100644 index 000000000000..700cdeda9234 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTapRules_Resync_MaximumSet_Gen", + "operationId": "NetworkTapRules_Resync", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Update.json new file mode 100644 index 000000000000..05e0f9fb0031 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_Update.json @@ -0,0 +1,225 @@ +{ + "title": "NetworkTapRules_Update_MaximumSet_Gen", + "operationId": "NetworkTapRules_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/amdsdx", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_UpdateAdministrativeState.json new file mode 100644 index 000000000000..a6ef36b88911 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkTapRules_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTapRules_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ValidateConfiguration.json new file mode 100644 index 000000000000..281321d62333 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTapRules_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkTapRules_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkTapRules_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Create.json new file mode 100644 index 000000000000..5642fb074109 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Create.json @@ -0,0 +1,125 @@ +{ + "title": "NetworkTaps_Create_MaximumSet_Gen", + "operationId": "NetworkTaps_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "resource": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Delete.json new file mode 100644 index 000000000000..68045cbc4ade --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTaps_Delete_MaximumSet_Gen", + "operationId": "NetworkTaps_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Get.json new file mode 100644 index 000000000000..287179c06ac5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Get.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkTaps_Get_MaximumSet_Gen", + "operationId": "NetworkTaps_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_ListByResourceGroup.json new file mode 100644 index 000000000000..b13b23d36099 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_ListByResourceGroup.json @@ -0,0 +1,58 @@ +{ + "title": "NetworkTaps_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTaps_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_ListBySubscription.json new file mode 100644 index 000000000000..6dc9c84c98db --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_ListBySubscription.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkTaps_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTaps_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Resync.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Resync.json new file mode 100644 index 000000000000..3d231062a446 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTaps_Resync_MaximumSet_Gen", + "operationId": "NetworkTaps_Resync", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Update.json new file mode 100644 index 000000000000..d915ef60c312 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_Update.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkTaps_Update_MaximumSet_Gen", + "operationId": "NetworkTaps_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation1", + "pollingType": "Pull", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_UpdateAdministrativeState.json new file mode 100644 index 000000000000..c06540817af3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkTaps_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkTaps_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTaps_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Create.json new file mode 100644 index 000000000000..0305f288a174 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Create.json @@ -0,0 +1,211 @@ +{ + "title": "NetworkToNetworkInterconnects_Create_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "resource": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Delete.json new file mode 100644 index 000000000000..454a58faf0c3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkToNetworkInterconnects_Delete_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Get.json new file mode 100644 index 000000000000..0e26b026c3ad --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Get.json @@ -0,0 +1,84 @@ +{ + "title": "NetworkToNetworkInterconnects_Get_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json new file mode 100644 index 000000000000..ec5ecac1f7d9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json @@ -0,0 +1,88 @@ +{ + "title": "NetworkToNetworkInterconnects_ListByNetworkFabric_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_ListByNetworkFabric", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Update.json new file mode 100644 index 000000000000..c202ce3d7f5e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_Update.json @@ -0,0 +1,139 @@ +{ + "title": "NetworkToNetworkInterconnects_Update_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "properties": { + "properties": { + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "20.0.0.12/29", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.14/29", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 2345, + "vlanId": 1235 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17 + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json new file mode 100644 index 000000000000..366039ba84bf --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json new file mode 100644 index 000000000000..e68765388922 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/Operations_List.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/Operations_List.json new file mode 100644 index 000000000000..e752db72760e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/Operations_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-02-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Read", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Gets/List NetworkFabricController resources.", + "description": "Gets/List the NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Write", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Create or Update NetworkFabricController resource.", + "description": "Create or Update NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Delete", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Deletes the NetworkFabricController resource.", + "description": "Deletes the NetworkFabricController resource." + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen" +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_CommitConfiguration.json new file mode 100644 index 000000000000..c0abcc368cc3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "RoutePolicies_CommitConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_CommitConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Create.json new file mode 100644 index 000000000000..7692fa8cec05 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Create.json @@ -0,0 +1,246 @@ +{ + "title": "RoutePolicies_Create_MaximumSet_Gen", + "operationId": "RoutePolicies_Create", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "resource": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Delete.json new file mode 100644 index 000000000000..394c5799f5e2 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RoutePolicies_Delete_MaximumSet_Gen", + "operationId": "RoutePolicies_Delete", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Get.json new file mode 100644 index 000000000000..d2be66d5fc46 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Get.json @@ -0,0 +1,94 @@ +{ + "title": "RoutePolicies_Get_MaximumSet_Gen", + "operationId": "RoutePolicies_Get", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..c389e077a3aa --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ListByResourceGroup.json @@ -0,0 +1,98 @@ +{ + "title": "RoutePolicies_ListByResourceGroup_MaximumSet_Gen", + "operationId": "RoutePolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ListBySubscription.json new file mode 100644 index 000000000000..a7f47a51dae4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ListBySubscription.json @@ -0,0 +1,97 @@ +{ + "title": "RoutePolicies_ListBySubscription_MaximumSet_Gen", + "operationId": "RoutePolicies_ListBySubscription", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Update.json new file mode 100644 index 000000000000..210aabe13601 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_Update.json @@ -0,0 +1,161 @@ +{ + "title": "RoutePolicies_Update_MaximumSet_Gen", + "operationId": "RoutePolicies_Update", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_UpdateAdministrativeState.json new file mode 100644 index 000000000000..9bb4b8110cef --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "RoutePolicies_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "RoutePolicies_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ValidateConfiguration.json new file mode 100644 index 000000000000..fa11d7b11a20 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/examples/RoutePolicies_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "RoutePolicies_ValidateConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_ValidateConfiguration", + "parameters": { + "api-version": "2024-02-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/managednetworkfabric.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/managednetworkfabric.json new file mode 100644 index 000000000000..341989b9acc1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/managednetworkfabric.json @@ -0,0 +1,18499 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Network Fabric Management Service API", + "version": "2024-02-15-preview", + "description": "Self service experience for Azure Network Fabric API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AccessControlLists" + }, + { + "name": "InternetGatewayRules" + }, + { + "name": "InternetGateways" + }, + { + "name": "IpCommunities" + }, + { + "name": "IpExtendedCommunities" + }, + { + "name": "IpPrefixes" + }, + { + "name": "L2IsolationDomains" + }, + { + "name": "L3IsolationDomains" + }, + { + "name": "InternalNetworks" + }, + { + "name": "ExternalNetworks" + }, + { + "name": "NeighborGroups" + }, + { + "name": "NetworkDeviceSkus" + }, + { + "name": "NetworkDevices" + }, + { + "name": "NetworkInterfaces" + }, + { + "name": "NetworkFabricControllers" + }, + { + "name": "NetworkFabricSkus" + }, + { + "name": "NetworkFabrics" + }, + { + "name": "NetworkToNetworkInterconnects" + }, + { + "name": "NetworkPacketBrokers" + }, + { + "name": "NetworkRacks" + }, + { + "name": "NetworkTapRules" + }, + { + "name": "NetworkTaps" + }, + { + "name": "RoutePolicies" + } + ], + "paths": { + "/providers/Microsoft.ManagedNetworkFabric/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/accessControlLists": { + "get": { + "operationId": "AccessControlLists_ListBySubscription", + "tags": [ + "AccessControlLists" + ], + "description": "Implements AccessControlLists list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlListListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules": { + "get": { + "operationId": "InternetGatewayRules_ListBySubscription", + "tags": [ + "InternetGatewayRules" + ], + "description": "List all Internet Gateway rules in the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/internetGateways": { + "get": { + "operationId": "InternetGateways_ListBySubscription", + "tags": [ + "InternetGateways" + ], + "description": "Displays Internet Gateways list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipCommunities": { + "get": { + "operationId": "IpCommunities_ListBySubscription", + "tags": [ + "IpCommunities" + ], + "description": "Implements IP Communities list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities": { + "get": { + "operationId": "IpExtendedCommunities_ListBySubscription", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IpExtendedCommunities list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes": { + "get": { + "operationId": "IpPrefixes_ListBySubscription", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IpPrefixes list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefixListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains": { + "get": { + "operationId": "L2IsolationDomains_ListBySubscription", + "tags": [ + "L2IsolationDomains" + ], + "description": "Displays L2IsolationDomains list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains": { + "get": { + "operationId": "L3IsolationDomains_ListBySubscription", + "tags": [ + "L3IsolationDomains" + ], + "description": "Displays L3IsolationDomains list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/neighborGroups": { + "get": { + "operationId": "NeighborGroups_ListBySubscription", + "tags": [ + "NeighborGroups" + ], + "description": "Displays NeighborGroups list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus": { + "get": { + "operationId": "NetworkDeviceSkus_ListBySubscription", + "tags": [ + "NetworkDeviceSkus" + ], + "description": "List Network Device SKUs for the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDeviceSkus_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkDeviceSkus_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/{networkDeviceSkuName}": { + "get": { + "operationId": "NetworkDeviceSkus_Get", + "tags": [ + "NetworkDeviceSkus" + ], + "description": "Get a Network Device SKU details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "networkDeviceSkuName", + "in": "path", + "description": "Name of the Network Device SKU.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceSku" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDeviceSkus_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkDeviceSkus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDevices": { + "get": { + "operationId": "NetworkDevices_ListBySubscription", + "tags": [ + "NetworkDevices" + ], + "description": "List all the Network Device resources in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers": { + "get": { + "operationId": "NetworkFabricControllers_ListBySubscription", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Lists all the NetworkFabricControllers by subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricControllerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus": { + "get": { + "operationId": "NetworkFabricSkus_ListBySubscription", + "tags": [ + "NetworkFabricSkus" + ], + "description": "Implements Network Fabric SKUs list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricSkus_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricSkus_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/{networkFabricSkuName}": { + "get": { + "operationId": "NetworkFabricSkus_Get", + "tags": [ + "NetworkFabricSkus" + ], + "description": "Implements Network Fabric SKU GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "networkFabricSkuName", + "in": "path", + "description": "Name of the Network Fabric SKU.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricSku" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricSkus_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricSkus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabrics": { + "get": { + "operationId": "NetworkFabrics_ListBySubscription", + "tags": [ + "NetworkFabrics" + ], + "description": "List all the Network Fabric resources in the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers": { + "get": { + "operationId": "NetworkPacketBrokers_ListBySubscription", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Displays Network Packet Brokers list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBrokerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkRacks": { + "get": { + "operationId": "NetworkRacks_ListBySubscription", + "tags": [ + "NetworkRacks" + ], + "description": "List all Network Rack resources in the given subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRackListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkTapRules": { + "get": { + "operationId": "NetworkTapRules_ListBySubscription", + "tags": [ + "NetworkTapRules" + ], + "description": "List all the Network Tap Rule resources in the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkTaps": { + "get": { + "operationId": "NetworkTaps_ListBySubscription", + "tags": [ + "NetworkTaps" + ], + "description": "Displays Network Taps list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/routePolicies": { + "get": { + "operationId": "RoutePolicies_ListBySubscription", + "tags": [ + "RoutePolicies" + ], + "description": "Implements RoutePolicies list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists": { + "get": { + "operationId": "AccessControlLists_ListByResourceGroup", + "tags": [ + "AccessControlLists" + ], + "description": "Implements AccessControlLists list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlListListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}": { + "get": { + "operationId": "AccessControlLists_Get", + "tags": [ + "AccessControlLists" + ], + "description": "Implements Access Control List GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Get_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Get.json" + } + } + }, + "put": { + "operationId": "AccessControlLists_Create", + "tags": [ + "AccessControlLists" + ], + "description": "Implements Access Control List PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessControlList" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AccessControlList' update operation succeeded", + "schema": { + "$ref": "#/definitions/AccessControlList" + } + }, + "201": { + "description": "Resource 'AccessControlList' create operation succeeded", + "schema": { + "$ref": "#/definitions/AccessControlList" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Create_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AccessControlLists_Update", + "tags": [ + "AccessControlLists" + ], + "description": "API to update certain properties of the Access Control List resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Access Control List properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessControlListPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlList" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Update_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AccessControlLists_Delete", + "tags": [ + "AccessControlLists" + ], + "description": "Implements Access Control List DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Delete_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/resync": { + "post": { + "operationId": "AccessControlLists_Resync", + "tags": [ + "AccessControlLists" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Resync_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Resync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/updateAdministrativeState": { + "post": { + "operationId": "AccessControlLists_UpdateAdministrativeState", + "tags": [ + "AccessControlLists" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/validateConfiguration": { + "post": { + "operationId": "AccessControlLists_ValidateConfiguration", + "tags": [ + "AccessControlLists" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules": { + "get": { + "operationId": "InternetGatewayRules_ListByResourceGroup", + "tags": [ + "InternetGatewayRules" + ], + "description": "Implements Internet Gateway Rules list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/{internetGatewayRuleName}": { + "get": { + "operationId": "InternetGatewayRules_Get", + "tags": [ + "InternetGatewayRules" + ], + "description": "Gets an Internet Gateway Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Get_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Get.json" + } + } + }, + "put": { + "operationId": "InternetGatewayRules_Create", + "tags": [ + "InternetGatewayRules" + ], + "description": "Creates an Internet Gateway rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InternetGatewayRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "201": { + "description": "Resource 'InternetGatewayRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Create_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "InternetGatewayRules_Update", + "tags": [ + "InternetGatewayRules" + ], + "description": "API to update certain properties of the Internet Gateway Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Internet Gateway Rule properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGatewayRulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Update_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "InternetGatewayRules_Delete", + "tags": [ + "InternetGatewayRules" + ], + "description": "Implements Internet Gateway Rules DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways": { + "get": { + "operationId": "InternetGateways_ListByResourceGroup", + "tags": [ + "InternetGateways" + ], + "description": "Displays Internet Gateways list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways/{internetGatewayName}": { + "get": { + "operationId": "InternetGateways_Get", + "tags": [ + "InternetGateways" + ], + "description": "Implements Gateway GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGateway" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Get_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Get.json" + } + } + }, + "put": { + "operationId": "InternetGateways_Create", + "tags": [ + "InternetGateways" + ], + "description": "Creates a Network Fabric Service Internet Gateway resource instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGateway" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InternetGateway' update operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGateway" + } + }, + "201": { + "description": "Resource 'InternetGateway' create operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGateway" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Create_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "InternetGateways_Update", + "tags": [ + "InternetGateways" + ], + "description": "Execute patch on Network Fabric Service Internet Gateway.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "API to update certain properties of the InternetGateway resource..", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGatewayPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGateway" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Update_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "InternetGateways_Delete", + "tags": [ + "InternetGateways" + ], + "description": "Execute a delete on Network Fabric Service Internet Gateway.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Delete_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities": { + "get": { + "operationId": "IpCommunities_ListByResourceGroup", + "tags": [ + "IpCommunities" + ], + "description": "Implements IP Communities list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}": { + "get": { + "operationId": "IpCommunities_Get", + "tags": [ + "IpCommunities" + ], + "description": "Implements an IP Community GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Get_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Get.json" + } + } + }, + "put": { + "operationId": "IpCommunities_Create", + "tags": [ + "IpCommunities" + ], + "description": "Implements an IP Community PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/IpCommunity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IpCommunity' update operation succeeded", + "schema": { + "$ref": "#/definitions/IpCommunity" + } + }, + "201": { + "description": "Resource 'IpCommunity' create operation succeeded", + "schema": { + "$ref": "#/definitions/IpCommunity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Create_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IpCommunities_Update", + "tags": [ + "IpCommunities" + ], + "description": "API to update certain properties of the IP Community resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "IP Community properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/IpCommunityPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunity" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Update_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IpCommunities_Delete", + "tags": [ + "IpCommunities" + ], + "description": "Implements IP Community DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Delete_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities": { + "get": { + "operationId": "IpExtendedCommunities_ListByResourceGroup", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IpExtendedCommunities list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}": { + "get": { + "operationId": "IpExtendedCommunities_Get", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IP Extended Community GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Get_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Get.json" + } + } + }, + "put": { + "operationId": "IpExtendedCommunities_Create", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IP Extended Community PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IpExtendedCommunity' update operation succeeded", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "201": { + "description": "Resource 'IpExtendedCommunity' create operation succeeded", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Create_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IpExtendedCommunities_Update", + "tags": [ + "IpExtendedCommunities" + ], + "description": "API to update certain properties of the IP Extended Community resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "IP Extended Community properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/IpExtendedCommunityPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Update_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IpExtendedCommunities_Delete", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IP Extended Community DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Delete_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes": { + "get": { + "operationId": "IpPrefixes_ListByResourceGroup", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IpPrefixes list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefixListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}": { + "get": { + "operationId": "IpPrefixes_Get", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IP Prefix GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefix" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Get_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Get.json" + } + } + }, + "put": { + "operationId": "IpPrefixes_Create", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IP Prefix PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/IpPrefix" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IpPrefix' update operation succeeded", + "schema": { + "$ref": "#/definitions/IpPrefix" + } + }, + "201": { + "description": "Resource 'IpPrefix' create operation succeeded", + "schema": { + "$ref": "#/definitions/IpPrefix" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Create_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IpPrefixes_Update", + "tags": [ + "IpPrefixes" + ], + "description": "API to update certain properties of the IP Prefix resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "IP Prefix properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/IpPrefixPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefix" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Update_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IpPrefixes_Delete", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IP Prefix DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Delete_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains": { + "get": { + "operationId": "L2IsolationDomains_ListByResourceGroup", + "tags": [ + "L2IsolationDomains" + ], + "description": "Displays L2IsolationDomains list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}": { + "get": { + "operationId": "L2IsolationDomains_Get", + "tags": [ + "L2IsolationDomains" + ], + "description": "Implements L2 Isolation Domain GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Get_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Get.json" + } + } + }, + "put": { + "operationId": "L2IsolationDomains_Create", + "tags": [ + "L2IsolationDomains" + ], + "description": "Creates layer 2 network connectivity between compute nodes within a rack and across racks.The configuration is applied on the devices only after the isolation domain is enabled.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + } + ], + "responses": { + "200": { + "description": "Resource 'L2IsolationDomain' update operation succeeded", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "201": { + "description": "Resource 'L2IsolationDomain' create operation succeeded", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Create_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "L2IsolationDomains_Update", + "tags": [ + "L2IsolationDomains" + ], + "description": "API to update certain properties of the L2 Isolation Domain resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "API to update certain properties of the L2 Isolation Domain resource..", + "required": true, + "schema": { + "$ref": "#/definitions/L2IsolationDomainPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Update_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "L2IsolationDomains_Delete", + "tags": [ + "L2IsolationDomains" + ], + "description": "Deletes layer 2 connectivity between compute nodes by managed by named L2 Isolation name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Delete_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/commitConfiguration": { + "post": { + "operationId": "L2IsolationDomains_CommitConfiguration", + "tags": [ + "L2IsolationDomains" + ], + "description": "Commits the configuration of the given resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/updateAdministrativeState": { + "post": { + "operationId": "L2IsolationDomains_UpdateAdministrativeState", + "tags": [ + "L2IsolationDomains" + ], + "description": "Enables isolation domain across the fabric or on specified racks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/validateConfiguration": { + "post": { + "operationId": "L2IsolationDomains_ValidateConfiguration", + "tags": [ + "L2IsolationDomains" + ], + "description": "Validates the configuration of the resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains": { + "get": { + "operationId": "L3IsolationDomains_ListByResourceGroup", + "tags": [ + "L3IsolationDomains" + ], + "description": "Displays L3IsolationDomains list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}": { + "get": { + "operationId": "L3IsolationDomains_Get", + "tags": [ + "L3IsolationDomains" + ], + "description": "Retrieves details of this L3 Isolation Domain.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Get_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Get.json" + } + } + }, + "put": { + "operationId": "L3IsolationDomains_Create", + "tags": [ + "L3IsolationDomains" + ], + "description": "Create isolation domain resources for layer 3 connectivity between compute nodes and for communication with external services .This configuration is applied on the devices only after the creation of networks is completed and isolation domain is enabled.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + } + ], + "responses": { + "200": { + "description": "Resource 'L3IsolationDomain' update operation succeeded", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "201": { + "description": "Resource 'L3IsolationDomain' create operation succeeded", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Create_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "L3IsolationDomains_Update", + "tags": [ + "L3IsolationDomains" + ], + "description": "API to update certain properties of the L3 Isolation Domain resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "API to update certain properties of the L3 Isolation Domain resource.", + "required": true, + "schema": { + "$ref": "#/definitions/L3IsolationDomainPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Update_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "L3IsolationDomains_Delete", + "tags": [ + "L3IsolationDomains" + ], + "description": "Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Delete_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/commitConfiguration": { + "post": { + "operationId": "L3IsolationDomains_CommitConfiguration", + "tags": [ + "L3IsolationDomains" + ], + "description": "Commits the configuration of the given resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks": { + "get": { + "operationId": "ExternalNetworks_ListByL3IsolationDomain", + "tags": [ + "ExternalNetworks" + ], + "description": "Implements External Networks list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_ListByL3IsolationDomain.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}": { + "get": { + "operationId": "ExternalNetworks_Get", + "tags": [ + "ExternalNetworks" + ], + "description": "Implements ExternalNetworks GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Get_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "ExternalNetworks_Create", + "tags": [ + "ExternalNetworks" + ], + "description": "Creates ExternalNetwork PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ExternalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "201": { + "description": "Resource 'ExternalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Create_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ExternalNetworks_Update", + "tags": [ + "ExternalNetworks" + ], + "description": "API to update certain properties of the ExternalNetworks resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "ExternalNetwork properties to update. Only annotations are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalNetworkPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Update_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ExternalNetworks_Delete", + "tags": [ + "ExternalNetworks" + ], + "description": "Implements ExternalNetworks DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Delete_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}/updateAdministrativeState": { + "post": { + "operationId": "ExternalNetworks_UpdateAdministrativeState", + "tags": [ + "ExternalNetworks" + ], + "description": "Executes update operation to enable or disable administrative State for externalNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}/updateStaticRouteBfdAdministrativeState": { + "post": { + "operationId": "ExternalNetworks_UpdateStaticRouteBfdAdministrativeState", + "tags": [ + "ExternalNetworks" + ], + "description": "Update Static Route BFD for external Network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_UpdateStaticRouteBfdAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_UpdateStaticRouteBfdAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks": { + "get": { + "operationId": "InternalNetworks_ListByL3IsolationDomain", + "tags": [ + "InternalNetworks" + ], + "description": "Displays InternalNetworks list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_ListByL3IsolationDomain.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}": { + "get": { + "operationId": "InternalNetworks_Get", + "tags": [ + "InternalNetworks" + ], + "description": "Gets a InternalNetworks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Get_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "InternalNetworks_Create", + "tags": [ + "InternalNetworks" + ], + "description": "Creates InternalNetwork PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InternalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "201": { + "description": "Resource 'InternalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/InternalNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Create_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "InternalNetworks_Update", + "tags": [ + "InternalNetworks" + ], + "description": "Updates a InternalNetworks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "InternalNetwork properties to update. Only annotations are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/InternalNetworkPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Update_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "InternalNetworks_Delete", + "tags": [ + "InternalNetworks" + ], + "description": "Implements InternalNetworks DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Delete_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateAdministrativeState": { + "post": { + "operationId": "InternalNetworks_UpdateAdministrativeState", + "tags": [ + "InternalNetworks" + ], + "description": "Update Administrative state of InternalNetworks on resources referred by their resource ids.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateBgpAdministrativeState": { + "post": { + "operationId": "InternalNetworks_UpdateBgpAdministrativeState", + "tags": [ + "InternalNetworks" + ], + "description": "Update BGP state for internalNetwork. Allowed only on edge devices.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_UpdateBgpAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_UpdateBgpAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateStaticRouteBfdAdministrativeState": { + "post": { + "operationId": "InternalNetworks_UpdateStaticRouteBfdAdministrativeState", + "tags": [ + "InternalNetworks" + ], + "description": "Update Static Route BFD administrative state for internalNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_UpdateStaticRouteBfdAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_UpdateStaticRouteBfdAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/updateAdministrativeState": { + "post": { + "operationId": "L3IsolationDomains_UpdateAdministrativeState", + "tags": [ + "L3IsolationDomains" + ], + "description": "Enables racks for this Isolation Domain.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/validateConfiguration": { + "post": { + "operationId": "L3IsolationDomains_ValidateConfiguration", + "tags": [ + "L3IsolationDomains" + ], + "description": "Validates the configuration of the resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups": { + "get": { + "operationId": "NeighborGroups_ListByResourceGroup", + "tags": [ + "NeighborGroups" + ], + "description": "Displays NeighborGroups list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}": { + "get": { + "operationId": "NeighborGroups_Get", + "tags": [ + "NeighborGroups" + ], + "description": "Gets the Neighbor Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Get_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Get.json" + } + } + }, + "put": { + "operationId": "NeighborGroups_Create", + "tags": [ + "NeighborGroups" + ], + "description": "Implements the Neighbor Group PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NeighborGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "201": { + "description": "Resource 'NeighborGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NeighborGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Create_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NeighborGroups_Update", + "tags": [ + "NeighborGroups" + ], + "description": "Updates the Neighbor Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Neighbor Group properties to update. Only annotations are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/NeighborGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Update_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NeighborGroups_Delete", + "tags": [ + "NeighborGroups" + ], + "description": "Implements Neighbor Group DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Delete_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices": { + "get": { + "operationId": "NetworkDevices_ListByResourceGroup", + "tags": [ + "NetworkDevices" + ], + "description": "List all the Network Device resources in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}": { + "get": { + "operationId": "NetworkDevices_Get", + "tags": [ + "NetworkDevices" + ], + "description": "Gets the Network Device resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Get.json" + } + } + }, + "put": { + "operationId": "NetworkDevices_Create", + "tags": [ + "NetworkDevices" + ], + "description": "Create a Network Device resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkDevice' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "201": { + "description": "Resource 'NetworkDevice' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkDevice" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkDevices_Update", + "tags": [ + "NetworkDevices" + ], + "description": "Update certain properties of the Network Device resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Device properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkDevicePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkDevices_Delete", + "tags": [ + "NetworkDevices" + ], + "description": "Delete the Network Device resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListByNetworkDevice", + "tags": [ + "NetworkInterfaces" + ], + "description": "List all the Network Interface resources in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_ListByNetworkDevice_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_ListByNetworkDevice.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}": { + "get": { + "operationId": "NetworkInterfaces_Get", + "tags": [ + "NetworkInterfaces" + ], + "description": "Get the Network Interface resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "NetworkInterfaces_Create", + "tags": [ + "NetworkInterfaces" + ], + "description": "Create a Network Interface resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "201": { + "description": "Resource 'NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkInterfaces_Update", + "tags": [ + "NetworkInterfaces" + ], + "description": "Update certain properties of the Network Interface resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "NetworkInterface properties to update. Only tags are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfacePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkInterfaces_Delete", + "tags": [ + "NetworkInterfaces" + ], + "description": "Delete the Network Interface resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkInterfaces_UpdateAdministrativeState", + "tags": [ + "NetworkInterfaces" + ], + "description": "Update the admin state of the Network Interface.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/reboot": { + "post": { + "operationId": "NetworkDevices_Reboot", + "tags": [ + "NetworkDevices" + ], + "description": "Reboot the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/RebootProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Reboot_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Reboot.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/refreshConfiguration": { + "post": { + "operationId": "NetworkDevices_RefreshConfiguration", + "tags": [ + "NetworkDevices" + ], + "description": "Refreshes the configuration the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_RefreshConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_RefreshConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/runRoCommand": { + "post": { + "operationId": "NetworkDevices_RunRoCommand", + "tags": [ + "NetworkDevices" + ], + "description": "Run the RO Command on the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request the command.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceRoCommand" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceROCommands" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_RunRoCommand_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_RunRoCommand.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/runRwCommand": { + "post": { + "operationId": "NetworkDevices_RunRwCommand", + "tags": [ + "NetworkDevices" + ], + "description": "Run the RW Command on the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request the command.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceRwCommand" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceRWCommands" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_RunRwCommand_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_RunRwCommand.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkDevices_UpdateAdministrativeState", + "tags": [ + "NetworkDevices" + ], + "description": "Updates the Administrative state of the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateDeviceAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/upgrade": { + "post": { + "operationId": "NetworkDevices_Upgrade", + "tags": [ + "NetworkDevices" + ], + "description": "Upgrades the version of the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVersion" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Upgrade_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Upgrade.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers": { + "get": { + "operationId": "NetworkFabricControllers_ListByResourceGroup", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Lists all the NetworkFabricControllers thats available in the resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricControllerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/{networkFabricControllerName}": { + "get": { + "operationId": "NetworkFabricControllers_Get", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Shows the provisioning status of Network Fabric Controller.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFabricControllers_Create", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Creates a Network Fabric Controller.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFabricController' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "201": { + "description": "Resource 'NetworkFabricController' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFabricControllers_Update", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Updates are currently not supported for the Network Fabric Controller resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Fabric Controller properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricControllerPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFabricControllers_Delete", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Deletes the Network Fabric Controller resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics": { + "get": { + "operationId": "NetworkFabrics_ListByResourceGroup", + "tags": [ + "NetworkFabrics" + ], + "description": "List all the Network Fabric resources in the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}": { + "get": { + "operationId": "NetworkFabrics_Get", + "tags": [ + "NetworkFabrics" + ], + "description": "Get Network Fabric resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFabrics_Create", + "tags": [ + "NetworkFabrics" + ], + "description": "Create Network Fabric resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFabric' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "201": { + "description": "Resource 'NetworkFabric' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabric" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFabrics_Update", + "tags": [ + "NetworkFabrics" + ], + "description": "Update certain properties of the Network Fabric resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Fabric properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFabrics_Delete", + "tags": [ + "NetworkFabrics" + ], + "description": "Delete Network Fabric resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/commitConfiguration": { + "post": { + "operationId": "NetworkFabrics_CommitConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/deprovision": { + "post": { + "operationId": "NetworkFabrics_Deprovision", + "tags": [ + "NetworkFabrics" + ], + "description": "Deprovisions the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Deprovision_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Deprovision.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/getTopology": { + "post": { + "operationId": "NetworkFabrics_GetTopology", + "tags": [ + "NetworkFabrics" + ], + "description": "Gets Topology of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_GetTopology_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_GetTopology.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects": { + "get": { + "operationId": "NetworkToNetworkInterconnects_ListByNetworkFabric", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Implements Network To Network Interconnects list by Network Fabric GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_ListByNetworkFabric_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}": { + "get": { + "operationId": "NetworkToNetworkInterconnects_Get", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Implements NetworkToNetworkInterconnects GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Get.json" + } + } + }, + "put": { + "operationId": "NetworkToNetworkInterconnects_Create", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Configuration used to setup CE-PE connectivity PUT Method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkToNetworkInterconnect' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "201": { + "description": "Resource 'NetworkToNetworkInterconnect' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkToNetworkInterconnects_Update", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Update certain properties of the Network To NetworkInterconnects resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network to Network Interconnect properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnectPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkToNetworkInterconnects_Delete", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Implements NetworkToNetworkInterconnects DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkToNetworkInterconnects_UpdateAdministrativeState", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Updates the Admin State.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}/updateNpbStaticRouteBfdAdministrativeState": { + "post": { + "operationId": "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Updates the NPB Static Route BFD Administrative State.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/provision": { + "post": { + "operationId": "NetworkFabrics_Provision", + "tags": [ + "NetworkFabrics" + ], + "description": "Provisions the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Provision_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Provision.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/refreshConfiguration": { + "post": { + "operationId": "NetworkFabrics_RefreshConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Refreshes the configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_RefreshConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_RefreshConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/updateInfraManagementBfdConfiguration": { + "post": { + "operationId": "NetworkFabrics_UpdateInfraManagementBfdConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_UpdateInfraManagementBfdConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/updateWorkloadManagementBfdConfiguration": { + "post": { + "operationId": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/upgrade": { + "post": { + "operationId": "NetworkFabrics_Upgrade", + "tags": [ + "NetworkFabrics" + ], + "description": "Upgrades the version of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Network Fabric properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/UpgradeNetworkFabricProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Upgrade_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Upgrade.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/validateConfiguration": { + "post": { + "operationId": "NetworkFabrics_ValidateConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Validates the configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Validate configuration properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateConfigurationProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers": { + "get": { + "operationId": "NetworkPacketBrokers_ListByResourceGroup", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Displays NetworkPacketBrokers list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBrokerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/{networkPacketBrokerName}": { + "get": { + "operationId": "NetworkPacketBrokers_Get", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Retrieves details of this Network Packet Broker.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Get.json" + } + } + }, + "put": { + "operationId": "NetworkPacketBrokers_Create", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Creates a Network Packet Broker.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkPacketBroker' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "201": { + "description": "Resource 'NetworkPacketBroker' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkPacketBrokers_Update", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "API to update certain properties of the Network Packet Broker resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Packet Broker properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkPacketBrokerPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkPacketBrokers_Delete", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Deletes Network Packet Broker.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks": { + "get": { + "operationId": "NetworkRacks_ListByResourceGroup", + "tags": [ + "NetworkRacks" + ], + "description": "List all Network Rack resources in the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRackListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks/{networkRackName}": { + "get": { + "operationId": "NetworkRacks_Get", + "tags": [ + "NetworkRacks" + ], + "description": "Get Network Rack resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRack" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Get.json" + } + } + }, + "put": { + "operationId": "NetworkRacks_Create", + "tags": [ + "NetworkRacks" + ], + "description": "Create Network Rack resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRack" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkRack' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkRack" + } + }, + "201": { + "description": "Resource 'NetworkRack' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkRack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkRacks_Update", + "tags": [ + "NetworkRacks" + ], + "description": "Update certain properties of the Network Rack resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Rack properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRackPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRack" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkRacks_Delete", + "tags": [ + "NetworkRacks" + ], + "description": "Delete Network Rack resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules": { + "get": { + "operationId": "NetworkTapRules_ListByResourceGroup", + "tags": [ + "NetworkTapRules" + ], + "description": "List all the Network Tap Rule resources in the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}": { + "get": { + "operationId": "NetworkTapRules_Get", + "tags": [ + "NetworkTapRules" + ], + "description": "Get Network Tap Rule resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Get.json" + } + } + }, + "put": { + "operationId": "NetworkTapRules_Create", + "tags": [ + "NetworkTapRules" + ], + "description": "Create Network Tap Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkTapRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "201": { + "description": "Resource 'NetworkTapRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkTapRules_Update", + "tags": [ + "NetworkTapRules" + ], + "description": "Update certain properties of the Network Tap Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Tap Rule properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTapRulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkTapRules_Delete", + "tags": [ + "NetworkTapRules" + ], + "description": "Delete Network Tap Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/resync": { + "post": { + "operationId": "NetworkTapRules_Resync", + "tags": [ + "NetworkTapRules" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Resync_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Resync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkTapRules_UpdateAdministrativeState", + "tags": [ + "NetworkTapRules" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/validateConfiguration": { + "post": { + "operationId": "NetworkTapRules_ValidateConfiguration", + "tags": [ + "NetworkTapRules" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps": { + "get": { + "operationId": "NetworkTaps_ListByResourceGroup", + "tags": [ + "NetworkTaps" + ], + "description": "Displays Network Taps list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}": { + "get": { + "operationId": "NetworkTaps_Get", + "tags": [ + "NetworkTaps" + ], + "description": "Retrieves details of this Network Tap.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTap" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Get.json" + } + } + }, + "put": { + "operationId": "NetworkTaps_Create", + "tags": [ + "NetworkTaps" + ], + "description": "Creates a Network Tap.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTap" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkTap' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTap" + } + }, + "201": { + "description": "Resource 'NetworkTap' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTap" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkTaps_Update", + "tags": [ + "NetworkTaps" + ], + "description": "API to update certain properties of the Network Tap resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Tap properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTapPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTap" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkTaps_Delete", + "tags": [ + "NetworkTaps" + ], + "description": "Deletes Network Tap.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}/resync": { + "post": { + "operationId": "NetworkTaps_Resync", + "tags": [ + "NetworkTaps" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Resync_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Resync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkTaps_UpdateAdministrativeState", + "tags": [ + "NetworkTaps" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies": { + "get": { + "operationId": "RoutePolicies_ListByResourceGroup", + "tags": [ + "RoutePolicies" + ], + "description": "Implements RoutePolicies list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}": { + "get": { + "operationId": "RoutePolicies_Get", + "tags": [ + "RoutePolicies" + ], + "description": "Implements Route Policy GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Get_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Get.json" + } + } + }, + "put": { + "operationId": "RoutePolicies_Create", + "tags": [ + "RoutePolicies" + ], + "description": "Implements Route Policy PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RoutePolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "201": { + "description": "Resource 'RoutePolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/RoutePolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Create_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RoutePolicies_Update", + "tags": [ + "RoutePolicies" + ], + "description": "API to update certain properties of the Route Policy resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Route Policy properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/RoutePolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Update_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RoutePolicies_Delete", + "tags": [ + "RoutePolicies" + ], + "description": "Implements Route Policy DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Delete_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/commitConfiguration": { + "post": { + "operationId": "RoutePolicies_CommitConfiguration", + "tags": [ + "RoutePolicies" + ], + "description": "Commits the configuration of the given resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/updateAdministrativeState": { + "post": { + "operationId": "RoutePolicies_UpdateAdministrativeState", + "tags": [ + "RoutePolicies" + ], + "description": "Updated the admin state for this Route Policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/validateConfiguration": { + "post": { + "operationId": "RoutePolicies_ValidateConfiguration", + "tags": [ + "RoutePolicies" + ], + "description": "Validates the configuration of the resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessControlList": { + "type": "object", + "description": "The Access Control List resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/AccessControlListProperties", + "description": "The Access ControlList properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AccessControlListAction": { + "type": "object", + "description": "Action that need to performed.", + "properties": { + "type": { + "$ref": "#/definitions/AclActionType", + "description": "Type of actions that can be performed." + }, + "counterName": { + "type": "string", + "description": "Name of the counter block to get match count information.", + "minLength": 1 + } + } + }, + "AccessControlListActionPatch": { + "type": "object", + "description": "Action that need to be performed", + "properties": { + "type": { + "$ref": "#/definitions/AclActionType", + "description": "Type of actions that can be performed." + }, + "counterName": { + "type": "string", + "description": "Name of the counter block to get match count information.", + "minLength": 1 + } + } + }, + "AccessControlListListResult": { + "type": "object", + "description": "The response of a AccessControlList list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AccessControlList items on this page", + "items": { + "$ref": "#/definitions/AccessControlList" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccessControlListMatchCondition": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchCondition", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchCondition", + "description": "IP condition that needs to be matched." + }, + "etherTypes": { + "type": "array", + "description": "List of ether type values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "fragments": { + "type": "array", + "description": "List of IP fragment packets that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipLengths": { + "type": "array", + "description": "List of IP Lengths that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ttlValues": { + "type": "array", + "description": "List of TTL [Time To Live] values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "dscpMarkings": { + "type": "array", + "description": "List of DSCP Markings that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "portCondition": { + "$ref": "#/definitions/AccessControlListPortCondition", + "description": "Defines the port condition that needs to be matched." + } + } + }, + "AccessControlListMatchConditionPatch": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchConditionPatch", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchConditionPatch", + "description": "IP condition that needs to be matched." + }, + "etherTypes": { + "type": "array", + "description": "List of ether type values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "fragments": { + "type": "array", + "description": "List of IP fragment packets that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipLengths": { + "type": "array", + "description": "List of IP Lengths that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ttlValues": { + "type": "array", + "description": "List of TTL [Time To Live] values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "dscpMarkings": { + "type": "array", + "description": "List of DSCP Markings that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "portCondition": { + "$ref": "#/definitions/AccessControlListPortConditionPatch", + "description": "Defines the port condition that needs to be matched." + } + } + }, + "AccessControlListMatchConfiguration": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchCondition" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListAction" + }, + "x-ms-identifiers": [] + } + } + }, + "AccessControlListMatchConfigurationPatch": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchConditionPatch" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListActionPatch" + }, + "x-ms-identifiers": [] + } + } + }, + "AccessControlListPatch": { + "type": "object", + "description": "The Access Control Lists patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AccessControlListPatchProperties", + "description": "Access Control Lists patch properties." + } + } + }, + "AccessControlListPatchProperties": { + "type": "object", + "description": "Access Control Lists patch properties.", + "properties": { + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Access Control List." + }, + "aclsUrl": { + "type": "string", + "format": "uri", + "description": "Access Control List file URL." + }, + "defaultAction": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny." + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + }, + "annotation": { + "type": "string", + "description": "Switch configuration description." + } + } + }, + "AccessControlListPortCondition": { + "type": "object", + "description": "Defines the port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + }, + "flags": { + "type": "array", + "description": "List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg", + "items": { + "type": "string" + } + } + }, + "required": [ + "layer4Protocol" + ] + }, + "AccessControlListPortConditionPatch": { + "type": "object", + "description": "Defines the port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + }, + "flags": { + "type": "array", + "description": "List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg", + "items": { + "type": "string" + } + } + } + }, + "AccessControlListProperties": { + "type": "object", + "description": "Access Control List Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Access Control List." + }, + "aclsUrl": { + "type": "string", + "format": "uri", + "description": "Access Control List file URL." + }, + "defaultAction": { + "type": "string", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny.", + "default": "Permit", + "enum": [ + "Permit", + "Deny" + ], + "x-ms-enum": { + "name": "CommunityActionTypes", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Permit Community Action Types" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny Community Action Types" + } + ] + } + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "lastSyncedTime": { + "type": "string", + "format": "date-time", + "description": "The last synced timestamp.", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "configurationType" + ] + }, + "AclActionType": { + "type": "string", + "description": "Type of actions that can be performed.", + "enum": [ + "Drop", + "Count", + "Log" + ], + "x-ms-enum": { + "name": "AclActionType", + "modelAsString": true, + "values": [ + { + "name": "Drop", + "value": "Drop", + "description": "AclActionType Drop" + }, + { + "name": "Count", + "value": "Count", + "description": "AclActionType Count" + }, + { + "name": "Log", + "value": "Log", + "description": "AclActionType Log" + } + ] + } + }, + "Action": { + "type": "string", + "description": "Specify action.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Action Allow" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Action Deny" + } + ] + } + }, + "ActionIpCommunityPatchProperties": { + "type": "object", + "description": "IP Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "set": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + } + } + }, + "ActionIpCommunityProperties": { + "type": "object", + "description": "IP Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "set": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + } + } + }, + "ActionIpExtendedCommunityPatchProperties": { + "type": "object", + "description": "IP Extended Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "set": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + } + } + }, + "ActionIpExtendedCommunityProperties": { + "type": "object", + "description": "IP Extended Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "set": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + } + } + }, + "AdministrativeState": { + "type": "string", + "description": "State defined to represent administrative actions or post actions on a particular resource.", + "enum": [ + "Enabled", + "Disabled", + "MAT", + "RMA", + "UnderMaintenance" + ], + "x-ms-enum": { + "name": "AdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled Administrative State" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled Administrative State" + }, + { + "name": "MAT", + "value": "MAT", + "description": "MAT(Manual Action Taken) Administrative State" + }, + { + "name": "RMA", + "value": "RMA", + "description": "RMA(Return Material Authorization) Administrative State" + }, + { + "name": "UnderMaintenance", + "value": "UnderMaintenance", + "description": "UnderMaintenance Administrative State" + } + ] + } + }, + "AggregateRoute": { + "type": "object", + "description": "aggregateIpv4Route model.", + "properties": { + "prefix": { + "type": "string", + "description": "IPv4 Prefix of the aggregate Ipv4Route.", + "minLength": 1 + } + }, + "required": [ + "prefix" + ] + }, + "AggregateRouteConfiguration": { + "type": "object", + "description": "List of IPv4 and IPv6 aggregate routes.", + "properties": { + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Route prefixes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AggregateRoute" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of Ipv6Routes prefixes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AggregateRoute" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "AllowASOverride": { + "type": "string", + "description": "Enable Or Disable state.", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "AllowASOverride", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "AllowASOverride-Enable" + }, + { + "name": "Disable", + "value": "Disable", + "description": "AllowASOverride-Disable" + } + ] + } + }, + "BfdAdministrativeState": { + "type": "string", + "description": "Administrative state of the BfdConfiguration. Example: Enabled | Disabled.", + "enum": [ + "Enabled", + "Disabled", + "MAT", + "RMA" + ], + "x-ms-enum": { + "name": "BfdAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Represents the enabled state of BFD administrative state." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Represents the disabled state of BFD administrative state." + }, + { + "name": "MAT", + "value": "MAT", + "description": "Represents the MAT(Manual Action Taken) state of BFD administrative state." + }, + { + "name": "RMA", + "value": "RMA", + "description": "Represents the RMA(Return Material Authorization) state of BFD administrative state." + } + ] + } + }, + "BfdConfiguration": { + "type": "object", + "description": "BFD configuration properties", + "properties": { + "administrativeState": { + "type": "string", + "description": "Administrative state of the BfdConfiguration. Example: Enabled | Disabled.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled", + "MAT", + "RMA" + ], + "x-ms-enum": { + "name": "BfdAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Represents the enabled state of BFD administrative state." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Represents the disabled state of BFD administrative state." + }, + { + "name": "MAT", + "value": "MAT", + "description": "Represents the MAT(Manual Action Taken) state of BFD administrative state." + }, + { + "name": "RMA", + "value": "RMA", + "description": "Represents the RMA(Return Material Authorization) state of BFD administrative state." + } + ] + }, + "readOnly": true + }, + "intervalInMilliSeconds": { + "type": "integer", + "format": "int32", + "description": "Interval in milliseconds. Example: 300.", + "default": 300 + }, + "multiplier": { + "type": "integer", + "format": "int32", + "description": "Multiplier for the Bfd Configuration. Example: 5.", + "default": 5 + } + } + }, + "BfdPatchConfiguration": { + "type": "object", + "description": "BFD configuration properties", + "properties": { + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "Administrative state of the BfdConfiguration. Example: Enabled | Disabled.", + "readOnly": true + }, + "intervalInMilliSeconds": { + "type": "integer", + "format": "int32", + "description": "Interval in milliseconds. Example: 300." + }, + "multiplier": { + "type": "integer", + "format": "int32", + "description": "Multiplier for the Bfd Configuration. Example: 5." + } + } + }, + "BgpConfiguration": { + "type": "object", + "description": "BGP configuration properties", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "defaultRouteOriginate": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Originate a defaultRoute. Ex: \"True\" | \"False\"." + }, + "allowAS": { + "type": "integer", + "format": "int32", + "description": "Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2.", + "default": 2, + "minimum": 0, + "maximum": 10 + }, + "allowASOverride": { + "$ref": "#/definitions/AllowASOverride", + "description": "Enable Or Disable state." + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of Network Fabric. Example: 65048.", + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN. Example: 65047.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipv4ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv4 Listen Range prefixes.", + "items": { + "type": "string" + } + }, + "ipv6ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv6 Listen Ranges prefixes.", + "items": { + "type": "string" + } + }, + "ipv4NeighborAddress": { + "type": "array", + "description": "List with stringified IPv4 Neighbor Addresses.", + "items": { + "$ref": "#/definitions/NeighborAddress" + }, + "x-ms-identifiers": [ + "address" + ] + }, + "ipv6NeighborAddress": { + "type": "array", + "description": "List with stringified IPv6 Neighbor Address.", + "items": { + "$ref": "#/definitions/NeighborAddress" + }, + "x-ms-identifiers": [ + "address" + ] + } + }, + "required": [ + "peerASN" + ] + }, + "BgpPatchConfiguration": { + "type": "object", + "description": "BGP configuration properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "defaultRouteOriginate": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Originate a defaultRoute. Ex: \"True\" | \"False\"." + }, + "allowAS": { + "type": "integer", + "format": "int32", + "description": "Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2.", + "minimum": 0, + "maximum": 10 + }, + "allowASOverride": { + "$ref": "#/definitions/AllowASOverride", + "description": "Enable Or Disable state." + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of Network Fabric. Example: 65048.", + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN. Example: 65047.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipv4ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv4 Listen Range prefixes.", + "items": { + "type": "string" + } + }, + "ipv6ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv6 Listen Ranges prefixes.", + "items": { + "type": "string" + } + }, + "ipv4NeighborAddress": { + "type": "array", + "description": "List with stringified IPv4 Neighbor Addresses.", + "items": { + "$ref": "#/definitions/NeighborAddressPatch" + }, + "x-ms-identifiers": [ + "address" + ] + }, + "ipv6NeighborAddress": { + "type": "array", + "description": "List with stringified IPv6 Neighbor Address.", + "items": { + "$ref": "#/definitions/NeighborAddressPatch" + }, + "x-ms-identifiers": [ + "address" + ] + } + } + }, + "BooleanEnumProperty": { + "type": "string", + "description": "Boolean union. Example- True/False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "BooleanEnumProperty", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "EnumProperty-True" + }, + { + "name": "False", + "value": "False", + "description": "EnumProperty-False" + } + ] + } + }, + "CommonDynamicMatchConfiguration": { + "type": "object", + "description": "Dynamic match configuration object.", + "properties": { + "ipGroups": { + "type": "array", + "description": "List of IP Groups.", + "items": { + "$ref": "#/definitions/IpGroupProperties" + }, + "x-ms-identifiers": [] + }, + "vlanGroups": { + "type": "array", + "description": "List of vlan groups.", + "items": { + "$ref": "#/definitions/VlanGroupProperties" + }, + "x-ms-identifiers": [] + }, + "portGroups": { + "type": "array", + "description": "List of the port groups.", + "items": { + "$ref": "#/definitions/PortGroupProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "CommonDynamicMatchConfigurationPatch": { + "type": "object", + "description": "Dynamic match configuration object.", + "properties": { + "ipGroups": { + "type": "array", + "description": "List of IP Groups.", + "items": { + "$ref": "#/definitions/IpGroupPatchProperties" + }, + "x-ms-identifiers": [] + }, + "vlanGroups": { + "type": "array", + "description": "List of vlan groups.", + "items": { + "$ref": "#/definitions/VlanGroupPatchProperties" + }, + "x-ms-identifiers": [] + }, + "portGroups": { + "type": "array", + "description": "List of the port groups.", + "items": { + "$ref": "#/definitions/PortGroupPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "CommonPostActionResponseForDeviceROCommands": { + "type": "object", + "description": "Common response for device Ro Commands.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "outputUrl": { + "type": "string", + "description": "Predefined link containing Device RO Command output." + } + } + }, + "CommonPostActionResponseForDeviceRWCommands": { + "type": "object", + "description": "Common response for device Rw Commands.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "outputUrl": { + "type": "string", + "description": "Predefined link containing Device Rw Command output." + } + } + }, + "CommonPostActionResponseForDeviceUpdate": { + "type": "object", + "description": "Common response for device updates.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "successfulDevices": { + "type": "array", + "description": "List of ARM Resource IDs for which the given action applied successfully.", + "items": { + "type": "string" + } + }, + "failedDevices": { + "type": "array", + "description": "List of ARM Resource IDs for which the given action failed to apply.", + "items": { + "type": "string" + } + } + } + }, + "CommonPostActionResponseForStateUpdate": { + "type": "object", + "description": "Common response for the state updates.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + } + } + }, + "CommunityActionTypes": { + "type": "string", + "description": "Community action types. Example: Permit | Deny.", + "enum": [ + "Permit", + "Deny" + ], + "x-ms-enum": { + "name": "CommunityActionTypes", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Permit Community Action Types" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny Community Action Types" + } + ] + } + }, + "Condition": { + "type": "string", + "description": "Specify prefix-list bounds.", + "enum": [ + "EqualTo", + "GreaterThanOrEqualTo", + "LesserThanOrEqualTo", + "Range" + ], + "x-ms-enum": { + "name": "Condition", + "modelAsString": true, + "values": [ + { + "name": "EqualTo", + "value": "EqualTo", + "description": "Condition-EqualTo" + }, + { + "name": "GreaterThanOrEqualTo", + "value": "GreaterThanOrEqualTo", + "description": "Condition-GreaterThanOrEqualTo" + }, + { + "name": "LesserThanOrEqualTo", + "value": "LesserThanOrEqualTo", + "description": "Condition-LesserThanOrEqualTo" + }, + { + "name": "Range", + "value": "Range", + "description": "Condition-Range" + } + ] + } + }, + "ConfigurationState": { + "type": "string", + "description": "Configuration state for the resource.", + "enum": [ + "Succeeded", + "Failed", + "Rejected", + "Accepted", + "Provisioned", + "ErrorProvisioning", + "Deprovisioning", + "Deprovisioned", + "ErrorDeprovisioning", + "DeferredControl", + "Provisioning", + "PendingCommit" + ], + "x-ms-enum": { + "name": "ConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Success Configuration State" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Configuration State" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Rejected Configuration State" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Accepted Configuration State" + }, + { + "name": "Provisioned", + "value": "Provisioned", + "description": "Provisioned Configuration State" + }, + { + "name": "ErrorProvisioning", + "value": "ErrorProvisioning", + "description": "ErrorProvisioning Configuration State" + }, + { + "name": "Deprovisioning", + "value": "Deprovisioning", + "description": "Deprovisioning Configuration State" + }, + { + "name": "Deprovisioned", + "value": "Deprovisioned", + "description": "Deprovisioned Configuration State" + }, + { + "name": "ErrorDeprovisioning", + "value": "ErrorDeprovisioning", + "description": "ErrorDeprovisioning Configuration State" + }, + { + "name": "DeferredControl", + "value": "DeferredControl", + "description": "DeferredControl Configuration State" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning Configuration State" + }, + { + "name": "PendingCommit", + "value": "PendingCommit", + "description": "PendingCommit Configuration State" + } + ] + }, + "readOnly": true + }, + "ConfigurationType": { + "type": "string", + "description": "Input method to configure Access Control List.", + "enum": [ + "File", + "Inline" + ], + "x-ms-enum": { + "name": "ConfigurationType", + "modelAsString": true, + "values": [ + { + "name": "File", + "value": "File", + "description": "File Configuration Type" + }, + { + "name": "Inline", + "value": "Inline", + "description": "Inline Configuration Type" + } + ] + } + }, + "ConnectedSubnet": { + "type": "object", + "description": "Connected Subnet properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "prefix": { + "type": "string", + "description": "Prefix of the Connected Subnet.", + "minLength": 1 + } + }, + "required": [ + "prefix" + ] + }, + "ConnectedSubnetPatch": { + "type": "object", + "description": "Connected Subnet properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "prefix": { + "type": "string", + "description": "Prefix of the Connected Subnet.", + "minLength": 1 + } + }, + "required": [ + "prefix" + ] + }, + "ConnectedSubnetRoutePolicy": { + "type": "object", + "description": "Connected Subnet Route Policy properties.", + "properties": { + "exportRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Route Policy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportRoutePolicy": { + "$ref": "#/definitions/L3ExportRoutePolicy", + "description": "Array of ARM Resource ID of the RoutePolicies." + } + } + }, + "ControllerServices": { + "type": "object", + "description": "Network Fabric Controller services.", + "properties": { + "ipv4AddressSpaces": { + "type": "array", + "description": "The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute.", + "items": { + "type": "string" + } + }, + "ipv6AddressSpaces": { + "type": "array", + "description": "The IPv6 is not supported right now.", + "items": { + "type": "string" + } + } + } + }, + "DestinationPatchProperties": { + "type": "object", + "description": "The network tap destination properties.", + "properties": { + "name": { + "type": "string", + "description": "Destination name.", + "minLength": 1 + }, + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Type of destination. Input can be IsolationDomain or Direct." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "The destination Id. ARM Resource ID of either NNI or Internal Networks.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkToNetworkInterconnects" + }, + { + "type": "Microsoft.ManagedNetworkFabric/l3IsolationDomains/internalNetworks" + } + ] + } + }, + "isolationDomainProperties": { + "$ref": "#/definitions/IsolationDomainPatchProperties", + "description": "Isolation Domain Properties." + }, + "destinationTapRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of destination Tap Rule that contains match configurations.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + } + } + }, + "DestinationProperties": { + "type": "object", + "description": "The network tap destination properties.", + "properties": { + "name": { + "type": "string", + "description": "Destination name.", + "minLength": 1 + }, + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Type of destination. Input can be IsolationDomain or Direct." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "The destination Id. ARM Resource ID of either NNI or Internal Networks.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkToNetworkInterconnects" + }, + { + "type": "Microsoft.ManagedNetworkFabric/l3IsolationDomains/internalNetworks" + } + ] + } + }, + "isolationDomainProperties": { + "$ref": "#/definitions/IsolationDomainProperties", + "description": "Isolation Domain Properties." + }, + "destinationTapRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of destination Tap Rule that contains match configurations.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + } + }, + "required": [ + "name", + "destinationType", + "destinationId" + ] + }, + "DestinationType": { + "type": "string", + "description": "Type of destination. Input can be IsolationDomain or Direct.", + "enum": [ + "IsolationDomain", + "Direct" + ], + "x-ms-enum": { + "name": "DestinationType", + "modelAsString": true, + "values": [ + { + "name": "IsolationDomain", + "value": "IsolationDomain", + "description": "DestinationType-IsolationDomain" + }, + { + "name": "Direct", + "value": "Direct", + "description": "DestinationType-Direct" + } + ] + } + }, + "DeviceAdministrativeState": { + "type": "string", + "description": "Administrative state.", + "enum": [ + "RMA", + "Resync", + "GracefulQuarantine", + "Quarantine", + "UnderMaintenance", + "Enable" + ], + "x-ms-enum": { + "name": "DeviceAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "RMA", + "value": "RMA", + "description": "Device AdministrativeState-RMA" + }, + { + "name": "Resync", + "value": "Resync", + "description": "Device AdministrativeState-Resync" + }, + { + "name": "GracefulQuarantine", + "value": "GracefulQuarantine", + "description": "Device AdministrativeState-GracefulQuarantine" + }, + { + "name": "Quarantine", + "value": "Quarantine", + "description": "Device AdministrativeState-Quarantine" + }, + { + "name": "UnderMaintenance", + "value": "UnderMaintenance", + "description": "Device AdministrativeState-UnderMaintenance" + }, + { + "name": "Enable", + "value": "Enable", + "description": "Device AdministrativeState-Enable" + } + ] + } + }, + "DeviceInterfaceProperties": { + "type": "object", + "description": "Network device interface properties.", + "properties": { + "identifier": { + "type": "string", + "description": "Interface identifier. Example: HundredGigE0/0." + }, + "interfaceType": { + "type": "string", + "description": "Interface type." + }, + "supportedConnectorTypes": { + "type": "array", + "description": "List of supported connector types.", + "items": { + "$ref": "#/definitions/SupportedConnectorProperties" + }, + "x-ms-identifiers": [ + "connectorType" + ] + } + } + }, + "DeviceRoCommand": { + "type": "object", + "description": "Provide the RO command", + "properties": { + "command": { + "type": "string", + "description": "Specify the command." + } + } + }, + "DeviceRwCommand": { + "type": "object", + "description": "Provide the Rw command", + "properties": { + "command": { + "type": "string", + "description": "Specify the command." + } + } + }, + "EnableDisableState": { + "type": "string", + "description": "Administrative state.", + "enum": [ + "Enable", + "Disable", + "UnderMaintenance" + ], + "x-ms-enum": { + "name": "EnableDisableState", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "AdministrativeState Enable" + }, + { + "name": "Disable", + "value": "Disable", + "description": "AdministrativeState Disable" + }, + { + "name": "UnderMaintenance", + "value": "UnderMaintenance", + "description": "AdministrativeState UnderMaintenance" + } + ] + } + }, + "Encapsulation": { + "type": "string", + "description": "Type of encapsulation.", + "enum": [ + "None", + "GRE" + ], + "x-ms-enum": { + "name": "Encapsulation", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Encapsulation-None" + }, + { + "name": "GRE", + "value": "GRE", + "description": "Encapsulation-GRE" + } + ] + } + }, + "EncapsulationType": { + "type": "string", + "description": "Encapsulation Type that needs to be matched.", + "enum": [ + "None", + "GTPv1" + ], + "x-ms-enum": { + "name": "EncapsulationType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None EncapsulationType" + }, + { + "name": "GTPv1", + "value": "GTPv1", + "description": "GTPv1 EncapsulationType" + } + ] + } + }, + "ExportRoutePolicy": { + "type": "object", + "description": "Export Route Policy either IPv4 or IPv6.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExportRoutePolicyInformation": { + "type": "object", + "description": "Export Route Policy Configuration.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExportRoutePolicyInformationPatch": { + "type": "object", + "description": "Export Route Policy Configuration.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExportRoutePolicyPatch": { + "type": "object", + "description": "Export Route Policy either IPv4 or IPv6.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExpressRouteConnectionInformation": { + "type": "object", + "description": "The ExpressRoute circuit ID and the Auth Key are required for you to successfully deploy NFC service.", + "properties": { + "expressRouteCircuitId": { + "type": "string", + "format": "arm-id", + "description": "The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/expressRouteCircuits" + } + ] + } + }, + "expressRouteAuthorizationKey": { + "type": "string", + "format": "password", + "description": "Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute.", + "x-ms-secret": true + } + }, + "required": [ + "expressRouteCircuitId", + "expressRouteAuthorizationKey" + ] + }, + "ExternalNetwork": { + "type": "object", + "description": "Defines the External Network resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ExternalNetworkProperties", + "description": "External Network Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ExternalNetworkListResult": { + "type": "object", + "description": "The response of a ExternalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ExternalNetwork items on this page", + "items": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ExternalNetworkPatch": { + "type": "object", + "description": "The ExternalNetwork patch resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ExternalNetworkPatchProperties", + "description": "External Network Patch properties." + } + } + }, + "ExternalNetworkPatchProperties": { + "type": "object", + "description": "External Network Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "importRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicyPatch", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicyPatch", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/L3OptionBPatchProperties", + "description": "option B properties object" + }, + "optionAProperties": { + "$ref": "#/definitions/ExternalNetworkPatchPropertiesOptionAProperties", + "description": "option A properties object" + } + } + }, + "ExternalNetworkPatchPropertiesOptionAProperties": { + "type": "object", + "description": "option A properties object", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan identifier. Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "Fabric ASN number. Example 65001", + "minimum": 1, + "maximum": 4294967295, + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + } + } + }, + "ExternalNetworkProperties": { + "type": "object", + "description": "External Network Properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "importRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicy", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicy", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/L3OptionBProperties", + "description": "option B properties object" + }, + "optionAProperties": { + "$ref": "#/definitions/ExternalNetworkPropertiesOptionAProperties", + "description": "option A properties object" + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "peeringOption" + ] + }, + "ExternalNetworkPropertiesOptionAProperties": { + "type": "object", + "description": "option A properties object", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan identifier. Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "Fabric ASN number. Example 65001", + "minimum": 1, + "maximum": 4294967295, + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + } + }, + "required": [ + "vlanId", + "peerASN" + ] + }, + "FabricSkuType": { + "type": "string", + "description": "Type of Network Fabric SKU.", + "enum": [ + "SingleRack", + "MultiRack" + ], + "x-ms-enum": { + "name": "FabricSkuType", + "modelAsString": true, + "values": [ + { + "name": "SingleRack", + "value": "SingleRack", + "description": "FabricSkuType-SingleRack" + }, + { + "name": "MultiRack", + "value": "MultiRack", + "description": "FabricSkuType-MultiRack" + } + ] + } + }, + "GatewayType": { + "type": "string", + "description": "Gateway Type of the resource.", + "enum": [ + "Infrastructure", + "Workload" + ], + "x-ms-enum": { + "name": "GatewayType", + "modelAsString": true, + "values": [ + { + "name": "Infrastructure", + "value": "Infrastructure", + "description": "GatewayType Infrastructure" + }, + { + "name": "Workload", + "value": "Workload", + "description": "GatewayType Workload" + } + ] + } + }, + "IPAddressType": { + "type": "string", + "description": "IP Address type.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 IP address" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 IP address" + } + ] + } + }, + "ImportRoutePolicy": { + "type": "object", + "description": "Import Route Policy either IPv4 or IPv6.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ImportRoutePolicyInformation": { + "type": "object", + "description": "Import Route Policy Configuration.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ImportRoutePolicyInformationPatch": { + "type": "object", + "description": "Import Route Policy Configuration.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ImportRoutePolicyPatch": { + "type": "object", + "description": "Import Route Policy either IPv4 or IPv6.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "InterfaceType": { + "type": "string", + "description": "The Interface Type. Example: Management/Data", + "enum": [ + "Management", + "Data" + ], + "x-ms-enum": { + "name": "InterfaceType", + "modelAsString": true, + "values": [ + { + "name": "Management", + "value": "Management", + "description": "InterfaceType-Management" + }, + { + "name": "Data", + "value": "Data", + "description": "InterfaceType-Data" + } + ] + } + }, + "InternalNetwork": { + "type": "object", + "description": "Defines the Internal Network resource.", + "properties": { + "properties": { + "$ref": "#/definitions/InternalNetworkProperties", + "description": "The Internal Network Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "InternalNetworkListResult": { + "type": "object", + "description": "The response of a InternalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InternalNetwork items on this page", + "items": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "InternalNetworkPatch": { + "type": "object", + "description": "The InternalNetwork patch resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/InternalNetworkPatchProperties", + "description": "InternalNetwork Patch properties." + } + } + }, + "InternalNetworkPatchProperties": { + "type": "object", + "description": "InternalNetwork Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "minimum": 64, + "maximum": 9200 + }, + "connectedIPv4Subnets": { + "type": "array", + "description": "List of Connected IPv4 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnetPatch" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "connectedIPv6Subnets": { + "type": "array", + "description": "List of connected IPv6 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnetPatch" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "importRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicy", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicy", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "isMonitoringEnabled": { + "$ref": "#/definitions/IsMonitoringEnabled", + "description": "To check whether monitoring of internal network is enabled or not." + }, + "bgpConfiguration": { + "$ref": "#/definitions/BgpPatchConfiguration", + "description": "BGP configuration properties." + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/StaticRoutePatchConfiguration", + "description": "Static Route Configuration properties." + } + } + }, + "InternalNetworkProperties": { + "type": "object", + "description": "Internal Network Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "connectedIPv4Subnets": { + "type": "array", + "description": "List of Connected IPv4 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnet" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "connectedIPv6Subnets": { + "type": "array", + "description": "List of connected IPv6 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnet" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "importRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportRoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy. This is used for the backward compatibility.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicy", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicy", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "isMonitoringEnabled": { + "type": "string", + "description": "To check whether monitoring of internal network is enabled or not.", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsMonitoringEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsMonitoringEnabled-True" + }, + { + "name": "False", + "value": "False", + "description": "IsMonitoringEnabled-False" + } + ] + } + }, + "extension": { + "type": "string", + "description": "Extension. Example: NoExtension | NPB.", + "default": "NoExtension", + "enum": [ + "NoExtension", + "NPB" + ], + "x-ms-enum": { + "name": "Extension", + "modelAsString": true, + "values": [ + { + "name": "NoExtension", + "value": "NoExtension", + "description": "Extension-NoExtension" + }, + { + "name": "NPB", + "value": "NPB", + "description": "Extension-NPB" + } + ] + } + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan identifier. Example: 1001.", + "minimum": 100, + "maximum": 4094 + }, + "bgpConfiguration": { + "$ref": "#/definitions/BgpConfiguration", + "description": "BGP configuration properties." + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/StaticRouteConfiguration", + "description": "Static Route Configuration properties." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "vlanId" + ] + }, + "InternetGateway": { + "type": "object", + "description": "The Internet Gateway resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/InternetGatewayProperties", + "description": "The Internet Gateway Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InternetGatewayListResult": { + "type": "object", + "description": "The response of a InternetGateway list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InternetGateway items on this page", + "items": { + "$ref": "#/definitions/InternetGateway" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "InternetGatewayPatch": { + "type": "object", + "description": "The Internet Gateway patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/InternetGatewayPatchProperties", + "description": "Resource properties." + } + } + }, + "InternetGatewayPatchProperties": { + "type": "object", + "description": "PatchProperties for InternetGateway ", + "properties": { + "internetGatewayRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Internet Gateway Rule.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/internetGatewayRules" + } + ] + } + } + } + }, + "InternetGatewayProperties": { + "type": "object", + "description": "Internet Gateway Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "internetGatewayRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Internet Gateway Rule.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/internetGatewayRules" + } + ] + } + }, + "ipv4Address": { + "type": "string", + "description": "IPv4 Address of Internet Gateway.", + "readOnly": true + }, + "port": { + "type": "integer", + "format": "int32", + "description": "Port number of Internet Gateway.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/GatewayType", + "description": "Gateway Type of the resource." + }, + "networkFabricControllerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric Controller.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabricControllers" + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of resource.", + "readOnly": true + } + }, + "required": [ + "type", + "networkFabricControllerId" + ] + }, + "InternetGatewayRule": { + "type": "object", + "description": "The Internet Gateway Rule resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/InternetGatewayRuleProperties", + "description": "The Internet Gateway Rule properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InternetGatewayRuleListResult": { + "type": "object", + "description": "The response of a InternetGatewayRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InternetGatewayRule items on this page", + "items": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "InternetGatewayRulePatch": { + "type": "object", + "description": "The Internet Gateway Rules patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "InternetGatewayRuleProperties": { + "type": "object", + "description": "Internet Gateway Rule Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ruleProperties": { + "$ref": "#/definitions/RuleProperties", + "description": "Rules for the InternetGateways" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "internetGatewayIds": { + "type": "array", + "description": "List of Internet Gateway resource Id.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "ruleProperties" + ] + }, + "IpCommunity": { + "type": "object", + "description": "The IP Community resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/IpCommunityProperties", + "description": "The IP Community Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IpCommunityIdList": { + "type": "object", + "description": "IP Community ID list properties.", + "properties": { + "ipCommunityIds": { + "type": "array", + "description": "List of IP Community resource IDs.", + "items": { + "type": "string" + } + } + } + }, + "IpCommunityListResult": { + "type": "object", + "description": "The response of a IpCommunity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IpCommunity items on this page", + "items": { + "$ref": "#/definitions/IpCommunity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IpCommunityPatch": { + "type": "object", + "description": "The IP Community patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/IpCommunityPatchableProperties", + "description": "IP Community patchable properties." + } + } + }, + "IpCommunityPatchableProperties": { + "type": "object", + "description": "IP Community patchable properties.", + "properties": { + "ipCommunityRules": { + "type": "array", + "description": "List of IP Community Rules.", + "items": { + "$ref": "#/definitions/IpCommunityRule" + }, + "x-ms-identifiers": [] + } + } + }, + "IpCommunityProperties": { + "type": "object", + "description": "IP Community Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipCommunityRules": { + "type": "array", + "description": "List of IP Community Rules.", + "items": { + "$ref": "#/definitions/IpCommunityRule" + }, + "x-ms-identifiers": [] + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "ipCommunityRules" + ] + }, + "IpCommunityRule": { + "type": "object", + "description": "IP Community patchable properties.", + "properties": { + "action": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Action to be taken on the configuration. Example: Permit | Deny." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.", + "minimum": 1, + "maximum": 4294967295 + }, + "wellKnownCommunities": { + "type": "array", + "description": "Supported well known Community List.", + "items": { + "$ref": "#/definitions/WellKnownCommunities" + } + }, + "communityMembers": { + "type": "array", + "description": "List the community members of IP Community.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "action", + "sequenceNumber", + "communityMembers" + ] + }, + "IpExtendedCommunity": { + "type": "object", + "description": "The IP Extended Community resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/IpExtendedCommunityProperties", + "description": "The IpExtendedCommunity properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IpExtendedCommunityIdList": { + "type": "object", + "description": "IP Extended Community Id list properties.", + "properties": { + "ipExtendedCommunityIds": { + "type": "array", + "description": "List of IP Extended Community resource IDs.", + "items": { + "type": "string" + } + } + } + }, + "IpExtendedCommunityListResult": { + "type": "object", + "description": "The response of a IpExtendedCommunity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IpExtendedCommunity items on this page", + "items": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IpExtendedCommunityPatch": { + "type": "object", + "description": "The IP Extended Communities patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/IpExtendedCommunityPatchProperties", + "description": "IP Extended Community patchable properties." + } + } + }, + "IpExtendedCommunityPatchProperties": { + "type": "object", + "description": "IP Extended Community patchable properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipExtendedCommunityRules": { + "type": "array", + "description": "List of IP Extended Community Rules.", + "items": { + "$ref": "#/definitions/IpExtendedCommunityRule" + }, + "x-ms-identifiers": [] + } + } + }, + "IpExtendedCommunityProperties": { + "type": "object", + "description": "IP Extended Community Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipExtendedCommunityRules": { + "type": "array", + "description": "List of IP Extended Community Rules.", + "items": { + "$ref": "#/definitions/IpExtendedCommunityRule" + }, + "x-ms-identifiers": [] + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "ipExtendedCommunityRules" + ] + }, + "IpExtendedCommunityRule": { + "type": "object", + "description": "List of IP Extended Community Rules.", + "properties": { + "action": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Action to be taken on the configuration. Example: Permit | Deny." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.", + "minimum": 1, + "maximum": 4294967295 + }, + "routeTargets": { + "type": "array", + "description": "Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "action", + "sequenceNumber", + "routeTargets" + ] + }, + "IpGroupPatchProperties": { + "type": "object", + "description": "IP Group properties.", + "properties": { + "name": { + "type": "string", + "description": "IP Group name.", + "minLength": 1 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "IP Address type." + }, + "ipPrefixes": { + "type": "array", + "description": "List of IP Prefixes.", + "items": { + "type": "string" + } + } + } + }, + "IpGroupProperties": { + "type": "object", + "description": "IP Group properties.", + "properties": { + "name": { + "type": "string", + "description": "IP Group name.", + "minLength": 1 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "IP Address type." + }, + "ipPrefixes": { + "type": "array", + "description": "List of IP Prefixes.", + "items": { + "type": "string" + } + } + } + }, + "IpMatchCondition": { + "type": "object", + "description": "Defines the condition that can be filtered using the selected IPs.", + "properties": { + "type": { + "$ref": "#/definitions/SourceDestinationType", + "description": "IP Address type that needs to be matched." + }, + "prefixType": { + "$ref": "#/definitions/PrefixType", + "description": "IP Prefix Type that needs to be matched." + }, + "ipPrefixValues": { + "type": "array", + "description": "The list of IP Prefixes that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipGroupNames": { + "type": "array", + "description": "The List of IP Group Names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IpMatchConditionPatch": { + "type": "object", + "description": "Defines the condition that can be filtered using the selected IPs.", + "properties": { + "type": { + "$ref": "#/definitions/SourceDestinationType", + "description": "IP Address type that needs to be matched." + }, + "prefixType": { + "$ref": "#/definitions/PrefixType", + "description": "IP Prefix Type that needs to be matched." + }, + "ipPrefixValues": { + "type": "array", + "description": "The list of IP Prefixes that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipGroupNames": { + "type": "array", + "description": "The List of IP Group Names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IpPrefix": { + "type": "object", + "description": "The IP Prefix resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/IpPrefixProperties", + "description": "The IP Prefix properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IpPrefixListResult": { + "type": "object", + "description": "The response of a IpPrefix list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IpPrefix items on this page", + "items": { + "$ref": "#/definitions/IpPrefix" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IpPrefixPatch": { + "type": "object", + "description": "The IP Prefix patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/IpPrefixPatchProperties", + "description": "IP Prefix patchable properties." + } + } + }, + "IpPrefixPatchProperties": { + "type": "object", + "description": "IP Prefix patchable properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipPrefixRules": { + "type": "array", + "description": "The list of IP Prefix Rules.", + "items": { + "$ref": "#/definitions/IpPrefixRule" + }, + "x-ms-identifiers": [] + } + } + }, + "IpPrefixProperties": { + "type": "object", + "description": "IP Prefix Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipPrefixRules": { + "type": "array", + "description": "The list of IP Prefix Rules.", + "items": { + "$ref": "#/definitions/IpPrefixRule" + }, + "x-ms-identifiers": [] + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "ipPrefixRules" + ] + }, + "IpPrefixRule": { + "type": "object", + "description": "IP Prefix Rule properties.", + "properties": { + "action": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Action to be taken on the configuration. Example: Permit | Deny." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.", + "minimum": 1, + "maximum": 4294967295 + }, + "networkPrefix": { + "type": "string", + "description": "Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126" + }, + "condition": { + "$ref": "#/definitions/Condition", + "description": "Specify prefix-list bounds." + }, + "subnetMaskLength": { + "type": "string", + "description": "SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128." + } + }, + "required": [ + "action", + "sequenceNumber", + "networkPrefix" + ] + }, + "IsMonitoringEnabled": { + "type": "string", + "description": "To check whether monitoring of internal network is enabled or not.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsMonitoringEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsMonitoringEnabled-True" + }, + { + "name": "False", + "value": "False", + "description": "IsMonitoringEnabled-False" + } + ] + } + }, + "IsolationDomainPatchProperties": { + "type": "object", + "description": "Isolation Domain Properties.", + "properties": { + "encapsulation": { + "$ref": "#/definitions/Encapsulation", + "description": "Type of encapsulation." + }, + "neighborGroupIds": { + "type": "array", + "description": "List of Neighbor Group IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + } + ] + } + } + } + } + }, + "IsolationDomainProperties": { + "type": "object", + "description": "Isolation Domain Properties.", + "properties": { + "encapsulation": { + "$ref": "#/definitions/Encapsulation", + "description": "Type of encapsulation." + }, + "neighborGroupIds": { + "type": "array", + "description": "List of Neighbor Group IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + } + ] + } + } + } + } + }, + "L2IsolationDomain": { + "type": "object", + "description": "The L2 Isolation Domain resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/L2IsolationDomainProperties", + "description": "The L2IsolationDomain properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "L2IsolationDomainListResult": { + "type": "object", + "description": "The response of a L2IsolationDomain list operation.", + "properties": { + "value": { + "type": "array", + "description": "The L2IsolationDomain items on this page", + "items": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "L2IsolationDomainPatch": { + "type": "object", + "description": "The L2 Isolation Domain patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/L2IsolationDomainPatchProperties", + "description": "Resource properties." + } + } + }, + "L2IsolationDomainPatchProperties": { + "type": "object", + "description": "L2 Isolation Domain Patch Properties defines the patchable properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "minimum": 64, + "maximum": 9200 + } + } + }, + "L2IsolationDomainProperties": { + "type": "object", + "description": "L2Isolation Domain Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan Identifier of the Network Fabric. Example: 501.", + "minimum": 100, + "maximum": 4094 + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId", + "vlanId" + ] + }, + "L3ExportRoutePolicy": { + "type": "object", + "description": "Array of ARM Resource ID of the RoutePolicies.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "L3IsolationDomain": { + "type": "object", + "description": "The L3 Isolation Domain resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/L3IsolationDomainProperties", + "description": "The L3 Isolation Domain Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "L3IsolationDomainListResult": { + "type": "object", + "description": "The response of a L3IsolationDomain list operation.", + "properties": { + "value": { + "type": "array", + "description": "The L3IsolationDomain items on this page", + "items": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "L3IsolationDomainPatch": { + "type": "object", + "description": "The L3 Isolation Domain patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/L3IsolationDomainPatchProperties", + "description": "Resource properties." + } + } + }, + "L3IsolationDomainPatchProperties": { + "type": "object", + "description": "Resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "redistributeConnectedSubnets": { + "$ref": "#/definitions/RedistributeConnectedSubnets", + "description": "Advertise Connected Subnets. Ex: \"True\" | \"False\"." + }, + "redistributeStaticRoutes": { + "$ref": "#/definitions/RedistributeStaticRoutes", + "description": "Advertise Static Routes. Ex: \"True\" | \"False\"." + }, + "aggregateRouteConfiguration": { + "$ref": "#/definitions/AggregateRouteConfiguration", + "description": "Aggregate route configurations." + }, + "connectedSubnetRoutePolicy": { + "$ref": "#/definitions/ConnectedSubnetRoutePolicy", + "description": "Connected Subnet RoutePolicy" + } + } + }, + "L3IsolationDomainProperties": { + "type": "object", + "description": "L3 Isolation Domain Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "redistributeConnectedSubnets": { + "type": "string", + "description": "Advertise Connected Subnets. Ex: \"True\" | \"False\".", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeConnectedSubnets", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeConnectedSubnets-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeConnectedSubnets-False" + } + ] + } + }, + "redistributeStaticRoutes": { + "type": "string", + "description": "Advertise Static Routes. Ex: \"True\" | \"False\".", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeStaticRoutes", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeStaticRoutes-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeStaticRoutes-False" + } + ] + } + }, + "aggregateRouteConfiguration": { + "$ref": "#/definitions/AggregateRouteConfiguration", + "description": "Aggregate route configurations." + }, + "connectedSubnetRoutePolicy": { + "$ref": "#/definitions/ConnectedSubnetRoutePolicy", + "description": "Connected Subnet RoutePolicy" + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId" + ] + }, + "L3OptionBPatchProperties": { + "type": "object", + "description": "Option B configuration.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetPatchInformation", + "description": "RouteTargets to be applied." + } + } + }, + "L3OptionBProperties": { + "type": "object", + "description": "Option B configuration.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetInformation", + "description": "RouteTargets to be applied." + } + } + }, + "Layer2Configuration": { + "type": "object", + "description": "Common properties for Layer2 Configuration.", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU of the packets between PE & CE.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "interfaces": { + "type": "array", + "description": "List of network device interfaces resource IDs.", + "minItems": 1, + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces" + } + ] + } + } + } + } + }, + "Layer2ConfigurationPatch": { + "type": "object", + "description": "Common properties for Layer2 Configuration.", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU of the packets between PE & CE.", + "minimum": 64, + "maximum": 9200 + }, + "interfaces": { + "type": "array", + "description": "List of network device interfaces resource IDs.", + "minItems": 1, + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces" + } + ] + } + } + } + } + }, + "Layer4Protocol": { + "type": "string", + "description": "Layer4 protocol type that needs to be matched.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "Layer4Protocol", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP(Transmission Control Protocol) Protocol" + }, + { + "name": "UDP", + "value": "UDP", + "description": "UDP(User Datagram Protocol) Protocol" + } + ] + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "description": "Managed Resource Group configuration properties.", + "properties": { + "name": { + "type": "string", + "description": "The NFC service will be hosted in a Managed resource group." + }, + "location": { + "type": "string", + "description": "Managed resource group location.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ManagementNetworkConfigurationProperties": { + "type": "object", + "description": "Configuration to be used to setup the management network.", + "properties": { + "infrastructureVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationProperties", + "description": "VPN Configuration properties." + }, + "workloadVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationProperties", + "description": "VPN Configuration properties." + } + }, + "required": [ + "infrastructureVpnConfiguration", + "workloadVpnConfiguration" + ] + }, + "ManagementNetworkPatchConfiguration": { + "type": "object", + "description": "Configuration to be used to setup the management network.", + "properties": { + "infrastructureVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationPatchableProperties", + "description": "VPN Configuration properties." + }, + "workloadVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationPatchableProperties", + "description": "VPN Configuration properties." + } + } + }, + "NeighborAddress": { + "type": "object", + "description": "Neighbor Address properties.", + "properties": { + "address": { + "type": "string", + "description": "IP Address.", + "minLength": 1 + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + } + } + }, + "NeighborAddressPatch": { + "type": "object", + "description": "Neighbor Address properties.", + "properties": { + "address": { + "type": "string", + "description": "IP Address.", + "minLength": 1 + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + } + } + }, + "NeighborGroup": { + "type": "object", + "description": "Defines the Neighbor Group.", + "properties": { + "properties": { + "$ref": "#/definitions/NeighborGroupProperties", + "description": "The NeighborGroup Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NeighborGroupDestination": { + "type": "object", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses.", + "properties": { + "ipv4Addresses": { + "type": "array", + "description": "Array of IPv4 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + }, + "ipv6Addresses": { + "type": "array", + "description": "Array of IPv6 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + } + } + }, + "NeighborGroupDestinationPatch": { + "type": "object", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses.", + "properties": { + "ipv4Addresses": { + "type": "array", + "description": "Array of IPv4 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + }, + "ipv6Addresses": { + "type": "array", + "description": "Array of IPv6 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + } + } + }, + "NeighborGroupListResult": { + "type": "object", + "description": "The response of a NeighborGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NeighborGroup items on this page", + "items": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NeighborGroupPatch": { + "type": "object", + "description": "The Neighbor Group Patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NeighborGroupPatchProperties", + "description": "Neighbor Group Patch properties." + } + } + }, + "NeighborGroupPatchProperties": { + "type": "object", + "description": "Neighbor Group Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "destination": { + "$ref": "#/definitions/NeighborGroupDestinationPatch", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses." + } + } + }, + "NeighborGroupProperties": { + "type": "object", + "description": "Neighbor Group Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "destination": { + "$ref": "#/definitions/NeighborGroupDestination", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses." + }, + "networkTapIds": { + "type": "array", + "description": "List of NetworkTap IDs where neighbor group is associated.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTaps" + } + ] + } + }, + "readOnly": true + }, + "networkTapRuleIds": { + "type": "array", + "description": "List of Network Tap Rule IDs where neighbor group is associated.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "destination" + ] + }, + "NetworkDevice": { + "type": "object", + "description": "The Network Device resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkDeviceProperties", + "description": "The NetworkDevice properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkDeviceListResult": { + "type": "object", + "description": "The response of a NetworkDevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkDevice items on this page", + "items": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkDevicePatchParameters": { + "type": "object", + "description": "The Network Device Patch Parameters defines the patch parameters of the resource.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkDevicePatchParametersProperties", + "description": "Network Device Patch properties." + } + } + }, + "NetworkDevicePatchParametersProperties": { + "type": "object", + "description": "Network Device Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "hostName": { + "type": "string", + "description": "The host name of the device.", + "minLength": 1 + }, + "serialNumber": { + "type": "string", + "description": "Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.", + "minLength": 1 + } + } + }, + "NetworkDeviceProperties": { + "type": "object", + "description": "Network Device Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "hostName": { + "type": "string", + "description": "The host name of the device.", + "minLength": 1 + }, + "serialNumber": { + "type": "string", + "description": "Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.", + "minLength": 1 + }, + "version": { + "type": "string", + "description": "Current version of the device as defined in SKU.", + "readOnly": true + }, + "networkDeviceSku": { + "type": "string", + "description": "Network Device SKU name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkDeviceRole": { + "$ref": "#/definitions/NetworkDeviceRole", + "description": "NetworkDeviceRole is the device role: Example: CE | ToR.", + "readOnly": true + }, + "networkRackId": { + "type": "string", + "description": "Reference to network rack resource id.", + "readOnly": true + }, + "managementIpv4Address": { + "type": "string", + "description": "Management IPv4 Address.", + "readOnly": true + }, + "managementIpv6Address": { + "type": "string", + "description": "Management IPv6 Address.", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "serialNumber" + ] + }, + "NetworkDeviceRole": { + "type": "string", + "description": "NetworkDeviceRole is the device role: Example: CE | ToR.", + "enum": [ + "CE", + "ToR", + "NPB", + "TS", + "Management" + ], + "x-ms-enum": { + "name": "NetworkDeviceRole", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "NetworkDeviceRole-CE(Customer Edge)" + }, + { + "name": "ToR", + "value": "ToR", + "description": "NetworkDeviceRole-ToR(top of rack)" + }, + { + "name": "NPB", + "value": "NPB", + "description": "NetworkDeviceRole-NPB(Network Packet Broker)" + }, + { + "name": "TS", + "value": "TS", + "description": "NetworkDeviceRole-TS(Terminal Server)" + }, + { + "name": "Management", + "value": "Management", + "description": "NetworkDeviceRole-Management" + } + ] + } + }, + "NetworkDeviceRoleName": { + "type": "string", + "description": "Available roles for the network device.", + "enum": [ + "CE", + "ToR", + "NPB", + "TS", + "Management" + ], + "x-ms-enum": { + "name": "NetworkDeviceRoleName", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "NetworkDeviceRoleName-CE(Customer Edge)" + }, + { + "name": "ToR", + "value": "ToR", + "description": "NetworkDeviceRoleName-ToR(top of rack)" + }, + { + "name": "NPB", + "value": "NPB", + "description": "NetworkDeviceRoleName-NPB(Network Packet Broker)" + }, + { + "name": "TS", + "value": "TS", + "description": "NetworkDeviceRoleName-TS(Terminal Server)" + }, + { + "name": "Management", + "value": "Management", + "description": "NetworkDeviceRoleName-Management" + } + ] + } + }, + "NetworkDeviceSku": { + "type": "object", + "description": "The NetworkDeviceSku resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkDeviceSkuProperties", + "description": "The NetworkDeviceSku properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkDeviceSkuListResult": { + "type": "object", + "description": "The response of a NetworkDeviceSku list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkDeviceSku items on this page", + "items": { + "$ref": "#/definitions/NetworkDeviceSku" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkDeviceSkuProperties": { + "type": "object", + "description": "Network Device SKU Properties defines the properties of the resource.", + "properties": { + "model": { + "type": "string", + "description": "Model of the network device." + }, + "manufacturer": { + "type": "string", + "description": "Manufacturer of the network device." + }, + "supportedVersions": { + "type": "array", + "description": "List of supported version details of network device.", + "items": { + "$ref": "#/definitions/SupportedVersionProperties" + }, + "x-ms-identifiers": [ + "version" + ] + }, + "supportedRoleTypes": { + "type": "array", + "description": "Available roles for the network device.", + "items": { + "$ref": "#/definitions/NetworkDeviceRoleName" + } + }, + "interfaces": { + "type": "array", + "description": "List of network device interfaces.", + "items": { + "$ref": "#/definitions/DeviceInterfaceProperties" + }, + "x-ms-identifiers": [ + "identifier" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "model" + ] + }, + "NetworkFabric": { + "type": "object", + "description": "The Network Fabric resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFabricProperties", + "description": "The NetworkFabric Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFabricController": { + "type": "object", + "description": "The Network Fabric Controller resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFabricControllerProperties", + "description": "The NetworkFabricController Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFabricControllerListResult": { + "type": "object", + "description": "The response of a NetworkFabricController list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFabricController items on this page", + "items": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFabricControllerPatch": { + "type": "object", + "description": "The Network Fabric Controller Patch payload definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkFabricControllerPatchProperties", + "description": "Network Fabric Controller patch properties." + } + } + }, + "NetworkFabricControllerPatchProperties": { + "type": "object", + "description": "Network Fabric Controller patch properties.", + "properties": { + "infrastructureExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute)", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + }, + "workloadExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + } + } + }, + "NetworkFabricControllerProperties": { + "type": "object", + "description": "NetworkFabricControllerProperties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "infrastructureExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute)", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + }, + "workloadExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + }, + "infrastructureServices": { + "$ref": "#/definitions/ControllerServices", + "description": "InfrastructureServices IP ranges.", + "readOnly": true + }, + "workloadServices": { + "$ref": "#/definitions/ControllerServices", + "description": "WorkloadServices IP ranges.", + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "Managed Resource Group configuration properties." + }, + "networkFabricIds": { + "type": "array", + "description": "The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "readOnly": true + }, + "workloadManagementNetwork": { + "type": "boolean", + "description": "A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility.", + "default": true, + "readOnly": true + }, + "isWorkloadManagementNetworkEnabled": { + "type": "string", + "description": "A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints.", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsWorkloadManagementNetworkEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsWorkloadManagementNetworkEnabled-True" + }, + { + "name": "False", + "value": "False", + "description": "IsWorkloadManagementNetworkEnabled-False" + } + ] + } + }, + "tenantInternetGatewayIds": { + "type": "array", + "description": "List of tenant InternetGateway resource IDs", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/internetGateways" + } + ] + } + }, + "readOnly": true + }, + "ipv4AddressSpace": { + "type": "string", + "description": "IPv4 Network Fabric Controller Address Space.", + "default": "10.0.0.0/19", + "minLength": 1 + }, + "ipv6AddressSpace": { + "type": "string", + "description": "IPv6 Network Fabric Controller Address Space.", + "default": "FC00::/59", + "minLength": 1 + }, + "nfcSku": { + "type": "string", + "description": "Network Fabric Controller SKU.", + "default": "Standard", + "enum": [ + "Basic", + "Standard", + "HighPerformance" + ], + "x-ms-enum": { + "name": "NfcSku", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "NfcSku-Basic" + }, + { + "name": "Standard", + "value": "Standard", + "description": "NfcSku-Standard" + }, + { + "name": "HighPerformance", + "value": "HighPerformance", + "description": "NfcSku-HighPerformance" + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning.", + "readOnly": true + } + } + }, + "NetworkFabricListResult": { + "type": "object", + "description": "The response of a NetworkFabric list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFabric items on this page", + "items": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFabricPatch": { + "type": "object", + "description": "The Network Fabric resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkFabricPatchProperties", + "description": "Network Fabric Patch properties." + } + } + }, + "NetworkFabricPatchProperties": { + "type": "object", + "description": "Network Fabric Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "rackCount": { + "type": "integer", + "format": "int32", + "description": "Number of compute racks associated to Network Fabric.", + "minimum": 1, + "maximum": 8 + }, + "serverCountPerRack": { + "type": "integer", + "format": "int32", + "description": "Number of servers.Possible values are from 1-16.", + "minimum": 1, + "maximum": 16 + }, + "ipv4Prefix": { + "type": "string", + "description": "IPv4Prefix for Management Network. Example: 10.1.0.0/19.", + "minLength": 1 + }, + "ipv6Prefix": { + "type": "string", + "description": "IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.", + "minLength": 1 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "minimum": 1, + "maximum": 4294967295 + }, + "terminalServerConfiguration": { + "$ref": "#/definitions/TerminalServerPatchConfiguration", + "description": "Network and credentials configuration already applied to terminal server." + }, + "managementNetworkConfiguration": { + "$ref": "#/definitions/ManagementNetworkPatchConfiguration", + "description": "Configuration to be used to setup the management network." + } + } + }, + "NetworkFabricProperties": { + "type": "object", + "description": "Network Fabric Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricSku": { + "type": "string", + "description": "Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric.", + "minLength": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "fabricVersion": { + "type": "string", + "description": "The version of Network Fabric.", + "minLength": 1 + }, + "routerIds": { + "type": "array", + "description": "Array of router IDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkFabricControllerId": { + "type": "string", + "format": "arm-id", + "description": "Azure resource ID for the NetworkFabricController the NetworkFabric belongs.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabricControllers" + } + ] + } + }, + "rackCount": { + "type": "integer", + "format": "int32", + "description": "Number of compute racks associated to Network Fabric.", + "minimum": 1, + "maximum": 8 + }, + "serverCountPerRack": { + "type": "integer", + "format": "int32", + "description": "Number of servers.Possible values are from 1-16.", + "minimum": 1, + "maximum": 16 + }, + "ipv4Prefix": { + "type": "string", + "description": "IPv4Prefix for Management Network. Example: 10.1.0.0/19.", + "minLength": 1 + }, + "ipv6Prefix": { + "type": "string", + "description": "IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59", + "minLength": 1 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "minimum": 1, + "maximum": 4294967295 + }, + "terminalServerConfiguration": { + "$ref": "#/definitions/TerminalServerConfiguration", + "description": "Network and credentials configuration currently applied to terminal server." + }, + "managementNetworkConfiguration": { + "$ref": "#/definitions/ManagementNetworkConfigurationProperties", + "description": "Configuration to be used to setup the management network." + }, + "racks": { + "type": "array", + "description": "List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "l2IsolationDomains": { + "type": "array", + "description": "List of L2 Isolation Domain resource IDs under the Network Fabric.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "l3IsolationDomains": { + "type": "array", + "description": "List of L3 Isolation Domain resource IDs under the Network Fabric.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricSku", + "networkFabricControllerId", + "serverCountPerRack", + "ipv4Prefix", + "fabricASN", + "terminalServerConfiguration", + "managementNetworkConfiguration" + ] + }, + "NetworkFabricSku": { + "type": "object", + "description": "The Network Fabric SKU resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFabricSkuProperties", + "description": "The Network Fabric Sku properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkFabricSkuListResult": { + "type": "object", + "description": "The response of a NetworkFabricSku list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFabricSku items on this page", + "items": { + "$ref": "#/definitions/NetworkFabricSku" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFabricSkuProperties": { + "type": "object", + "description": "Network Fabric SKU Properties define properties of the resource.", + "properties": { + "type": { + "$ref": "#/definitions/FabricSkuType", + "description": "Type of Network Fabric SKU.", + "readOnly": true + }, + "maxComputeRacks": { + "type": "integer", + "format": "int32", + "description": "Maximum number of compute racks available for this Network Fabric SKU. The value of max count racks is 4 for 4 rack SKU and 8 for 8 rack SKU." + }, + "maximumServerCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of servers available for this Network Fabric SKU." + }, + "supportedVersions": { + "type": "array", + "description": "List of supported Network Fabric SKU versions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "details": { + "type": "string", + "description": "URL providing detailed configuration of the fabric SKU.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "NetworkFabricUpgradeAction": { + "type": "string", + "description": "Action to be performed while upgrading the fabric.", + "enum": [ + "Start", + "Complete" + ], + "x-ms-enum": { + "name": "NetworkFabricUpgradeAction", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "UpgradeAction-Start" + }, + { + "name": "Complete", + "value": "Complete", + "description": "UpgradeAction -Complete" + } + ] + } + }, + "NetworkInterface": { + "type": "object", + "description": "Defines the NetworkInterface resource.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The NetworkInterface properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkInterfacePatch": { + "type": "object", + "description": "The NetworkInterfacePatch resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfacePatchProperties", + "description": "Network Interface Patch properties." + } + } + }, + "NetworkInterfacePatchProperties": { + "type": "object", + "description": "Network Interface Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + } + } + }, + "NetworkInterfaceProperties": { + "type": "object", + "description": "Network Interface Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "physicalIdentifier": { + "type": "string", + "description": "Physical Identifier of the network interface.", + "readOnly": true + }, + "connectedTo": { + "type": "string", + "description": "The ARM resource id of the interface or compute server its connected to.", + "readOnly": true + }, + "interfaceType": { + "$ref": "#/definitions/InterfaceType", + "description": "The Interface Type. Example: Management/Data", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "IPv4Address of the interface.", + "readOnly": true + }, + "ipv6Address": { + "type": "string", + "description": "IPv6Address of the interface.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + } + }, + "NetworkPacketBroker": { + "type": "object", + "description": "The NetworkPacketBroker resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkPacketBrokerProperties", + "description": "The NetworkPacketBroker properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkPacketBrokerListResult": { + "type": "object", + "description": "The response of a NetworkPacketBroker list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkPacketBroker items on this page", + "items": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkPacketBrokerPatch": { + "type": "object", + "description": "The NetworkPacketBroker patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkPacketBrokerProperties": { + "type": "object", + "description": "Network Packet Broker Properties defines the properties of the resource.", + "properties": { + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of the Network Fabric.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "networkDeviceIds": { + "type": "array", + "description": "List of ARM resource IDs of Network Devices [NPB].", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices" + } + ] + } + }, + "readOnly": true + }, + "sourceInterfaceIds": { + "type": "array", + "description": "List of network interfaces across NPB devices that are used to mirror source traffic.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces" + } + ] + } + }, + "readOnly": true + }, + "networkTapIds": { + "type": "array", + "description": "List of network Tap IDs configured on NPB.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTaps" + } + ] + } + }, + "readOnly": true + }, + "neighborGroupIds": { + "type": "array", + "description": "List of neighbor group IDs configured on NPB.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTaps" + } + ] + } + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId" + ] + }, + "NetworkRack": { + "type": "object", + "description": "The Network Rack resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkRackProperties", + "description": "The NetworkRack properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkRackListResult": { + "type": "object", + "description": "The response of a NetworkRack list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkRack items on this page", + "items": { + "$ref": "#/definitions/NetworkRack" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkRackPatch": { + "type": "object", + "description": "Network Rack patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkRackProperties": { + "type": "object", + "description": "Network Rack Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkRackType": { + "$ref": "#/definitions/NetworkRackType", + "description": "Network Rack SKU name." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of the Network Fabric.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "networkDevices": { + "type": "array", + "description": "List of network device ARM resource IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices" + } + ] + } + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId" + ] + }, + "NetworkRackType": { + "type": "string", + "description": "Network Rack SKU name.", + "enum": [ + "Aggregate", + "Compute", + "Combined" + ], + "x-ms-enum": { + "name": "NetworkRackType", + "modelAsString": true, + "values": [ + { + "name": "Aggregate", + "value": "Aggregate", + "description": "NetworkRackType-Aggregate" + }, + { + "name": "Compute", + "value": "Compute", + "description": "NetworkRackType-Compute" + }, + { + "name": "Combined", + "value": "Combined", + "description": "NetworkRackType-Combined" + } + ] + } + }, + "NetworkTap": { + "type": "object", + "description": "The Network Tap resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkTapProperties", + "description": "The NetworkTap Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkTapListResult": { + "type": "object", + "description": "The response of a NetworkTap list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkTap items on this page", + "items": { + "$ref": "#/definitions/NetworkTap" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkTapPatch": { + "type": "object", + "description": "The NetworkFabric resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkTapPatchProperties", + "description": "Resource properties." + } + } + }, + "NetworkTapPatchProperties": { + "type": "object", + "description": "The Network Tap resource patch definition.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "pollingType": { + "$ref": "#/definitions/PollingType", + "description": "Polling type." + }, + "destinations": { + "type": "array", + "description": "List of destination properties to send the filter traffic.", + "items": { + "$ref": "#/definitions/DestinationPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapProperties": { + "type": "object", + "description": "Network Tap Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkPacketBrokerId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of the Network Packet Broker.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "sourceTapRuleId": { + "type": "string", + "format": "arm-id", + "description": "Source Tap Rule Id. ARM Resource ID of the Network Tap Rule.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + }, + "destinations": { + "type": "array", + "description": "List of destinations to send the filter traffic.", + "items": { + "$ref": "#/definitions/DestinationProperties" + }, + "x-ms-identifiers": [] + }, + "pollingType": { + "type": "string", + "description": "Polling type.", + "default": "Pull", + "enum": [ + "Pull", + "Push" + ], + "x-ms-enum": { + "name": "PollingType", + "modelAsString": true, + "values": [ + { + "name": "Pull", + "value": "Pull", + "description": "PollingType-Pull" + }, + { + "name": "Push", + "value": "Push", + "description": "PollingType-Push" + } + ] + } + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configurations state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource. Example -Enabled/Disabled", + "readOnly": true + } + }, + "required": [ + "networkPacketBrokerId", + "destinations" + ] + }, + "NetworkTapRule": { + "type": "object", + "description": "The NetworkTapRule resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkTapRuleProperties", + "description": "The NetworkTapRule Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkTapRuleAction": { + "type": "object", + "description": "Action that need to performed.", + "properties": { + "type": { + "$ref": "#/definitions/TapRuleActionType", + "description": "Type of actions that can be performed." + }, + "truncate": { + "type": "string", + "description": "Truncate. 0 indicates do not truncate.", + "minLength": 1 + }, + "isTimestampEnabled": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "The parameter to enable or disable the timestamp." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + }, + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration.", + "minLength": 1 + } + } + }, + "NetworkTapRuleActionPatch": { + "type": "object", + "description": "Action that need to performed.", + "properties": { + "type": { + "$ref": "#/definitions/TapRuleActionType", + "description": "Type of actions that can be performed." + }, + "truncate": { + "type": "string", + "description": "Truncate. 0 indicates do not truncate.", + "minLength": 1 + }, + "isTimestampEnabled": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "The parameter to enable or disable the timestamp." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + }, + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration.", + "minLength": 1 + } + } + }, + "NetworkTapRuleListResult": { + "type": "object", + "description": "The response of a NetworkTapRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkTapRule items on this page", + "items": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkTapRuleMatchCondition": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchCondition", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchCondition", + "description": "IP condition that needs to be matched." + }, + "encapsulationType": { + "type": "string", + "description": "Encapsulation Type that needs to be matched.", + "default": "None", + "enum": [ + "None", + "GTPv1" + ], + "x-ms-enum": { + "name": "EncapsulationType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None EncapsulationType" + }, + { + "name": "GTPv1", + "value": "GTPv1", + "description": "GTPv1 EncapsulationType" + } + ] + } + }, + "portCondition": { + "$ref": "#/definitions/PortCondition", + "description": "Defines the port condition that needs to be matched." + } + } + }, + "NetworkTapRuleMatchConditionPatch": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchConditionPatch", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchConditionPatch", + "description": "IP condition that needs to be matched." + }, + "encapsulationType": { + "$ref": "#/definitions/EncapsulationType", + "description": "Encapsulation Type that needs to be matched." + }, + "portCondition": { + "$ref": "#/definitions/PortConditionPatch", + "description": "Defines the port condition that needs to be matched." + } + } + }, + "NetworkTapRuleMatchConfiguration": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration..", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchCondition" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleAction" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapRuleMatchConfigurationPatch": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration..", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchConditionPatch" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleActionPatch" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapRulePatch": { + "type": "object", + "description": "The NetworkTapRule resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkTapRulePatchProperties", + "description": "Network Tap Rule Patch properties." + } + } + }, + "NetworkTapRulePatchProperties": { + "type": "object", + "description": "Network Tap Rule Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Network Tap Rule." + }, + "tapRulesUrl": { + "type": "string", + "format": "uri", + "description": "Network Tap Rules file URL." + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapRuleProperties": { + "type": "object", + "description": "Network Tap Rule Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Network Tap Rule." + }, + "tapRulesUrl": { + "type": "string", + "format": "uri", + "description": "Network Tap Rules file URL." + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "networkTapId": { + "type": "string", + "description": "The ARM resource Id of the NetworkTap.", + "readOnly": true + }, + "pollingIntervalInSeconds": { + "type": "number", + "description": "Polling interval in seconds.", + "default": 30, + "enum": [ + 30, + 60, + 90, + 120 + ], + "x-ms-enum": { + "name": "PollingIntervalInSeconds", + "modelAsString": true, + "values": [ + { + "name": "Thirty", + "value": 30, + "description": "30 PollingIntervalInSeconds" + }, + { + "name": "sixty", + "value": 60, + "description": "60 PollingIntervalInSeconds" + }, + { + "name": "Ninety", + "value": 90, + "description": "90 PollingIntervalInSeconds" + }, + { + "name": "OneTwenty", + "value": 120, + "description": "120 PollingIntervalInSeconds" + } + ] + } + }, + "lastSyncedTime": { + "type": "string", + "format": "date-time", + "description": "The last sync timestamp.", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "configurationType" + ] + }, + "NetworkToNetworkInterconnect": { + "type": "object", + "description": "The Network To Network Interconnect resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkToNetworkInterconnectProperties", + "description": "The NetworkToNetworkInterconnect Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkToNetworkInterconnectListResult": { + "type": "object", + "description": "The response of a NetworkToNetworkInterconnect list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkToNetworkInterconnect items on this page", + "items": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkToNetworkInterconnectPatch": { + "type": "object", + "description": "The Network To Network Interconnect resource patch definition.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. E.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. E.g. 'Microsoft.Compute/virtualMachines' or 'Microsoft.Storage/storageAccounts'", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/NetworkToNetworkInterconnectPatchProperties", + "description": "Resource properties." + } + } + }, + "NetworkToNetworkInterconnectPatchProperties": { + "type": "object", + "description": "Network Tap Rule Patch properties.", + "properties": { + "layer2Configuration": { + "$ref": "#/definitions/Layer2ConfigurationPatch", + "description": "Common properties for Layer2Configuration." + }, + "optionBLayer3Configuration": { + "$ref": "#/definitions/OptionBLayer3ConfigurationPatchProperties", + "description": "Common properties for Layer3Configuration." + }, + "npbStaticRouteConfiguration": { + "$ref": "#/definitions/NpbStaticRouteConfigurationPatch", + "description": "NPB Static Route Configuration properties." + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicyInformationPatch", + "description": "Import Route Policy information." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicyInformationPatch", + "description": "Export Route Policy information" + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + } + } + }, + "NetworkToNetworkInterconnectProperties": { + "type": "object", + "description": "Configuration used to setup CE-PE connectivity.", + "properties": { + "nniType": { + "type": "string", + "description": "Type of NNI used. Example: CE | NPB", + "default": "CE", + "enum": [ + "CE", + "NPB" + ], + "x-ms-enum": { + "name": "NniType", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "NniType-CE(Customer Edge)." + }, + { + "name": "NPB", + "value": "NPB", + "description": "NniType-NPB(Network Packet Broker)." + } + ] + } + }, + "isManagementType": { + "type": "string", + "description": "Configuration to use NNI for Infrastructure Management. Example: True/False.", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsManagementType", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsManagementType-True" + }, + { + "name": "False", + "value": "False", + "description": "IsManagementType-False" + } + ] + } + }, + "useOptionB": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Based on this option layer3 parameters are mandatory. Example: True/False" + }, + "layer2Configuration": { + "$ref": "#/definitions/Layer2Configuration", + "description": "Common properties for Layer2 Configuration." + }, + "optionBLayer3Configuration": { + "$ref": "#/definitions/OptionBLayer3Configuration", + "description": "Common properties for Layer3Configuration." + }, + "npbStaticRouteConfiguration": { + "$ref": "#/definitions/NpbStaticRouteConfiguration", + "description": "NPB Static Route Configuration properties." + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicyInformation", + "description": "Import Route Policy information." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicyInformation", + "description": "Export Route Policy information" + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "useOptionB" + ] + }, + "NpbStaticRouteConfiguration": { + "type": "object", + "description": "NPB Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD Configuration properties." + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "NpbStaticRouteConfigurationPatch": { + "type": "object", + "description": "NPB Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD Configuration properties." + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "OptionBLayer3Configuration": { + "type": "object", + "description": "OptionB Layer3 Configuration properties.", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "ASN of PE devices for CE/PE connectivity.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "VLAN for CE/PE Layer 3 connectivity.Example : 501", + "minimum": 100, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "readOnly": true + } + }, + "required": [ + "peerASN", + "vlanId" + ] + }, + "OptionBLayer3ConfigurationPatchProperties": { + "type": "object", + "description": "Common properties for Layer3Configuration.", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "ASN of PE devices for CE/PE connectivity.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "VLAN for CE/PE Layer 3 connectivity.Example : 501", + "minimum": 100, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "readOnly": true + } + } + }, + "PeeringOption": { + "type": "string", + "description": "Peering option list.", + "enum": [ + "OptionA", + "OptionB" + ], + "x-ms-enum": { + "name": "PeeringOption", + "modelAsString": true, + "values": [ + { + "name": "OptionA", + "value": "OptionA", + "description": "PeeringOption-OptionA" + }, + { + "name": "OptionB", + "value": "OptionB", + "description": "PeeringOption-OptionB" + } + ] + } + }, + "PollingType": { + "type": "string", + "description": "Polling type.", + "enum": [ + "Pull", + "Push" + ], + "x-ms-enum": { + "name": "PollingType", + "modelAsString": true, + "values": [ + { + "name": "Pull", + "value": "Pull", + "description": "PollingType-Pull" + }, + { + "name": "Push", + "value": "Push", + "description": "PollingType-Push" + } + ] + } + }, + "PortCondition": { + "type": "object", + "description": "Port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + } + }, + "required": [ + "layer4Protocol" + ] + }, + "PortConditionPatch": { + "type": "object", + "description": "Port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + } + } + }, + "PortGroupPatchProperties": { + "type": "object", + "description": "Port Group Properties", + "properties": { + "name": { + "type": "string", + "description": "The name of the port group.", + "minLength": 1 + }, + "ports": { + "type": "array", + "description": "List of the ports that need to be matched.", + "items": { + "type": "string" + } + } + } + }, + "PortGroupProperties": { + "type": "object", + "description": "Port Group properties.", + "properties": { + "name": { + "type": "string", + "description": "The name of the port group.", + "minLength": 1 + }, + "ports": { + "type": "array", + "description": "List of the ports that need to be matched.", + "items": { + "type": "string" + } + } + } + }, + "PortType": { + "type": "string", + "description": "Port type that needs to be matched.", + "enum": [ + "SourcePort", + "DestinationPort" + ], + "x-ms-enum": { + "name": "PortType", + "modelAsString": true, + "values": [ + { + "name": "SourcePort", + "value": "SourcePort", + "description": "PortType SourcePort" + }, + { + "name": "DestinationPort", + "value": "DestinationPort", + "description": "PortType DestinationPort" + } + ] + } + }, + "PrefixType": { + "type": "string", + "description": "IP Prefix Type that needs to be matched.", + "enum": [ + "Prefix", + "LongestPrefix" + ], + "x-ms-enum": { + "name": "PrefixType", + "modelAsString": true, + "values": [ + { + "name": "Prefix", + "value": "Prefix", + "description": "PrefixType Prefix" + }, + { + "name": "LongestPrefix", + "value": "LongestPrefix", + "description": "PrefixType LongestPrefix" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The current provisioning state.", + "enum": [ + "Accepted", + "Succeeded", + "Updating", + "Deleting", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted", + "description": "Accepted Provisioning State" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded Provisioning State" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating Provisioning State" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deleting Provisioning State" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Provisioning State" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Canceled Provisioning State" + } + ] + }, + "readOnly": true + }, + "RebootProperties": { + "type": "object", + "description": "Reboot properties.", + "properties": { + "rebootType": { + "$ref": "#/definitions/RebootType", + "description": "Type of reboot to be performed. Example: GracefulRebootWithZTP" + } + } + }, + "RebootType": { + "type": "string", + "description": "Type of reboot to be performed. Example: GracefulRebootWithZTP", + "enum": [ + "GracefulRebootWithZTP", + "GracefulRebootWithoutZTP", + "UngracefulRebootWithZTP", + "UngracefulRebootWithoutZTP" + ], + "x-ms-enum": { + "name": "RebootType", + "modelAsString": true, + "values": [ + { + "name": "GracefulRebootWithZTP", + "value": "GracefulRebootWithZTP", + "description": "RebootType GracefulRebootWithZTP" + }, + { + "name": "GracefulRebootWithoutZTP", + "value": "GracefulRebootWithoutZTP", + "description": "RebootType GracefulRebootWithoutZTP" + }, + { + "name": "UngracefulRebootWithZTP", + "value": "UngracefulRebootWithZTP", + "description": "RebootType UngracefulRebootWithZTP" + }, + { + "name": "UngracefulRebootWithoutZTP", + "value": "UngracefulRebootWithoutZTP", + "description": "RebootType UngracefulRebootWithoutZTP" + } + ] + } + }, + "RedistributeConnectedSubnets": { + "type": "string", + "description": "Advertise Connected Subnets. Ex: \"True\" | \"False\".", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeConnectedSubnets", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeConnectedSubnets-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeConnectedSubnets-False" + } + ] + } + }, + "RedistributeStaticRoutes": { + "type": "string", + "description": "Advertise Static Routes. Ex: \"True\" | \"False\".", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeStaticRoutes", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeStaticRoutes-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeStaticRoutes-False" + } + ] + } + }, + "RoutePolicy": { + "type": "object", + "description": "The RoutePolicy resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/RoutePolicyProperties", + "description": "The RoutePolicy properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RoutePolicyActionType": { + "type": "string", + "description": "Action type. Example: Permit | Deny | Continue.", + "enum": [ + "Permit", + "Deny", + "Continue" + ], + "x-ms-enum": { + "name": "RoutePolicyActionType", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "RoutePolicyActionType-Permit" + }, + { + "name": "Deny", + "value": "Deny", + "description": "RoutePolicyActionType-Deny" + }, + { + "name": "Continue", + "value": "Continue", + "description": "RoutePolicyActionType-Continue" + } + ] + } + }, + "RoutePolicyConditionType": { + "type": "string", + "description": "Type of the condition used.", + "enum": [ + "Or", + "And" + ], + "x-ms-enum": { + "name": "RoutePolicyConditionType", + "modelAsString": true, + "values": [ + { + "name": "Or", + "value": "Or", + "description": "RoutePolicyConditionType-Or" + }, + { + "name": "And", + "value": "And", + "description": "RoutePolicyConditionType-And" + } + ] + } + }, + "RoutePolicyListResult": { + "type": "object", + "description": "The response of a RoutePolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RoutePolicy items on this page", + "items": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RoutePolicyPatch": { + "type": "object", + "description": "The Route Policy patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/RoutePolicyPatchableProperties", + "description": "The RoutePolicy patchable properties." + } + } + }, + "RoutePolicyPatchableProperties": { + "type": "object", + "description": "Route Policy patchable properties.", + "properties": { + "defaultAction": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny." + }, + "statements": { + "type": "array", + "description": "Route Policy statements.", + "items": { + "$ref": "#/definitions/RoutePolicyStatementPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "RoutePolicyProperties": { + "type": "object", + "description": "RoutePolicyProperties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "defaultAction": { + "type": "string", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny.", + "default": "Deny", + "enum": [ + "Permit", + "Deny" + ], + "x-ms-enum": { + "name": "CommunityActionTypes", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Permit Community Action Types" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny Community Action Types" + } + ] + } + }, + "statements": { + "type": "array", + "description": "Route Policy statements.", + "items": { + "$ref": "#/definitions/RoutePolicyStatementProperties" + }, + "x-ms-identifiers": [ + "sequenceNumber" + ] + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "Arm Resource ID of Network Fabric.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "addressFamilyType": { + "type": "string", + "description": "AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.", + "default": "IPv4", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "AddressFamilyType", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "AddressType-IPv4" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "AddressType-IPv6" + } + ] + } + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "statements", + "networkFabricId" + ] + }, + "RoutePolicyStatementPatchProperties": { + "type": "object", + "description": "Route Policy Statement properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route.", + "minimum": 1, + "maximum": 4294967295 + }, + "condition": { + "$ref": "#/definitions/StatementConditionPatchProperties", + "description": "Route policy condition properties." + }, + "action": { + "$ref": "#/definitions/StatementActionPatchProperties", + "description": "Route policy action properties." + } + }, + "required": [ + "sequenceNumber", + "condition", + "action" + ] + }, + "RoutePolicyStatementProperties": { + "type": "object", + "description": "Route Policy Statement properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route.", + "minimum": 1, + "maximum": 4294967295 + }, + "condition": { + "$ref": "#/definitions/StatementConditionProperties", + "description": "Route policy condition properties." + }, + "action": { + "$ref": "#/definitions/StatementActionProperties", + "description": "Route policy action properties." + } + }, + "required": [ + "sequenceNumber", + "condition", + "action" + ] + }, + "RouteTargetInformation": { + "type": "object", + "description": "Route Target Configuration.", + "properties": { + "importIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE.", + "items": { + "type": "string" + } + }, + "importIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes from CE.", + "items": { + "type": "string" + } + }, + "exportIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes into CE.", + "items": { + "type": "string" + } + }, + "exportIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE.", + "items": { + "type": "string" + } + } + } + }, + "RouteTargetPatchInformation": { + "type": "object", + "description": "Route Target Configuration.", + "properties": { + "importIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE.", + "items": { + "type": "string" + } + }, + "importIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes from CE.", + "items": { + "type": "string" + } + }, + "exportIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes into CE.", + "items": { + "type": "string" + } + }, + "exportIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE.", + "items": { + "type": "string" + } + } + } + }, + "RuleProperties": { + "type": "object", + "description": "Rules for the InternetGateways", + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Specify action." + }, + "addressList": { + "type": "array", + "description": "List of Addresses to be allowed or denied.", + "items": { + "type": "string" + } + } + }, + "required": [ + "action", + "addressList" + ] + }, + "SourceDestinationType": { + "type": "string", + "description": "IP Address type that needs to be matched.", + "enum": [ + "SourceIP", + "DestinationIP" + ], + "x-ms-enum": { + "name": "SourceDestinationType", + "modelAsString": true, + "values": [ + { + "name": "SourceIP", + "value": "SourceIP", + "description": "SourceDestinationType SourceIP" + }, + { + "name": "DestinationIP", + "value": "DestinationIP", + "description": "SourceDestinationType DestinationIP" + } + ] + } + }, + "StatementActionPatchProperties": { + "type": "object", + "description": "Route policy action properties", + "properties": { + "localPreference": { + "type": "integer", + "format": "int64", + "description": "Local Preference of the route policy.", + "minimum": 0, + "maximum": 4294967295 + }, + "actionType": { + "$ref": "#/definitions/RoutePolicyActionType", + "description": "Action type. Example: Permit | Deny | Continue." + }, + "ipCommunityProperties": { + "$ref": "#/definitions/ActionIpCommunityPatchProperties", + "description": "IP Community Properties." + }, + "ipExtendedCommunityProperties": { + "$ref": "#/definitions/ActionIpExtendedCommunityPatchProperties", + "description": "IP Extended Community Properties." + } + }, + "required": [ + "actionType" + ] + }, + "StatementActionProperties": { + "type": "object", + "description": "Route policy action properties.", + "properties": { + "localPreference": { + "type": "integer", + "format": "int64", + "description": "Local Preference of the route policy.", + "minimum": 0, + "maximum": 4294967295 + }, + "actionType": { + "$ref": "#/definitions/RoutePolicyActionType", + "description": "Action type. Example: Permit | Deny | Continue." + }, + "ipCommunityProperties": { + "$ref": "#/definitions/ActionIpCommunityProperties", + "description": "IP Community Properties." + }, + "ipExtendedCommunityProperties": { + "$ref": "#/definitions/ActionIpExtendedCommunityProperties", + "description": "IP Extended Community Properties." + } + }, + "required": [ + "actionType" + ] + }, + "StatementConditionPatchProperties": { + "type": "object", + "description": "Route policy statement condition properties.", + "properties": { + "ipCommunityIds": { + "type": "array", + "description": "List of IP Community resource IDs.", + "items": { + "type": "string" + } + }, + "ipExtendedCommunityIds": { + "type": "array", + "description": "List of IP Extended Community resource IDs.", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/definitions/RoutePolicyConditionType", + "description": "Type of the condition used." + }, + "ipPrefixId": { + "type": "string", + "description": "Arm Resource Id of IpPrefix." + } + } + }, + "StatementConditionProperties": { + "type": "object", + "description": "Route policy statement condition properties.", + "properties": { + "ipCommunityIds": { + "type": "array", + "description": "List of IP Community resource IDs.", + "items": { + "type": "string" + } + }, + "ipExtendedCommunityIds": { + "type": "array", + "description": "List of IP Extended Community resource IDs.", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "Type of the condition used.", + "default": "Or", + "enum": [ + "Or", + "And" + ], + "x-ms-enum": { + "name": "RoutePolicyConditionType", + "modelAsString": true, + "values": [ + { + "name": "Or", + "value": "Or", + "description": "RoutePolicyConditionType-Or" + }, + { + "name": "And", + "value": "And", + "description": "RoutePolicyConditionType-And" + } + ] + } + }, + "ipPrefixId": { + "type": "string", + "description": "Arm Resource Id of IpPrefix." + } + } + }, + "StaticRouteConfiguration": { + "type": "object", + "description": "Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "extension": { + "type": "string", + "description": "Extension. Example: NoExtension | NPB.", + "default": "NoExtension", + "enum": [ + "NoExtension", + "NPB" + ], + "x-ms-enum": { + "name": "Extension", + "modelAsString": true, + "values": [ + { + "name": "NoExtension", + "value": "NoExtension", + "description": "Extension-NoExtension" + }, + { + "name": "NPB", + "value": "NPB", + "description": "Extension-NPB" + } + ] + } + } + } + }, + "StaticRoutePatchConfiguration": { + "type": "object", + "description": "Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "StaticRoutePatchProperties": { + "type": "object", + "description": "Route Properties.", + "properties": { + "prefix": { + "type": "string", + "description": "Prefix of the route.", + "minLength": 1 + }, + "nextHop": { + "type": "array", + "description": "List of next hop addresses.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "prefix", + "nextHop" + ] + }, + "StaticRouteProperties": { + "type": "object", + "description": "Route Properties.", + "properties": { + "prefix": { + "type": "string", + "description": "Prefix of the route.", + "minLength": 1 + }, + "nextHop": { + "type": "array", + "description": "List of next hop addresses.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "prefix", + "nextHop" + ] + }, + "SupportedConnectorProperties": { + "type": "object", + "description": "Supported connector properties.", + "properties": { + "connectorType": { + "type": "string", + "description": "Type of connector used. Example: Optical." + }, + "maxSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Maximum speed of the connector in Mbps." + } + } + }, + "SupportedVersionProperties": { + "type": "object", + "description": "Supported version details of the network device.", + "properties": { + "version": { + "type": "string", + "description": "Operating system and firmware combined versions." + }, + "vendorOsVersion": { + "type": "string", + "description": "Operating system version." + }, + "vendorFirmwareVersion": { + "type": "string", + "description": "Firmware version." + }, + "isDefault": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "If true newly provisioned Fabric will use this device version by default to bootstrap the network devices for the first time." + } + } + }, + "TapRuleActionType": { + "type": "string", + "description": "Type of actions that can be performed.", + "enum": [ + "Drop", + "Count", + "Log", + "Replicate", + "Goto", + "Redirect", + "Mirror" + ], + "x-ms-enum": { + "name": "TapRuleActionType", + "modelAsString": true, + "values": [ + { + "name": "Drop", + "value": "Drop", + "description": "TapRuleActionType-Drop" + }, + { + "name": "Count", + "value": "Count", + "description": "TapRuleActionType-Count" + }, + { + "name": "Log", + "value": "Log", + "description": "TapRuleActionType-Log" + }, + { + "name": "Replicate", + "value": "Replicate", + "description": "TapRuleActionType-Replicate" + }, + { + "name": "Goto", + "value": "Goto", + "description": "TapRuleActionType-Goto" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "TapRuleActionType-Redirect" + }, + { + "name": "Mirror", + "value": "Mirror", + "description": "TapRuleActionType-Mirror" + } + ] + } + }, + "TerminalServerConfiguration": { + "type": "object", + "description": "Network and credentials configuration currently applied to terminal server.", + "properties": { + "username": { + "type": "string", + "description": "Username for the terminal server connection.", + "minLength": 1 + }, + "password": { + "type": "string", + "format": "password", + "description": "Password for the terminal server connection.", + "minLength": 1, + "x-ms-secret": true + }, + "serialNumber": { + "type": "string", + "description": "Serial Number of Terminal server.", + "minLength": 1 + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "networkDeviceId": { + "type": "string", + "description": "ARM Resource ID used for the NetworkDevice.", + "readOnly": true + } + }, + "required": [ + "username", + "password", + "primaryIpv4Prefix", + "secondaryIpv4Prefix" + ] + }, + "TerminalServerPatchConfiguration": { + "type": "object", + "description": "Network and credentials configuration already applied to terminal server.", + "properties": { + "username": { + "type": "string", + "description": "Username for the terminal server connection.", + "minLength": 1 + }, + "password": { + "type": "string", + "format": "password", + "description": "Password for the terminal server connection.", + "minLength": 1, + "x-ms-secret": true + }, + "serialNumber": { + "type": "string", + "description": "Serial Number of Terminal server.", + "minLength": 1 + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + } + } + }, + "UpdateAdministrativeState": { + "type": "object", + "description": "Update administrative state on list of resources.", + "properties": { + "resourceIds": { + "type": "array", + "description": "Network Fabrics or Network Rack resource Id.", + "items": { + "type": "string" + } + }, + "state": { + "$ref": "#/definitions/EnableDisableState", + "description": "Administrative state." + } + } + }, + "UpdateDeviceAdministrativeState": { + "type": "object", + "description": "Update the administrative state on list of resources.", + "properties": { + "resourceIds": { + "type": "array", + "description": "Network Fabrics or Network Rack resource Id.", + "items": { + "type": "string" + } + }, + "state": { + "$ref": "#/definitions/DeviceAdministrativeState", + "description": "Administrative state." + } + } + }, + "UpdateVersion": { + "type": "object", + "description": "Update version properties.", + "properties": { + "version": { + "type": "string", + "description": "Specify the version." + } + } + }, + "UpgradeNetworkFabricProperties": { + "type": "object", + "description": "Model used for Upgrade Network Fabric Properties", + "properties": { + "version": { + "type": "string", + "description": "Specify the version." + }, + "action": { + "$ref": "#/definitions/NetworkFabricUpgradeAction", + "description": "Action to be performed while upgrading the fabric." + } + } + }, + "ValidateAction": { + "type": "string", + "description": "Validate action that to be performed", + "enum": [ + "Cabling", + "Configuration", + "Connectivity" + ], + "x-ms-enum": { + "name": "ValidateAction", + "modelAsString": true, + "values": [ + { + "name": "Cabling", + "value": "Cabling", + "description": "ValidateAction-Cabling" + }, + { + "name": "Configuration", + "value": "Configuration", + "description": "ValidateAction-Configuration" + }, + { + "name": "Connectivity", + "value": "Connectivity", + "description": "ValidateAction-Connectivity" + } + ] + } + }, + "ValidateConfigurationProperties": { + "type": "object", + "description": "Validation configuration properties.", + "properties": { + "validateAction": { + "$ref": "#/definitions/ValidateAction", + "description": "Validate action that to be performed" + } + } + }, + "ValidateConfigurationResponse": { + "type": "object", + "description": "The response of the action validate configuration.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "URL for the details of the response." + } + } + }, + "VlanGroupPatchProperties": { + "type": "object", + "description": "Vlan group properties.", + "properties": { + "name": { + "type": "string", + "description": "Vlan group name.", + "minLength": 1 + }, + "vlans": { + "type": "array", + "description": "List of vlans.", + "items": { + "type": "string" + } + } + } + }, + "VlanGroupProperties": { + "type": "object", + "description": "Vlan group properties.", + "properties": { + "name": { + "type": "string", + "description": "Vlan group name.", + "minLength": 1 + }, + "vlans": { + "type": "array", + "description": "List of vlans.", + "items": { + "type": "string" + } + } + } + }, + "VlanMatchCondition": { + "type": "object", + "description": "The vlan match conditions that need to be matched.", + "properties": { + "vlans": { + "type": "array", + "description": "List of vlans that need to be matched. Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "innerVlans": { + "type": "array", + "description": "List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanGroupNames": { + "type": "array", + "description": "List of vlan group names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "VlanMatchConditionPatch": { + "type": "object", + "description": "The vlan match conditions that need to be matched.", + "properties": { + "vlans": { + "type": "array", + "description": "List of vlans that need to be matched. Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "innerVlans": { + "type": "array", + "description": "List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanGroupNames": { + "type": "array", + "description": "List of vlan group names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "VpnConfigurationPatchableProperties": { + "type": "object", + "description": "Network and credential configuration currently applied on terminal server.", + "properties": { + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network To Network Interconnect.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/VpnOptionBPatchProperties", + "description": "option B properties" + }, + "optionAProperties": { + "$ref": "#/definitions/VpnOptionAPatchProperties", + "description": "option A properties" + } + } + }, + "VpnConfigurationProperties": { + "type": "object", + "description": "Network and credential configuration currently applied on terminal server.", + "properties": { + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network To Network Interconnect.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/VpnOptionBProperties", + "description": "option B properties" + }, + "optionAProperties": { + "$ref": "#/definitions/VpnOptionAProperties", + "description": "option A properties" + } + }, + "required": [ + "peeringOption" + ] + }, + "VpnOptionAPatchProperties": { + "type": "object", + "description": "Peering optionA properties", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan Id.Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD Configuration properties." + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + } + } + }, + "VpnOptionAProperties": { + "type": "object", + "description": "option A properties", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan Id.Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD Configuration properties." + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + } + }, + "required": [ + "vlanId", + "peerASN" + ] + }, + "VpnOptionBPatchProperties": { + "type": "object", + "description": "Option B configuration to be used for Management VPN.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetPatchInformation", + "description": "Route Targets to be applied." + } + } + }, + "VpnOptionBProperties": { + "type": "object", + "description": "Option B configuration to be used for Management VPN.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetInformation", + "description": "Route Targets to be applied." + } + } + }, + "WellKnownCommunities": { + "type": "string", + "description": "`Internet` - Advertise routes to internet community.\n`LocalAS` - Advertise routes to only localAS peers.\n`NoAdvertise` - Don't advertise routes to any peer.\n`NoExport` - Don't export to next AS.\n`GShut` - Graceful Shutdown (GSHUT) withdraw routes before terminating BGP connection.", + "enum": [ + "Internet", + "LocalAS", + "NoAdvertise", + "NoExport", + "GShut" + ], + "x-ms-enum": { + "name": "WellKnownCommunities", + "modelAsString": true, + "values": [ + { + "name": "Internet", + "value": "Internet", + "description": "WellKnownCommunities-Internet" + }, + { + "name": "LocalAS", + "value": "LocalAS", + "description": "WellKnownCommunities-LocalAS" + }, + { + "name": "NoAdvertise", + "value": "NoAdvertise", + "description": "WellKnownCommunities-NoAdvertise" + }, + { + "name": "NoExport", + "value": "NoExport", + "description": "WellKnownCommunities-NoExport" + }, + { + "name": "GShut", + "value": "GShut", + "description": "WellKnownCommunities-GShut" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Create.json new file mode 100644 index 000000000000..0a1fffd3c3f9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Create.json @@ -0,0 +1,457 @@ +{ + "title": "AccessControlLists_Create_MaximumSet_Gen", + "operationId": "AccessControlLists_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + } + }, + "tags": { + "keyID": "keyValue" + }, + "location": "eastUs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Delete.json new file mode 100644 index 000000000000..3cefd65c2e0e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AccessControlLists_Delete_MaximumSet_Gen", + "operationId": "AccessControlLists_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Get.json new file mode 100644 index 000000000000..e9d396a65713 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Get.json @@ -0,0 +1,166 @@ +{ + "title": "AccessControlLists_Get_MaximumSet_Gen", + "operationId": "AccessControlLists_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ListByResourceGroup.json new file mode 100644 index 000000000000..cba54d8fba1e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ListByResourceGroup.json @@ -0,0 +1,170 @@ +{ + "title": "AccessControlLists_ListByResourceGroup_MaximumSet_Gen", + "operationId": "AccessControlLists_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ListBySubscription.json new file mode 100644 index 000000000000..123cae6f5ddd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ListBySubscription.json @@ -0,0 +1,169 @@ +{ + "title": "AccessControlLists_ListBySubscription_MaximumSet_Gen", + "operationId": "AccessControlLists_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Resync.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Resync.json new file mode 100644 index 000000000000..01d3ca5bd192 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "AccessControlLists_Resync_MaximumSet_Gen", + "operationId": "AccessControlLists_Resync", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Update.json new file mode 100644 index 000000000000..d46cf9755223 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_Update.json @@ -0,0 +1,304 @@ +{ + "title": "AccessControlLists_Update_MaximumSet_Gen", + "operationId": "AccessControlLists_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "configurationType": "File", + "aclsUrl": "https://microsoft.com/a", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "protocolNeighbors": [ + "example-neighbor" + ], + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "example-remark", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "aclsUrl": "https://ACL-Storage-URL", + "defaultAction": "Permit", + "matchConfigurations": [ + { + "matchConfigurationName": "example-match", + "sequenceNumber": 123, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "etherTypes": [ + "0x1" + ], + "fragments": [ + "0xff00-0xffff" + ], + "ipLengths": [ + "4094-9214" + ], + "ttlValues": [ + "23" + ], + "dscpMarkings": [ + "32" + ], + "protocolNeighbors": [ + "example-neighbor" + ], + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "1-20" + ], + "portGroupNames": [ + "example-portGroup" + ], + "flags": [ + "established" + ] + }, + "icmpConfiguration": { + "icmpTypes": [ + "echo" + ] + } + } + ], + "actions": [ + { + "type": "Count", + "counterName": "example-counter", + "remarkComment": "remark-comment", + "policeRateConfiguration": { + "bitRate": { + "rate": 15, + "unit": "bps" + }, + "burstSize": { + "size": 2, + "unit": "Bytes" + } + } + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "lastSyncedTime": "2023-06-17T08:56:23.203Z", + "aclType": "ControlPlaneTrafficPolicy", + "deviceRole": "CE", + "globalAccessControlListActions": { + "enableCount": "True" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "keyValue" + }, + "location": "eastUs", + "id": "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "name": "example-acl", + "type": "microsoft.managednetworkfabric/accessControlLists", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_UpdateAdministrativeState.json new file mode 100644 index 000000000000..a7b43bbb1a22 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "AccessControlLists_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "AccessControlLists_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ValidateConfiguration.json new file mode 100644 index 000000000000..81b6a94e7b8f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/AccessControlLists_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "AccessControlLists_ValidateConfiguration_MaximumSet_Gen", + "operationId": "AccessControlLists_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "accessControlListName": "example-acl" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Create.json new file mode 100644 index 000000000000..70996a3338d7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Create.json @@ -0,0 +1,351 @@ +{ + "title": "ExternalNetworks_Create_MaximumSet_Gen", + "operationId": "ExternalNetworks_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "resource": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Delete.json new file mode 100644 index 000000000000..18cc361079eb --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "ExternalNetworks_Delete_MaximumSet_Gen", + "operationId": "ExternalNetworks_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Get.json new file mode 100644 index 000000000000..998babe4aebc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Get.json @@ -0,0 +1,132 @@ +{ + "title": "ExternalNetworks_Get_MaximumSet_Gen", + "operationId": "ExternalNetworks_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..bec10c2d0cfe --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,136 @@ +{ + "title": "ExternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "ExternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 14, + "threshold": 17, + "idleTimeExpiry": 7 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/14", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Update.json new file mode 100644 index 000000000000..44f02e6664ff --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_Update.json @@ -0,0 +1,211 @@ +{ + "title": "ExternalNetworks_Update_MaximumSet_Gen", + "operationId": "ExternalNetworks_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "properties": { + "properties": { + "annotation": "annotation1", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "peerASN": 65047, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled", + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 13, + "threshold": 24, + "idleTimeExpiry": 8 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 13, + "threshold": 24, + "idleTimeExpiry": 8 + } + ] + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/14", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10039" + ], + "exportRouteTargets": [ + "65046:10039" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "primaryIpv4Prefix": "10.1.1.0/30", + "primaryIpv6Prefix": "3FFE:FFFF:0:CD30::a0/126", + "secondaryIpv4Prefix": "10.1.1.4/30", + "secondaryIpv6Prefix": "3FFE:FFFF:0:CD30::a4/126", + "mtu": 1500, + "vlanId": 1001, + "fabricASN": 1234, + "peerASN": 65047, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "bmpConfiguration": { + "configurationState": "Enabled" + } + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/externalNetworks/example-externalnetwork", + "name": "example-externalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/externalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..b99bfe2d77a5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "ExternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "ExternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_UpdateBfdAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_UpdateBfdAdministrativeState.json new file mode 100644 index 000000000000..91034d0e614a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/ExternalNetworks_UpdateBfdAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "ExternalNetworks_UpdateBfdAdministrativeState", + "operationId": "ExternalNetworks_UpdateBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-externalnetwork", + "externalNetworkName": "example-ext", + "body": { + "routeType": "Static", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "routeType": "Static", + "administrativeState": "Enable", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Create.json new file mode 100644 index 000000000000..8aacf8f265c4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Create.json @@ -0,0 +1,397 @@ +{ + "title": "InternalNetworks_Create_MaximumSet_Gen", + "operationId": "InternalNetworks_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "resource": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Delete.json new file mode 100644 index 000000000000..5f00e70f4ee8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "InternalNetworks_Delete_MaximumSet_Gen", + "operationId": "InternalNetworks_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Get.json new file mode 100644 index 000000000000..ccc0f105724f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Get.json @@ -0,0 +1,148 @@ +{ + "title": "InternalNetworks_Get_MaximumSet_Gen", + "operationId": "InternalNetworks_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1/24" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_ListByL3IsolationDomain.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_ListByL3IsolationDomain.json new file mode 100644 index 000000000000..226e7ae9b7c1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_ListByL3IsolationDomain.json @@ -0,0 +1,152 @@ +{ + "title": "InternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen", + "operationId": "InternalNetworks_ListByL3IsolationDomain", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1/24" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 23, + "threshold": 7, + "idleTimeExpiry": 28 + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Update.json new file mode 100644 index 000000000000..82745398d8ce --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_Update.json @@ -0,0 +1,258 @@ +{ + "title": "InternalNetworks_Update_MaximumSet_Gen", + "operationId": "InternalNetworks_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "properties": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "connectedIPv6Subnets": [ + { + "annotation": "annotation", + "prefix": "10.0.0.0/24" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "ipv6NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.10" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 6, + "idleTimeExpiry": 20 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 6, + "idleTimeExpiry": 20 + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "mtu": 1500, + "connectedIPv4Subnets": [ + { + "prefix": "10.0.0.0/24", + "annotation": "annotation" + } + ], + "connectedIPv6Subnets": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29", + "annotation": "annotation" + } + ], + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/routePolicyName" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "isMonitoringEnabled": "True", + "extension": "NoExtension", + "vlanId": 755, + "bgpConfiguration": { + "annotation": "annotation", + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "defaultRouteOriginate": "True", + "allowAS": 10, + "allowASOverride": "Enable", + "fabricASN": 20, + "peerASN": 61234, + "ipv4ListenRangePrefixes": [ + "10.1.0.0/25" + ], + "ipv6ListenRangePrefixes": [ + "2fff::/66" + ], + "ipv4NeighborAddress": [ + { + "address": "10.1.0.0", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "ipv6NeighborAddress": [ + { + "address": "2fff::", + "bfdAdministrativeState": "Enable", + "bgpAdministrativeState": "Enable", + "configurationState": "Succeeded" + } + ], + "bmpConfiguration": { + "neighborIpExclusions": [ + "10.0.0.1" + ], + "bmpConfigurationState": "Enabled" + }, + "v4OverV6BgpSession": "Enabled", + "v6OverV4BgpSession": "Enabled" + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ], + "extension": "NoExtension" + }, + "nativeIpv4PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 7, + "idleTimeExpiry": 20 + } + ] + }, + "nativeIpv6PrefixLimit": { + "prefixLimits": [ + { + "maximumRoutes": 24, + "threshold": 7, + "idleTimeExpiry": 20 + } + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "name": "example-internalnetwork", + "type": "microsoft.managednetworkfabric/l3IsolationDomains/internalnetworks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateAdministrativeState.json new file mode 100644 index 000000000000..e478dbdd8557 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "InternalNetworks_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateBfdAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateBfdAdministrativeState.json new file mode 100644 index 000000000000..8a6aaf9a9d29 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateBfdAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "InternalNetworks_UpdateBfdAdministrativeState", + "operationId": "InternalNetworks_UpdateBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "routeType": "Static", + "neighborAddress": "10.10.1.10", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "neighborAddressAdministrativeStatus": [ + { + "neighborAddress": "10.10.1.10", + "administrativeState": "Enable", + "error": "" + } + ], + "error": { + "code": "bidbvvmy", + "message": "ekbarfd", + "target": "wpnbisaqlnidiilkhaadmu", + "details": [], + "additionalInfo": [ + { + "type": "qakayuauodscmplibrcmvrnvfnia", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateBgpAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateBgpAdministrativeState.json new file mode 100644 index 000000000000..eb416992983f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternalNetworks_UpdateBgpAdministrativeState.json @@ -0,0 +1,45 @@ +{ + "title": "InternalNetworks_UpdateBgpAdministrativeState_MaximumSet_Gen", + "operationId": "InternalNetworks_UpdateBgpAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3isd", + "internalNetworkName": "example-internalnetwork", + "body": { + "neighborAddress": "10.10.10.10", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "neighborAddressAdministrativeStatus": [ + { + "neighborAddress": "10.10.10.10", + "administrativeState": "Enable", + "error": "" + } + ], + "error": { + "code": "bidbvvmy", + "message": "ekbarfd", + "target": "wpnbisaqlnidiilkhaadmu", + "details": [], + "additionalInfo": [ + { + "type": "qakayuauodscmplibrcmvrnvfnia", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Create.json new file mode 100644 index 000000000000..c8e8c74032d3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Create.json @@ -0,0 +1,139 @@ +{ + "title": "InternetGatewayRules_Create_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "resource": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + } + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Delete.json new file mode 100644 index 000000000000..8906fb215958 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGatewayRules_Delete_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Get.json new file mode 100644 index 000000000000..972a8004d9ca --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Get.json @@ -0,0 +1,62 @@ +{ + "title": "InternetGatewayRules_Get_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_ListByResourceGroup.json new file mode 100644 index 000000000000..3ecabbd7f646 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "title": "InternetGatewayRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-internetGatewayRule" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_ListBySubscription.json new file mode 100644 index 000000000000..61659b5d2568 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "title": "InternetGatewayRules_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGatewayRules_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Update.json new file mode 100644 index 000000000000..ea5c146c2d38 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGatewayRules_Update.json @@ -0,0 +1,69 @@ +{ + "title": "InternetGatewayRules_Update_MaximumSet_Gen", + "operationId": "InternetGatewayRules_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayRuleName": "example-internetGatewayRule", + "properties": { + "tags": { + "KeyID": "KeyValue1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotationValue", + "ruleProperties": { + "action": "Allow", + "addressList": [ + "10.10.10.10" + ], + "condition": "Or", + "destinationAddressList": [ + "11.11.10.11" + ], + "sourceAddressList": [ + "10.10.10.10" + ], + "headerAddressList": [ + { + "headerName": "abcHeader", + "addressList": [ + "10.10.10.10" + ] + } + ] + }, + "provisioningState": "Accepted", + "internetGatewayIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ] + }, + "tags": { + "KeyID": "KeyValue1" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-InternetGatewayRule", + "name": "example-internetGatewayRule", + "type": "microsoft.managednetworkfabric/internetGatewayRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Create.json new file mode 100644 index 000000000000..5fc7fc6436f7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Create.json @@ -0,0 +1,86 @@ +{ + "title": "InternetGateways_Create_MaximumSet_Gen", + "operationId": "InternetGateways_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "resource": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Delete.json new file mode 100644 index 000000000000..f67ab2d2ac1b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "InternetGateways_Delete_MaximumSet_Gen", + "operationId": "InternetGateways_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Get.json new file mode 100644 index 000000000000..750ab3e8bd04 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Get.json @@ -0,0 +1,44 @@ +{ + "title": "InternetGateways_Get_MaximumSet_Gen", + "operationId": "InternetGateways_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_ListByResourceGroup.json new file mode 100644 index 000000000000..915937f220af --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_ListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "title": "InternetGateways_ListByResourceGroup_MaximumSet_Gen", + "operationId": "InternetGateways_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_ListBySubscription.json new file mode 100644 index 000000000000..3c7ffd6d0975 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_ListBySubscription.json @@ -0,0 +1,47 @@ +{ + "title": "InternetGateways_ListBySubscription_MaximumSet_Gen", + "operationId": "InternetGateways_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Update.json new file mode 100644 index 000000000000..f64b052f581d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/InternetGateways_Update.json @@ -0,0 +1,54 @@ +{ + "title": "InternetGateways_Update_MaximumSet_Gen", + "operationId": "InternetGateways_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "internetGatewayName": "example-internetGateway", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "internetGatewayRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/example-internetGatewayRule", + "ipv4Address": "10.10.10.10", + "port": 25, + "type": "Infrastructure", + "internetGatewayType": "Infrastructure", + "networkFabricControllerId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkFabricController", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway", + "name": "example-internetGateway", + "type": "microsoft.managednetworkfabric/internetGateways", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Create.json new file mode 100644 index 000000000000..1f13a23728e0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Create.json @@ -0,0 +1,113 @@ +{ + "title": "IpCommunities_Create_MaximumSet_Gen", + "operationId": "IpCommunities_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Delete.json new file mode 100644 index 000000000000..6ca7f53e4766 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpCommunities_Delete_MaximumSet_Gen", + "operationId": "IpCommunities_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Get.json new file mode 100644 index 000000000000..1a0b5dcb42cf --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Get.json @@ -0,0 +1,53 @@ +{ + "title": "IpCommunities_Get_MaximumSet_Gen", + "operationId": "IpCommunities_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..42e841dbeca8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "IpCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_ListBySubscription.json new file mode 100644 index 000000000000..25515ddc7a99 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "IpCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Update.json new file mode 100644 index 000000000000..a5a082201433 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpCommunities_Update.json @@ -0,0 +1,74 @@ +{ + "title": "IpCommunities_Update_MaximumSet_Gen", + "operationId": "IpCommunities_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipCommunityName": "example-ipcommunity", + "properties": { + "tags": { + "keyID": "KeyValue" + }, + "properties": { + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "wellKnownCommunities": [ + "Internet" + ], + "communityMembers": [ + "1:1" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipcommunity", + "name": "example-ipcommunity", + "type": "microsoft.managednetworkfabric/ipcommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Create.json new file mode 100644 index 000000000000..c390472a2cb5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Create.json @@ -0,0 +1,104 @@ +{ + "title": "IpExtendedCommunities_Create_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "resource": { + "properties": { + "annotation": "annotation", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Delete.json new file mode 100644 index 000000000000..24bc034f2b9b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpExtendedCommunities_Delete_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Get.json new file mode 100644 index 000000000000..9d360eef9c5c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Get.json @@ -0,0 +1,50 @@ +{ + "title": "IpExtendedCommunities_Get_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_ListByResourceGroup.json new file mode 100644 index 000000000000..381c30d93453 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "IpExtendedCommunities_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_ListBySubscription.json new file mode 100644 index 000000000000..3c5017672ba1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "IpExtendedCommunities_ListBySubscription_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Update.json new file mode 100644 index 000000000000..308496e4220c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpExtendedCommunities_Update.json @@ -0,0 +1,69 @@ +{ + "title": "IpExtendedCommunities_Update_MaximumSet_Gen", + "operationId": "IpExtendedCommunities_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipExtendedCommunityName": "example-ipExtendedCommunity", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "annotation": "annotation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipExtendedCommunityRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "routeTargets": [ + "1234:2345" + ] + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity", + "name": "example-ipExtendedCommunity", + "type": "microsoft.managednetworkfabric/ipExtendedCommunities", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Create.json new file mode 100644 index 000000000000..1b972143335c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Create.json @@ -0,0 +1,104 @@ +{ + "title": "IpPrefixes_Create_MaximumSet_Gen", + "operationId": "IpPrefixes_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "resource": { + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Delete.json new file mode 100644 index 000000000000..a6378236bb64 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IpPrefixes_Delete_MaximumSet_Gen", + "operationId": "IpPrefixes_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Get.json new file mode 100644 index 000000000000..4e994e543405 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Get.json @@ -0,0 +1,50 @@ +{ + "title": "IpPrefixes_Get_MaximumSet_Gen", + "operationId": "IpPrefixes_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_ListByResourceGroup.json new file mode 100644 index 000000000000..e620afe892e5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "IpPrefixes_ListByResourceGroup_MaximumSet_Gen", + "operationId": "IpPrefixes_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_ListBySubscription.json new file mode 100644 index 000000000000..0fc0d584aae1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "IpPrefixes_ListBySubscription_MaximumSet_Gen", + "operationId": "IpPrefixes_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Update.json new file mode 100644 index 000000000000..5ae33efd32d1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/IpPrefixes_Update.json @@ -0,0 +1,69 @@ +{ + "title": "IpPrefixes_Update_MaximumSet_Gen", + "operationId": "IpPrefixes_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "ipPrefixName": "example-ipPrefix", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "ipPrefixRules": [ + { + "action": "Permit", + "sequenceNumber": 4155123341, + "networkPrefix": "10.10.10.10/30", + "condition": "GreaterThanOrEqualTo", + "subnetMaskLength": "10" + } + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix", + "name": "example-ipPrefix", + "type": "microsoft.managednetworkfabric/ipPrefixes", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..f627d7cdc9fb --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L2IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Create.json new file mode 100644 index 000000000000..8d25ea059ffa --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Create.json @@ -0,0 +1,96 @@ +{ + "title": "L2IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Delete.json new file mode 100644 index 000000000000..fd833e932122 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L2IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Get.json new file mode 100644 index 000000000000..30a92bf1bb91 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Get.json @@ -0,0 +1,45 @@ +{ + "title": "L2IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..e231b5e86d53 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "title": "L2IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..ec76a873fd3d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ListBySubscription.json @@ -0,0 +1,48 @@ +{ + "title": "L2IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Update.json new file mode 100644 index 000000000000..c6ac3ffd60d1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_Update.json @@ -0,0 +1,57 @@ +{ + "title": "L2IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L2IsolationDomains_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "mtu": 6000, + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "vlanId": 501, + "mtu": 1500, + "extendedVlan": "Enabled", + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2domain", + "name": "example-l2domain", + "type": "microsoft.managednetworkfabric/l2IsolationDomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..8eafd68370a0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L2IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L2IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..5a5cc173f414 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L2IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L2IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L2IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l2IsolationDomainName": "example-l2domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_CommitConfiguration.json new file mode 100644 index 000000000000..3c74f41369bc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "L3IsolationDomains_CommitConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Create.json new file mode 100644 index 000000000000..349799982cc8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Create.json @@ -0,0 +1,179 @@ +{ + "title": "L3IsolationDomains_Create_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "resource": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": {}, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 90 + }, + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 90 + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 90 + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Delete.json new file mode 100644 index 000000000000..dff9f7a7d2fc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "L3IsolationDomains_Delete_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Get.json new file mode 100644 index 000000000000..95c165f91309 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Get.json @@ -0,0 +1,76 @@ +{ + "title": "L3IsolationDomains_Get_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 10 + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ListByResourceGroup.json new file mode 100644 index 000000000000..18a923d41a46 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ListByResourceGroup.json @@ -0,0 +1,80 @@ +{ + "title": "L3IsolationDomains_ListByResourceGroup_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 50 + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ListBySubscription.json new file mode 100644 index 000000000000..8d4ea4e199fd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ListBySubscription.json @@ -0,0 +1,79 @@ +{ + "title": "L3IsolationDomains_ListBySubscription_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 1, + "threshold": 50 + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Update.json new file mode 100644 index 000000000000..28ad79dcd17c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_Update.json @@ -0,0 +1,116 @@ +{ + "title": "L3IsolationDomains_Update_MaximumSet_Gen", + "operationId": "L3IsolationDomains_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation1", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "routePrefixLimit": { + "hardLimit": 28, + "threshold": 50 + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "redistributeConnectedSubnets": "True", + "redistributeStaticRoutes": "True", + "aggregateRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.0/24" + } + ], + "ipv6Routes": [ + { + "prefix": "3FFE:FFFF:0:CD30::a0/29" + } + ] + }, + "connectedSubnetRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "staticRouteRoutePolicy": { + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + } + }, + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "uniqueRdConfiguration": { + "uniqueRds": [ + "uniquerd-1" + ] + }, + "routePrefixLimit": { + "hardLimit": 28, + "threshold": 90 + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain", + "name": "example-l3domain", + "type": "microsoft.managednetworkfabric/l3isolationdomains", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_UpdateAdministrativeState.json new file mode 100644 index 000000000000..0d79600c31e0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "L3IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "L3IsolationDomains_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ValidateConfiguration.json new file mode 100644 index 000000000000..e8c10f5f9645 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/L3IsolationDomains_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "L3IsolationDomains_ValidateConfiguration_MaximumSet_Gen", + "operationId": "L3IsolationDomains_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "l3IsolationDomainName": "example-l3domain" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "mg" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Create.json new file mode 100644 index 000000000000..e6549c7ac906 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Create.json @@ -0,0 +1,130 @@ +{ + "title": "NeighborGroups_Create_MaximumSet_Gen", + "operationId": "NeighborGroups_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "resource": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Delete.json new file mode 100644 index 000000000000..10585dc47608 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NeighborGroups_Delete_MaximumSet_Gen", + "operationId": "NeighborGroups_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Get.json new file mode 100644 index 000000000000..0b6fbece5896 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Get.json @@ -0,0 +1,60 @@ +{ + "title": "NeighborGroups_Get_MaximumSet_Gen", + "operationId": "NeighborGroups_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..9dc246eda890 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "title": "NeighborGroups_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NeighborGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_ListBySubscription.json new file mode 100644 index 000000000000..0746e509467e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "title": "NeighborGroups_ListBySubscription_MaximumSet_Gen", + "operationId": "NeighborGroups_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Update.json new file mode 100644 index 000000000000..52ea00af47f9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NeighborGroups_Update.json @@ -0,0 +1,86 @@ +{ + "title": "NeighborGroups_Update_MaximumSet_Gen", + "operationId": "NeighborGroups_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "neighborGroupName": "example-neighborGroup", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "Updating", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "destination": { + "ipv4Addresses": [ + "10.10.10.10", + "20.10.10.10", + "30.10.10.10", + "40.10.10.10", + "50.10.10.10", + "60.10.10.10", + "70.10.10.10", + "80.10.10.10", + "90.10.10.10" + ], + "ipv6Addresses": [ + "2F::/100" + ] + }, + "networkTapIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "networkTapRuleIds": [ + "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-networkTapRule" + ], + "provisioningState": "Accepted" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/subscriptionId/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "name": "example-neighborGroup", + "type": "microsoft.managednetworkfabric/neighborGroups", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDeviceSkus_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDeviceSkus_Get.json new file mode 100644 index 000000000000..860961e62917 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDeviceSkus_Get.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkDeviceSkus_Get_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkDeviceSkuName": "example-deviceSku" + }, + "responses": { + "200": { + "body": { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDeviceSkus_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDeviceSkus_ListBySubscription.json new file mode 100644 index 000000000000..56d43e0b6721 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDeviceSkus_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "NetworkDeviceSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDeviceSkus_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "model": "model1", + "manufacturer": "Arista", + "supportedVersions": [ + { + "version": "1.0.0", + "vendorOsVersion": "2.0", + "vendorFirmwareVersion": "11.2", + "isDefault": "True" + } + ], + "supportedRoleTypes": [ + "CE" + ], + "interfaces": [ + { + "identifier": "HundredGigE0/0", + "interfaceType": "type1", + "supportedConnectorTypes": [ + { + "connectorType": "Optical", + "maxSpeedInMbps": 100 + } + ] + } + ], + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/example-deviceSku", + "name": "example-deviceSku", + "type": "microsoft.managednetworkfabric/networkDeviceSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Create.json new file mode 100644 index 000000000000..0eb2249de53c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Create.json @@ -0,0 +1,97 @@ +{ + "title": "NetworkDevices_Create_MaximumSet_Gen", + "operationId": "NetworkDevices_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "resource": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Delete.json new file mode 100644 index 000000000000..b83e96dc47f0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkDevices_Delete_MaximumSet_Gen", + "operationId": "NetworkDevices_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Get.json new file mode 100644 index 000000000000..e4433c2309af --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Get.json @@ -0,0 +1,49 @@ +{ + "title": "NetworkDevices_Get_MaximumSet_Gen", + "operationId": "NetworkDevices_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..6a442d1ea8c5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "NetworkDevices_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_ListBySubscription.json new file mode 100644 index 000000000000..95b6a9bf82f1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "NetworkDevices_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkDevices_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Reboot.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Reboot.json new file mode 100644 index 000000000000..5fac4569baab --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Reboot.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Reboot_MaximumSet_Gen", + "operationId": "NetworkDevices_Reboot", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "rebootType": "GracefulRebootWithZTP" + } + }, + "responses": { + "200": { + "body": { + "configurationState": "Succeeded", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RefreshConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RefreshConfiguration.json new file mode 100644 index 000000000000..956946244584 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkDevices_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkDevices_RefreshConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RunRoCommand.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RunRoCommand.json new file mode 100644 index 000000000000..220b6f637bd1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RunRoCommand.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkDevices_RunRoCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRoCommand", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "show version" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "zuwgsrizc", + "message": "v", + "target": "elwgfga", + "details": [], + "additionalInfo": [ + { + "type": "modrphiaxpggwxenqcitxvbeevku", + "info": {} + } + ] + }, + "endTime": "2025-04-25T08:06:00.912Z", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/locations/UKSOUTH/operationStatuses/b7c3d8f2-56e4-4a9b-8c7d-123456789ABC*1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF", + "name": "b7c3d8f2-56e4-4a9b-8c7d-123456789ABC*1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF1234567890ABCDEF", + "properties": { + "configurationState": "Succeeded", + "outputUrl": "https://testsast1.blob.core.windows.net/container1", + "deviceConfigurationPreview": "{\n \"architecture\": \"arm64\",\n \"bootupTimestamp\": 1745279999.1234567,\n \"configMacAddress\": \"11:22:33:44:55:66\",\n \"hardwareRevision\": \"RevB\",\n \"hwMacAddress\": \"66:55:44:33:22:11\",\n \"imageFormatVersion\": \"2.0\",\n \"imageOptimization\": \"High\",\n \"internalBuildId\": \"a123b456-c789-0123-d456-7890e123f456\",\n \"internalVersion\": \"5.12.1FX-NX-12345678.5121FXNX\",\n \"isIntlVersion\": true,\n \"kernelVersion\": \"6.0.0-1.cm3\",\n \"memFree\": 209715200,\n \"memTotal\": 262144000,\n \"mfgName\": \"Cisco\",\n \"modelName\": \"vEOS\",\n \"serialNumber\": \"1234567890ABCDEF1234567890ABCDEF\",\n \"systemMacAddress\": \"aa:bb:cc:dd:ee:ff\",\n \"uptime\": 123456.78901234567,\n \"version\": \"5.12.1FX-NX-12345678.5121FXNX (release build)\"\n}" + }, + "resourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "startTime": "2025-04-25T08:06:00.912Z", + "status": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RunRwCommand.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RunRwCommand.json new file mode 100644 index 000000000000..354d7785cc4e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_RunRwCommand.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkDevices_RunRwCommand_MaximumSet_Gen", + "operationId": "NetworkDevices_RunRwCommand", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "command": "yzuabghycngqmqtfacvoh" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "svvzwijqaghjlelhr", + "message": "kgttomemzowwdiqvbtqlrd", + "target": "txdqddgrezjihhhrmdovikhm", + "details": [], + "additionalInfo": [ + { + "type": "vcaekwfqlkfzcjompti", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "outputUrl": "hypjtiwzhevuc" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Update.json new file mode 100644 index 000000000000..dfc91b4d8b01 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Update.json @@ -0,0 +1,61 @@ +{ + "title": "NetworkDevices_Update_MaximumSet_Gen", + "operationId": "NetworkDevices_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "properties": { + "tags": { + "KeyId": "KeyValue" + }, + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "hostName": "NFA-Device", + "serialNumber": "Vendor;DCS-7280XXX-24;12.05;JPE2111XXXX", + "version": "1.0", + "networkDeviceSku": "DeviceSku", + "networkDeviceRole": "CE", + "networkRackId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "managementIpv4Address": "10.10.10.10", + "managementIpv6Address": "2F::1/100", + "rwDeviceConfig": "hostname access-switch1\n enable secret somestrongpass", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "KeyId": "KeyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device", + "name": "example-device", + "type": "microsoft.managednetworkfabric/networkdevices", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_UpdateAdministrativeState.json new file mode 100644 index 000000000000..e20ace6660bc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkDevices_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkDevices_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "resourceIds": [ + "" + ], + "state": "RMA" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Upgrade.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Upgrade.json new file mode 100644 index 000000000000..9ae32f7195e8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkDevices_Upgrade.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkDevices_Upgrade_MaximumSet_Gen", + "operationId": "NetworkDevices_Upgrade", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "body": { + "version": "1.0.0" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Create.json new file mode 100644 index 000000000000..cfb75f7bdf0c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Create.json @@ -0,0 +1,174 @@ +{ + "title": "NetworkFabricControllers_Create_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "resource": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "isWorkloadManagementNetworkEnabled": "True", + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Delete.json new file mode 100644 index 000000000000..66bc2de3e8b7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabricControllers_Delete_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Get.json new file mode 100644 index 000000000000..7ff43178add7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Get.json @@ -0,0 +1,74 @@ +{ + "title": "NetworkFabricControllers_Get_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_ListByResourceGroup.json new file mode 100644 index 000000000000..8258f44a82bd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "NetworkFabricControllers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_ListBySubscription.json new file mode 100644 index 000000000000..9fec9104010c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "NetworkFabricControllers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Update.json new file mode 100644 index 000000000000..32956e2232fb --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricControllers_Update.json @@ -0,0 +1,95 @@ +{ + "title": "NetworkFabricControllers_Update_MaximumSet_Gen", + "operationId": "NetworkFabricControllers_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricControllerName": "example-networkController", + "properties": { + "tags": { + "keyId": "KeyValue" + }, + "properties": { + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName", + "expressRouteAuthorizationKey": "xxx-xxx-xxx" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "infrastructureExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "workloadExpressRouteConnections": [ + { + "expressRouteCircuitId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuitName" + } + ], + "infrastructureServices": { + "ipv4AddressSpaces": [ + "172.253.0.0/19" + ], + "ipv6AddressSpaces": [] + }, + "workloadServices": { + "ipv4AddressSpaces": [ + "172.253.28.0/22" + ], + "ipv6AddressSpaces": [] + }, + "managedResourceGroupConfiguration": { + "name": "managedResourceGroupName", + "location": "eastus" + }, + "networkFabricIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/networkFabrics/eaxmple-fabric" + ], + "isWorkloadManagementNetworkEnabled": "True", + "tenantInternetGatewayIds": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/internetGateways/example-internetGateway" + ], + "ipv4AddressSpace": "172.253.0.0/19", + "ipv6AddressSpace": "::/60", + "nfcSku": "Standard", + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "KeyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-networkController", + "name": "example-networkController", + "type": "microsoft.managednetworkfabric/networkfabriccontrollers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricSkus_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricSkus_Get.json new file mode 100644 index 000000000000..28ee19f69744 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricSkus_Get.json @@ -0,0 +1,36 @@ +{ + "title": "NetworkFabricSkus_Get_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "networkFabricSkuName": "wxample-fabricsku" + }, + "responses": { + "200": { + "body": { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricSkus_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricSkus_ListBySubscription.json new file mode 100644 index 000000000000..40c53fb72bb0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabricSkus_ListBySubscription.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabricSkus_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabricSkus_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "type": "SingleRack", + "maxComputeRacks": 4, + "maximumServerCount": 9, + "supportedVersions": [ + "1.0.0" + ], + "details": "https://azure/fabricskuDetails", + "provisioningState": "Accepted" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/example-fabricsku", + "name": "example-fabricsku", + "type": "microsoft.managednetworkfabric/networkFabricSkus", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ArmConfigurationDiff.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ArmConfigurationDiff.json new file mode 100644 index 000000000000..6e028fc88a2b --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ArmConfigurationDiff.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_ArmConfigurationDiff_MaximumSet", + "operationId": "NetworkFabrics_ArmConfigurationDiff", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "configurationDiffUrl": "", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "seonvum", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_CommitBatchStatus.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_CommitBatchStatus.json new file mode 100644 index 000000000000..d0cc282b3d93 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_CommitBatchStatus.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkFabrics_CommitBatchStatus_MaximumSet", + "operationId": "NetworkFabrics_CommitBatchStatus", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "commitBatchId": "batch-id" + } + }, + "responses": { + "200": { + "body": { + "commitBatchId": "batch-id", + "commitBatchState": "Processing", + "commitBatchDetails": { + "failedDevices": [ + "device-id-1" + ] + }, + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_CommitConfiguration.json new file mode 100644 index 000000000000..78eb70b012d1 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_CommitConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-networkFabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Create.json new file mode 100644 index 000000000000..39708defaebd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Create.json @@ -0,0 +1,518 @@ +{ + "title": "NetworkFabrics_Create_MaximumSet_Gen", + "operationId": "NetworkFabrics_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "resource": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "password": "xxx-xx-xx", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "nniDerivedUniqueRdConfigurationState": "Enabled" + } + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key872": {} + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Delete.json new file mode 100644 index 000000000000..26e029aae8fa --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFabrics_Delete_MaximumSet_Gen", + "operationId": "NetworkFabrics_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Deprovision.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Deprovision.json new file mode 100644 index 000000000000..06522aeadab8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Deprovision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Deprovision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Deprovision", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_DiscardCommitBatch.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_DiscardCommitBatch.json new file mode 100644 index 000000000000..a2cfb81b741e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_DiscardCommitBatch.json @@ -0,0 +1,37 @@ +{ + "title": "NetworkFabrics_DiscardCommitBatch", + "operationId": "NetworkFabrics_DiscardCommitBatch", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "commitBatchId": "batchId1" + } + }, + "responses": { + "200": { + "body": { + "commitBatchId": "batchId1", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Get.json new file mode 100644 index 000000000000..17e4b37c5091 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Get.json @@ -0,0 +1,201 @@ +{ + "title": "NetworkFabrics_Get_MaximumSet_Gen", + "operationId": "NetworkFabrics_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id-1" + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_GetTopology.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_GetTopology.json new file mode 100644 index 000000000000..90b85549addd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_GetTopology.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkFabrics_GetTopology_MaximumSet_Gen", + "operationId": "NetworkFabrics_GetTopology", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ListByResourceGroup.json new file mode 100644 index 000000000000..fe690a8b9062 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ListByResourceGroup.json @@ -0,0 +1,205 @@ +{ + "title": "NetworkFabrics_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "uniqueRd" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batchId" + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ListBySubscription.json new file mode 100644 index 000000000000..4df91f0dfefa --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ListBySubscription.json @@ -0,0 +1,204 @@ +{ + "title": "NetworkFabrics_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkFabrics_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "unique-rd-1" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "batch-id-1" + ], + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_LockFabric.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_LockFabric.json new file mode 100644 index 000000000000..6e147e97dbfd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_LockFabric.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_LockFabric_MaximumSet", + "operationId": "NetworkFabrics_LockFabric", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-networkFabric", + "body": { + "lockType": "Administrative", + "action": "Lock" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Provision.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Provision.json new file mode 100644 index 000000000000..f8b57a7e5b55 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Provision.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_Provision_MaximumSet_Gen", + "operationId": "NetworkFabrics_Provision", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_RefreshConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_RefreshConfiguration.json new file mode 100644 index 000000000000..38d53759231f --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_RefreshConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_RefreshConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_RefreshConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Update.json new file mode 100644 index 000000000000..c713cf9eede5 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Update.json @@ -0,0 +1,329 @@ +{ + "title": "NetworkFabrics_Update_MaximumSet_Gen", + "operationId": "NetworkFabrics_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "identity": { + "type": "None", + "userAssignedIdentities": { + "key872": {} + } + }, + "properties": { + "annotation": "annotation1", + "rackCount": 6, + "serverCountPerRack": 10, + "ipv4Prefix": "10.18.0.0/17", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/60", + "fabricASN": 12345, + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "terminalServerConfiguration": { + "username": "username1", + "password": "xxxxxxxx", + "serialNumber": "1234567", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "hardwareAlertThreshold": 43, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "nniDerivedUniqueRdConfigurationState": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkFabricSku": "M4-A400-A100-C16-aa", + "fabricVersion": "version1", + "routerIds": [ + "routerId" + ], + "storageAccountConfiguration": { + "storageAccountId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.Storage/storageAccounts/nfStorage", + "storageAccountIdentity": { + "identityType": "UserAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-id" + } + }, + "fabricLocks": [ + { + "lockState": "Enabled", + "lockType": "Configuration" + } + ], + "networkFabricControllerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/example-fabricController", + "rackCount": 4, + "serverCountPerRack": 8, + "storageArrayCount": 1, + "ipv4Prefix": "10.18.0.0/19", + "ipv6Prefix": "3FFE:FFFF:0:CD40::/59", + "fabricASN": 29249, + "terminalServerConfiguration": { + "username": "username", + "serialNumber": "123456", + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "networkDeviceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + }, + "managementNetworkConfiguration": { + "infrastructureVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1501, + "vlanId": 3001, + "peerASN": 1235, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.13/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127" + } + }, + "workloadVpnConfiguration": { + "networkToNetworkInterconnectId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "administrativeState": "Enabled", + "peeringOption": "OptionA", + "optionBProperties": { + "importRouteTargets": [ + "65046:10050" + ], + "exportRouteTargets": [ + "65046:10050" + ], + "routeTargets": { + "importIpv4RouteTargets": [ + "65046:10050" + ], + "importIpv6RouteTargets": [ + "65046:10050" + ], + "exportIpv4RouteTargets": [ + "65046:10050" + ], + "exportIpv6RouteTargets": [ + "65046:10050" + ] + } + }, + "optionAProperties": { + "mtu": 1500, + "vlanId": 3000, + "peerASN": 61234, + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 5 + }, + "primaryIpv4Prefix": "10.0.0.14/30", + "primaryIpv6Prefix": "2FFE:FFFF:0:CD30::a7/126", + "secondaryIpv4Prefix": "10.0.0.15/30", + "secondaryIpv6Prefix": "2FFE:FFFF:0:CD30::ac/126" + } + } + }, + "racks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-networkRack" + ], + "l2IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/example-l2Domain" + ], + "l3IsolationDomains": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3Domain" + ], + "hardwareAlertThreshold": 74, + "controlPlaneAcls": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl" + ], + "featureFlags": [ + { + "featureFlagName": "uniqueRdConfiguration", + "featureFlagValue": "Enabled" + } + ], + "trustedIpPrefixes": [ + "/subscriptions/xxxxxx/resourceGroups/resourcegroupname/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-prefix" + ], + "uniqueRdConfiguration": { + "uniqueRdConfigurationState": "Enabled", + "uniqueRds": [ + "apogd" + ], + "nniDerivedUniqueRdConfigurationState": "Enabled" + }, + "activeCommitBatches": [ + "izc" + ], + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "identity": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "tenantId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "type": "None", + "userAssignedIdentities": { + "key872": { + "principalId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "clientId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + } + } + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "name": "example-fabric", + "type": "Microsoft.ManagedNetworkFabric/networkFabrics", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json new file mode 100644 index 000000000000..c07cdeabf20a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateInfraManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateInfraManagementBfdConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json new file mode 100644 index 000000000000..105e23cc2afb --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Upgrade.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Upgrade.json new file mode 100644 index 000000000000..b1edde5b59b8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_Upgrade.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_Upgrade_MaximumSet_Gen", + "operationId": "NetworkFabrics_Upgrade", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "version": "3.x.x", + "action": "Start" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ValidateConfiguration.json new file mode 100644 index 000000000000..3b31f6a7b82d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ValidateConfiguration.json @@ -0,0 +1,38 @@ +{ + "title": "NetworkFabrics_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkFabrics_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric", + "body": { + "validateAction": "Cabling" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ViewDeviceConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ViewDeviceConfiguration.json new file mode 100644 index 000000000000..afdcf67cd3b0 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkFabrics_ViewDeviceConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkFabrics_ViewDeviceConfiguration_MaximumSet", + "operationId": "NetworkFabrics_ViewDeviceConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-fabric" + }, + "responses": { + "200": { + "body": { + "deviceConfigurationUrl": "", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Create.json new file mode 100644 index 000000000000..d34d17961a1a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Create.json @@ -0,0 +1,78 @@ +{ + "title": "NetworkInterfaces_Create_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "resource": { + "properties": { + "annotation": "annotation", + "interfaceType": "Management", + "description": "device 1", + "additionalDescription": "device 1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "description": "device 1", + "additionalDescription": "device 1", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..535994e86cbd --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkInterfaces_Delete_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..d8014747725a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Get.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkInterfaces_Get_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "lastOperation": { + "details": "Succeeded" + }, + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_ListByNetworkDevice.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_ListByNetworkDevice.json new file mode 100644 index 000000000000..c68452138776 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_ListByNetworkDevice.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkInterfaces_ListByNetworkDevice_MaximumSet_Gen", + "operationId": "NetworkInterfaces_ListByNetworkDevice", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "lastOperation": { + "details": "Succeeded" + }, + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..d6505e490166 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_Update.json @@ -0,0 +1,52 @@ +{ + "title": "NetworkInterfaces_Update_MaximumSet_Gen", + "operationId": "NetworkInterfaces_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "properties": { + "properties": { + "annotation": "annotation", + "description": "device 1", + "additionalDescription": "device 1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "physicalIdentifier": "Id", + "connectedTo": "external-interface", + "interfaceType": "Management", + "ipv4Address": "10.2.2.8", + "ipv6Address": "10:2:0:0::", + "description": "device 1", + "additionalDescription": "device 1", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-device/networkInterfaces/example-interface", + "name": "example-interface", + "type": "microsoft.managednetworkfabric/networkdevices/networkinterfaces", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_UpdateAdministrativeState.json new file mode 100644 index 000000000000..0e680a9823c6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkInterfaces_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkInterfaces_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkInterfaces_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkDeviceName": "example-device", + "networkInterfaceName": "example-interface", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Create.json new file mode 100644 index 000000000000..6e293f323e9a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Create.json @@ -0,0 +1,138 @@ +{ + "title": "NetworkMonitors_Create", + "operationId": "NetworkMonitors_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor", + "resource": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "stationConfigurationState": "Enabled", + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "er", + "stationIp": "cno", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Delete.json new file mode 100644 index 000000000000..096e7f681d6d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkMonitors_Delete_MaximumSet", + "operationId": "NetworkMonitors_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "rgmanagednetworkfabric", + "networkMonitorName": "example-monitor" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Get.json new file mode 100644 index 000000000000..7112ade85ede --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Get.json @@ -0,0 +1,61 @@ +{ + "title": "NetworkMonitors_Get_MaximumSet", + "operationId": "NetworkMonitors_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_ListByResourceGroup.json new file mode 100644 index 000000000000..bd0fb34185b4 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "NetworkMonitors_ListByResourceGroup", + "operationId": "NetworkMonitors_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 62695, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key5330": "whychexhqeakupefimkszcdqsnibx" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_ListBySubscription.json new file mode 100644 index 000000000000..b10062fd48a7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "NetworkMonitors_ListBySubscription", + "operationId": "NetworkMonitors_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "station-name", + "stationIp": "10.0.0.1", + "stationPort": 38846, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 489, + "probeInterval": 2854, + "probeCount": 64 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key2555": "pv" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Update.json new file mode 100644 index 000000000000..8f279e52b096 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_Update.json @@ -0,0 +1,91 @@ +{ + "title": "NetworkMonitors_Update", + "operationId": "NetworkMonitors_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor", + "properties": { + "tags": { + "key": "value" + }, + "properties": { + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 64685, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "bmpConfiguration": { + "scopeResourceId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "stationConfigurationState": "Enabled", + "stationName": "name", + "stationIp": "10.0.0.1", + "stationPort": 64685, + "stationConnectionMode": "Active", + "stationConnectionProperties": { + "keepaliveIdleTime": 49, + "probeInterval": 3558, + "probeCount": 43 + }, + "stationNetwork": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain/internalNetworks/example-internalnetwork", + "monitoredNetworks": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/example-l3domain" + ], + "exportPolicy": "Pre-Policy", + "monitoredAddressFamilies": [ + "ipv4Unicast" + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "key": "value" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkMonitors/example-monitor", + "name": "example-monitor", + "type": "microsoft.managednetworkfabric/networkmonitors", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_UpdateAdministrativeState.json new file mode 100644 index 000000000000..df7fc4b69715 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkMonitors_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkMonitors_UpdateAdministrativeState", + "operationId": "NetworkMonitors_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "1234ABCD-0A1B-1234-5678-123456ABCDEF", + "resourceGroupName": "example-rg", + "networkMonitorName": "example-monitor", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Create.json new file mode 100644 index 000000000000..a1f5f170cc52 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Create.json @@ -0,0 +1,94 @@ +{ + "title": "NetworkPacketBrokers_Create_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "resource": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Delete.json new file mode 100644 index 000000000000..4cc741f24af3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkPacketBrokers_Delete_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Get.json new file mode 100644 index 000000000000..f92e2b771830 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Get.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkPacketBrokers_Get_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker" + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_ListByResourceGroup.json new file mode 100644 index 000000000000..6d7cf3b9cb55 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "NetworkPacketBrokers_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_ListBySubscription.json new file mode 100644 index 000000000000..98f3fcdeb382 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "NetworkPacketBrokers_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Update.json new file mode 100644 index 000000000000..c4819c43c398 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkPacketBrokers_Update.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkPacketBrokers_Update_MaximumSet_Gen", + "operationId": "NetworkPacketBrokers_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkPacketBrokerName": "example-networkPacketBroker", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDeviceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "sourceInterfaceIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ], + "networkTapIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap" + ], + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "name": "example-networkPacketBroker", + "type": "microsoft.managednetworkfabric/networkPacketBrokers", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Create.json new file mode 100644 index 000000000000..e837921b25d6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Create.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkRacks_Create_MaximumSet_Gen", + "operationId": "NetworkRacks_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "resource": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Delete.json new file mode 100644 index 000000000000..4638074fe2f8 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkRacks_Delete_MaximumSet_Gen", + "operationId": "NetworkRacks_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Get.json new file mode 100644 index 000000000000..ff06e8c4abbb --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Get.json @@ -0,0 +1,43 @@ +{ + "title": "NetworkRacks_Get_MaximumSet_Gen", + "operationId": "NetworkRacks_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_ListByResourceGroup.json new file mode 100644 index 000000000000..55de114df8c3 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_ListByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "title": "NetworkRacks_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkRacks_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_ListBySubscription.json new file mode 100644 index 000000000000..77c149b0222e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_ListBySubscription.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkRacks_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkRacks_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "lastOperation": { + "details": "Succeeded" + }, + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Update.json new file mode 100644 index 000000000000..cd3298918823 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkRacks_Update.json @@ -0,0 +1,50 @@ +{ + "title": "NetworkRacks_Update_MaximumSet_Gen", + "operationId": "NetworkRacks_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkRackName": "example-rack", + "properties": { + "tags": { + "keyId": "keyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkRackType": "Aggregate", + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-networkFabric", + "networkDevices": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice" + ], + "provisioningState": "Accepted" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkRacks/example-rack", + "name": "example-rack", + "type": "microsoft.managednetworkfabric/networkRacks", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Create.json new file mode 100644 index 000000000000..287b071c9efa --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Create.json @@ -0,0 +1,352 @@ +{ + "title": "NetworkTapRules_Create_MaximumSet_Gen", + "operationId": "NetworkTapRules_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "resource": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "pollingIntervalInSeconds": 30, + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "location": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Delete.json new file mode 100644 index 000000000000..5955fadcaea9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTapRules_Delete_MaximumSet_Gen", + "operationId": "NetworkTapRules_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Get.json new file mode 100644 index 000000000000..85d34428e545 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Get.json @@ -0,0 +1,133 @@ +{ + "title": "NetworkTapRules_Get_MaximumSet_Gen", + "operationId": "NetworkTapRules_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ListByResourceGroup.json new file mode 100644 index 000000000000..77e8555ff65c --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ListByResourceGroup.json @@ -0,0 +1,137 @@ +{ + "title": "NetworkTapRules_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ListBySubscription.json new file mode 100644 index 000000000000..4905845157ec --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ListBySubscription.json @@ -0,0 +1,136 @@ +{ + "title": "NetworkTapRules_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTapRules_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Resync.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Resync.json new file mode 100644 index 000000000000..e6f8b090dab2 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTapRules_Resync_MaximumSet_Gen", + "operationId": "NetworkTapRules_Resync", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Update.json new file mode 100644 index 000000000000..836771675e4a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_Update.json @@ -0,0 +1,233 @@ +{ + "title": "NetworkTapRules_Update_MaximumSet_Gen", + "operationId": "NetworkTapRules_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/amdsdx", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "configurationType": "File", + "tapRulesUrl": "https://microsoft.com/a", + "matchConfigurations": [ + { + "matchConfigurationName": "config1", + "sequenceNumber": 10, + "ipAddressType": "IPv4", + "matchConditions": [ + { + "protocolTypes": [ + "TCP" + ], + "vlanMatchCondition": { + "vlans": [ + "20-30" + ], + "innerVlans": [ + "30" + ], + "vlanGroupNames": [ + "example-vlanGroup" + ] + }, + "ipCondition": { + "type": "SourceIP", + "prefixType": "Prefix", + "ipPrefixValues": [ + "10.20.20.20/12" + ], + "ipGroupNames": [ + "example-ipGroup" + ] + }, + "encapsulationType": "None", + "portCondition": { + "portType": "SourcePort", + "layer4Protocol": "TCP", + "ports": [ + "100" + ], + "portGroupNames": [ + "example-portGroup1" + ] + } + } + ], + "actions": [ + { + "type": "Drop", + "truncate": "100", + "isTimestampEnabled": "True", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup", + "matchConfigurationName": "match1" + } + ] + } + ], + "dynamicMatchConfigurations": [ + { + "ipGroups": [ + { + "name": "example-ipGroup", + "ipAddressType": "IPv4", + "ipPrefixes": [ + "10.20.3.1/20" + ] + } + ], + "vlanGroups": [ + { + "name": "example-vlanGroup", + "vlans": [ + "20-30" + ] + } + ], + "portGroups": [ + { + "name": "example-portGroup", + "ports": [ + "100-200" + ] + } + ] + } + ], + "networkTapId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-tap", + "pollingIntervalInSeconds": 30, + "lastSyncedTime": "2023-06-12T07:11:22.485Z", + "globalNetworkTapRuleActions": { + "enableCount": "True", + "truncate": "truncate-name" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-tapRule", + "name": "example-tapRule", + "type": "microsoft.managednetworkfabric/networkTapRules", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_UpdateAdministrativeState.json new file mode 100644 index 000000000000..96938eeaf2ba --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_UpdateAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkTapRules_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTapRules_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ValidateConfiguration.json new file mode 100644 index 000000000000..ef9cb94452da --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTapRules_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "NetworkTapRules_ValidateConfiguration_MaximumSet_Gen", + "operationId": "NetworkTapRules_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapRuleName": "example-tapRule" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Create.json new file mode 100644 index 000000000000..fb22cba01135 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Create.json @@ -0,0 +1,125 @@ +{ + "title": "NetworkTaps_Create_MaximumSet_Gen", + "operationId": "NetworkTaps_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "resource": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Delete.json new file mode 100644 index 000000000000..8e7737bd334a --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkTaps_Delete_MaximumSet_Gen", + "operationId": "NetworkTaps_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Get.json new file mode 100644 index 000000000000..1f6ba4b71b3d --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Get.json @@ -0,0 +1,57 @@ +{ + "title": "NetworkTaps_Get_MaximumSet_Gen", + "operationId": "NetworkTaps_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_ListByResourceGroup.json new file mode 100644 index 000000000000..d2651e5d89a9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "NetworkTaps_ListByResourceGroup_MaximumSet_Gen", + "operationId": "NetworkTaps_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_ListBySubscription.json new file mode 100644 index 000000000000..91891b276b61 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "NetworkTaps_ListBySubscription_MaximumSet_Gen", + "operationId": "NetworkTaps_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Resync.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Resync.json new file mode 100644 index 000000000000..744e6c31f0fc --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Resync.json @@ -0,0 +1,34 @@ +{ + "title": "NetworkTaps_Resync_MaximumSet_Gen", + "operationId": "NetworkTaps_Resync", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Update.json new file mode 100644 index 000000000000..a8937f1b4593 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_Update.json @@ -0,0 +1,82 @@ +{ + "title": "NetworkTaps_Update_MaximumSet_Gen", + "operationId": "NetworkTaps_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "annotation": "annotation1", + "pollingType": "Pull", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "networkPacketBrokerId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/example-networkPacketBroker", + "sourceTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-sourceTapRule", + "destinations": [ + { + "name": "example-destinaionName", + "destinationType": "IsolationDomain", + "destinationId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/l3IsloationDomains/example-l3Domain/internalNetworks/example-internalNetwork", + "isolationDomainProperties": { + "encapsulation": "None", + "neighborGroupIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/neighborGroups/example-neighborGroup" + ] + }, + "destinationTapRuleId": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTapRules/example-destinationTapRule" + } + ], + "pollingType": "Pull", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastuseuap", + "id": "/subscriptions/xxxx-xxxx-xxxx-xxxx/resourcegroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkTaps/example-networkTap", + "name": "example-networkTap", + "type": "microsoft.managednetworkfabric/networkTaps", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_UpdateAdministrativeState.json new file mode 100644 index 000000000000..f4d3284e8f5e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkTaps_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "NetworkTaps_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkTaps_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkTapName": "example-networkTap", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Create.json new file mode 100644 index 000000000000..a9063c128375 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Create.json @@ -0,0 +1,375 @@ +{ + "title": "NetworkToNetworkInterconnects_Create_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "resource": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe08:00/64", + "nextHop": [ + "fe01::1" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe08:00/64", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe08:00/64", + "nextHop": [ + "fe01::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Delete.json new file mode 100644 index 000000000000..8ffaca408c77 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "NetworkToNetworkInterconnects_Delete_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Get.json new file mode 100644 index 000000000000..ce02392130ca --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Get.json @@ -0,0 +1,140 @@ +{ + "title": "NetworkToNetworkInterconnects_Get_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni" + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json new file mode 100644 index 000000000000..3c963f1a5fb6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json @@ -0,0 +1,144 @@ +{ + "title": "NetworkToNetworkInterconnects_ListByNetworkFabric_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_ListByNetworkFabric", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 24 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "jffgck", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Update.json new file mode 100644 index 000000000000..d7e80f204413 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_Update.json @@ -0,0 +1,221 @@ +{ + "title": "NetworkToNetworkInterconnects_Update_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "properties": { + "properties": { + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "20.0.0.12/29", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "20.0.0.14/29", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 2345, + "vlanId": 1235, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + }, + "prefixLimits": [ + { + "maximumRoutes": 1 + } + ] + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "nniType": "CE", + "isManagementType": "True", + "useOptionB": "True", + "layer2Configuration": { + "mtu": 1500, + "interfaces": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkDevices/example-networkDevice/networkInterfaces/example-networkInterface" + ] + }, + "optionBLayer3Configuration": { + "primaryIpv4Prefix": "10.0.0.12/30", + "primaryIpv6Prefix": "4FFE:FFFF:0:CD30::a8/127", + "secondaryIpv4Prefix": "40.0.0.14/30", + "secondaryIpv6Prefix": "6FFE:FFFF:0:CD30::ac/127", + "peerASN": 61234, + "vlanId": 1234, + "fabricASN": 17, + "peLoopbackIpAddress": [ + "10.0.0.1" + ], + "bmpConfiguration": { + "configurationState": "Enabled" + } + }, + "npbStaticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "staticRouteConfiguration": { + "bfdConfiguration": { + "administrativeState": "Enabled", + "intervalInMilliSeconds": 300, + "multiplier": 10 + }, + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "2fff::/64", + "nextHop": [ + "3ffe::1" + ] + } + ] + }, + "importRoutePolicy": { + "importIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "importIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "exportRoutePolicy": { + "exportIpv4RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "exportIpv6RoutePolicyId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy" + }, + "ingressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "egressAclId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/accessControlLists/example-acl", + "microBfdState": "Enabled", + "conditionalDefaultRouteConfiguration": { + "ipv4Routes": [ + { + "prefix": "10.0.0.1/24", + "nextHop": [ + "10.0.0.1" + ] + } + ], + "ipv6Routes": [ + { + "prefix": "fe80::/64", + "nextHop": [ + "fe80::1" + ] + } + ] + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric/networkToNetworkInterconnects/example-nni", + "name": "example-nni", + "type": "microsoft.managedNetworkFabric/networkFabrics/networkToNetworkInterconnects", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json new file mode 100644 index 000000000000..b1a19d24ef13 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json @@ -0,0 +1,41 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "NetworkToNetworkInterconnects_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json new file mode 100644 index 000000000000..4c3b88979a6e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json @@ -0,0 +1,40 @@ +{ + "title": "NetworkToNetworkInterconnects_UpdateBfdAdministrativeState", + "operationId": "NetworkToNetworkInterconnects_UpdateBfdAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "networkFabricName": "example-nf", + "networkToNetworkInterconnectName": "example-nni", + "body": { + "routeType": "Static", + "administrativeState": "Enable" + } + }, + "responses": { + "200": { + "body": { + "routeType": "Static", + "administrativeState": "Enable", + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/Operations_List.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/Operations_List.json new file mode 100644 index 000000000000..ee880e549cf7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/Operations_List.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-06-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Read", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Gets/List NetworkFabricController resources.", + "description": "Gets/List the NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Write", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Create or Update NetworkFabricController resource.", + "description": "Create or Update NetworkFabricController resource data." + } + }, + { + "name": "Microsoft.ManagedNetworkFabric/NetworkFabricControllers/Delete", + "actionType": "Internal", + "isDataAction": true, + "origin": "user,system", + "display": { + "provider": "Microsoft.ManagedNetworkFabric resource provider", + "resource": "NetworkFabricControllers", + "operation": "Deletes the NetworkFabricController resource.", + "description": "Deletes the NetworkFabricController resource." + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "Operations_List_MaximumSet_Gen" +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_CommitConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_CommitConfiguration.json new file mode 100644 index 000000000000..92978a9f1ce7 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_CommitConfiguration.json @@ -0,0 +1,34 @@ +{ + "title": "RoutePolicies_CommitConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_CommitConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Create.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Create.json new file mode 100644 index 000000000000..b8da269af835 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Create.json @@ -0,0 +1,246 @@ +{ + "title": "RoutePolicies_Create_MaximumSet_Gen", + "operationId": "RoutePolicies_Create", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "resource": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Delete.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Delete.json new file mode 100644 index 000000000000..8c96019d672e --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RoutePolicies_Delete_MaximumSet_Gen", + "operationId": "RoutePolicies_Delete", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Get.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Get.json new file mode 100644 index 000000000000..fd186a114f19 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Get.json @@ -0,0 +1,97 @@ +{ + "title": "RoutePolicies_Get_MaximumSet_Gen", + "operationId": "RoutePolicies_Get", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ListByResourceGroup.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..651167a21c50 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ListByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "title": "RoutePolicies_ListByResourceGroup_MaximumSet_Gen", + "operationId": "RoutePolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ListBySubscription.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ListBySubscription.json new file mode 100644 index 000000000000..3c5ae1360ab6 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ListBySubscription.json @@ -0,0 +1,100 @@ +{ + "title": "RoutePolicies_ListBySubscription_MaximumSet_Gen", + "operationId": "RoutePolicies_ListBySubscription", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "lastOperation": { + "details": "Succeeded" + }, + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + ], + "nextLink": "https://microsoft.com/aukskqxh" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Update.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Update.json new file mode 100644 index 000000000000..dda045ae4900 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_Update.json @@ -0,0 +1,161 @@ +{ + "title": "RoutePolicies_Update_MaximumSet_Gen", + "operationId": "RoutePolicies_Update", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "properties": { + "tags": { + "keyId": "keyValue" + }, + "properties": { + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "annotation": "annotation", + "defaultAction": "Permit", + "statements": [ + { + "annotation": "annotation", + "sequenceNumber": 7, + "condition": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ], + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ], + "type": "Or", + "ipPrefixId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/example-ipPrefix" + }, + "action": { + "localPreference": 20, + "actionType": "Permit", + "ipCommunityProperties": { + "add": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "delete": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + }, + "set": { + "ipCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipCommunities/example-ipCommunity" + ] + } + }, + "ipExtendedCommunityProperties": { + "add": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "delete": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + }, + "set": { + "ipExtendedCommunityIds": [ + "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/example-ipExtendedCommunity" + ] + } + } + } + } + ], + "networkFabricId": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/networkFabrics/example-fabric", + "addressFamilyType": "IPv4", + "configurationState": "Succeeded", + "provisioningState": "Accepted", + "administrativeState": "Enabled" + }, + "tags": { + "keyId": "keyValue" + }, + "location": "eastus", + "id": "/subscriptions/1234ABCD-0A1B-1234-5678-123456ABCDEF/resourceGroups/example-rg/providers/Microsoft.ManagedNetworkFabric/routePolicies/example-routePolicy", + "name": "example-routePolicy", + "type": "microsoft.managednetworkfabric/routePolicies", + "systemData": { + "createdBy": "email@address.com", + "createdByType": "User", + "createdAt": "2023-06-09T04:51:41.251Z", + "lastModifiedBy": "UserId", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-06-09T04:51:41.251Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_UpdateAdministrativeState.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_UpdateAdministrativeState.json new file mode 100644 index 000000000000..3d94686a91b9 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_UpdateAdministrativeState.json @@ -0,0 +1,46 @@ +{ + "title": "RoutePolicies_UpdateAdministrativeState_MaximumSet_Gen", + "operationId": "RoutePolicies_UpdateAdministrativeState", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy", + "body": { + "resourceIds": [ + "" + ], + "state": "Enable" + } + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "successfulDevices": [ + "" + ], + "failedDevices": [ + "" + ] + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ValidateConfiguration.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ValidateConfiguration.json new file mode 100644 index 000000000000..c4cf028c87e2 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/examples/RoutePolicies_ValidateConfiguration.json @@ -0,0 +1,35 @@ +{ + "title": "RoutePolicies_ValidateConfiguration_MaximumSet_Gen", + "operationId": "RoutePolicies_ValidateConfiguration", + "parameters": { + "api-version": "2024-06-15-preview", + "subscriptionId": "0000ABCD-0A0B-0000-0000-000000ABCDEF", + "resourceGroupName": "example-rg", + "routePolicyName": "example-routePolicy" + }, + "responses": { + "200": { + "body": { + "error": { + "code": "", + "message": "", + "target": "", + "details": [], + "additionalInfo": [ + { + "type": "", + "info": {} + } + ] + }, + "configurationState": "Succeeded", + "url": "https://ActionDetails" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/managednetworkfabric.json b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/managednetworkfabric.json new file mode 100644 index 000000000000..a7f6f3c60e40 --- /dev/null +++ b/specification/managednetworkfabric/resource-manager/Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/managednetworkfabric.json @@ -0,0 +1,22227 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Network Fabric Management Service API", + "version": "2024-06-15-preview", + "description": "Self service experience for Azure Network Fabric API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AccessControlLists" + }, + { + "name": "InternetGatewayRules" + }, + { + "name": "InternetGateways" + }, + { + "name": "IpCommunities" + }, + { + "name": "IpExtendedCommunities" + }, + { + "name": "IpPrefixes" + }, + { + "name": "L2IsolationDomains" + }, + { + "name": "L3IsolationDomains" + }, + { + "name": "InternalNetworks" + }, + { + "name": "ExternalNetworks" + }, + { + "name": "NeighborGroups" + }, + { + "name": "NetworkDeviceSkus" + }, + { + "name": "NetworkDevices" + }, + { + "name": "NetworkInterfaces" + }, + { + "name": "NetworkFabricControllers" + }, + { + "name": "NetworkFabricSkus" + }, + { + "name": "NetworkFabrics" + }, + { + "name": "NetworkToNetworkInterconnects" + }, + { + "name": "NetworkPacketBrokers" + }, + { + "name": "NetworkRacks" + }, + { + "name": "NetworkTapRules" + }, + { + "name": "NetworkTaps" + }, + { + "name": "RoutePolicies" + }, + { + "name": "NetworkMonitors" + } + ], + "paths": { + "/providers/Microsoft.ManagedNetworkFabric/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/accessControlLists": { + "get": { + "operationId": "AccessControlLists_ListBySubscription", + "tags": [ + "AccessControlLists" + ], + "description": "Implements AccessControlLists list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlListListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules": { + "get": { + "operationId": "InternetGatewayRules_ListBySubscription", + "tags": [ + "InternetGatewayRules" + ], + "description": "List all Internet Gateway rules in the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/internetGateways": { + "get": { + "operationId": "InternetGateways_ListBySubscription", + "tags": [ + "InternetGateways" + ], + "description": "Displays Internet Gateways list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipCommunities": { + "get": { + "operationId": "IpCommunities_ListBySubscription", + "tags": [ + "IpCommunities" + ], + "description": "Implements IP Communities list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities": { + "get": { + "operationId": "IpExtendedCommunities_ListBySubscription", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IpExtendedCommunities list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes": { + "get": { + "operationId": "IpPrefixes_ListBySubscription", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IpPrefixes list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefixListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains": { + "get": { + "operationId": "L2IsolationDomains_ListBySubscription", + "tags": [ + "L2IsolationDomains" + ], + "description": "Displays L2IsolationDomains list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains": { + "get": { + "operationId": "L3IsolationDomains_ListBySubscription", + "tags": [ + "L3IsolationDomains" + ], + "description": "Displays L3IsolationDomains list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/neighborGroups": { + "get": { + "operationId": "NeighborGroups_ListBySubscription", + "tags": [ + "NeighborGroups" + ], + "description": "Displays NeighborGroups list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus": { + "get": { + "operationId": "NetworkDeviceSkus_ListBySubscription", + "tags": [ + "NetworkDeviceSkus" + ], + "description": "List Network Device SKUs for the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDeviceSkus_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkDeviceSkus_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/{networkDeviceSkuName}": { + "get": { + "operationId": "NetworkDeviceSkus_Get", + "tags": [ + "NetworkDeviceSkus" + ], + "description": "Get a Network Device SKU details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "networkDeviceSkuName", + "in": "path", + "description": "Name of the Network Device SKU.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceSku" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDeviceSkus_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkDeviceSkus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDevices": { + "get": { + "operationId": "NetworkDevices_ListBySubscription", + "tags": [ + "NetworkDevices" + ], + "description": "List all the Network Device resources in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers": { + "get": { + "operationId": "NetworkFabricControllers_ListBySubscription", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Lists all the NetworkFabricControllers by subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricControllerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus": { + "get": { + "operationId": "NetworkFabricSkus_ListBySubscription", + "tags": [ + "NetworkFabricSkus" + ], + "description": "Implements Network Fabric SKUs list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricSkus_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricSkus_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/{networkFabricSkuName}": { + "get": { + "operationId": "NetworkFabricSkus_Get", + "tags": [ + "NetworkFabricSkus" + ], + "description": "Implements Network Fabric SKU GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "networkFabricSkuName", + "in": "path", + "description": "Name of the Network Fabric SKU.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricSku" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricSkus_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricSkus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabrics": { + "get": { + "operationId": "NetworkFabrics_ListBySubscription", + "tags": [ + "NetworkFabrics" + ], + "description": "List all the Network Fabric resources in the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkMonitors": { + "get": { + "operationId": "NetworkMonitors_ListBySubscription", + "tags": [ + "NetworkMonitors" + ], + "description": "Displays NetworkMonitors list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkMonitorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_ListBySubscription": { + "$ref": "./examples/NetworkMonitors_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers": { + "get": { + "operationId": "NetworkPacketBrokers_ListBySubscription", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Displays Network Packet Brokers list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBrokerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkRacks": { + "get": { + "operationId": "NetworkRacks_ListBySubscription", + "tags": [ + "NetworkRacks" + ], + "description": "List all Network Rack resources in the given subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRackListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkTapRules": { + "get": { + "operationId": "NetworkTapRules_ListBySubscription", + "tags": [ + "NetworkTapRules" + ], + "description": "List all the Network Tap Rule resources in the given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkTaps": { + "get": { + "operationId": "NetworkTaps_ListBySubscription", + "tags": [ + "NetworkTaps" + ], + "description": "Displays Network Taps list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/routePolicies": { + "get": { + "operationId": "RoutePolicies_ListBySubscription", + "tags": [ + "RoutePolicies" + ], + "description": "Implements RoutePolicies list by subscription GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists": { + "get": { + "operationId": "AccessControlLists_ListByResourceGroup", + "tags": [ + "AccessControlLists" + ], + "description": "Implements AccessControlLists list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlListListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}": { + "get": { + "operationId": "AccessControlLists_Get", + "tags": [ + "AccessControlLists" + ], + "description": "Implements Access Control List GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Get_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Get.json" + } + } + }, + "put": { + "operationId": "AccessControlLists_Create", + "tags": [ + "AccessControlLists" + ], + "description": "Implements Access Control List PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessControlList" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AccessControlList' update operation succeeded", + "schema": { + "$ref": "#/definitions/AccessControlList" + } + }, + "201": { + "description": "Resource 'AccessControlList' create operation succeeded", + "schema": { + "$ref": "#/definitions/AccessControlList" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Create_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AccessControlLists_Update", + "tags": [ + "AccessControlLists" + ], + "description": "API to update certain properties of the Access Control List resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Access Control List properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessControlListPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessControlList" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Update_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AccessControlLists_Delete", + "tags": [ + "AccessControlLists" + ], + "description": "Implements Access Control List DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Delete_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/resync": { + "post": { + "operationId": "AccessControlLists_Resync", + "tags": [ + "AccessControlLists" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_Resync_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_Resync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/updateAdministrativeState": { + "post": { + "operationId": "AccessControlLists_UpdateAdministrativeState", + "tags": [ + "AccessControlLists" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/validateConfiguration": { + "post": { + "operationId": "AccessControlLists_ValidateConfiguration", + "tags": [ + "AccessControlLists" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accessControlListName", + "in": "path", + "description": "Name of the Access Control List.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessControlLists_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/AccessControlLists_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules": { + "get": { + "operationId": "InternetGatewayRules_ListByResourceGroup", + "tags": [ + "InternetGatewayRules" + ], + "description": "Implements Internet Gateway Rules list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/{internetGatewayRuleName}": { + "get": { + "operationId": "InternetGatewayRules_Get", + "tags": [ + "InternetGatewayRules" + ], + "description": "Gets an Internet Gateway Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Get_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Get.json" + } + } + }, + "put": { + "operationId": "InternetGatewayRules_Create", + "tags": [ + "InternetGatewayRules" + ], + "description": "Creates an Internet Gateway rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InternetGatewayRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "201": { + "description": "Resource 'InternetGatewayRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Create_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "InternetGatewayRules_Update", + "tags": [ + "InternetGatewayRules" + ], + "description": "API to update certain properties of the Internet Gateway Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Internet Gateway Rule properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGatewayRulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Update_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "InternetGatewayRules_Delete", + "tags": [ + "InternetGatewayRules" + ], + "description": "Implements Internet Gateway Rules DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayRuleName", + "in": "path", + "description": "Name of the Internet Gateway rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGatewayRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/InternetGatewayRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways": { + "get": { + "operationId": "InternetGateways_ListByResourceGroup", + "tags": [ + "InternetGateways" + ], + "description": "Displays Internet Gateways list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGatewayListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways/{internetGatewayName}": { + "get": { + "operationId": "InternetGateways_Get", + "tags": [ + "InternetGateways" + ], + "description": "Implements Gateway GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGateway" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Get_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Get.json" + } + } + }, + "put": { + "operationId": "InternetGateways_Create", + "tags": [ + "InternetGateways" + ], + "description": "Creates a Network Fabric Service Internet Gateway resource instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGateway" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InternetGateway' update operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGateway" + } + }, + "201": { + "description": "Resource 'InternetGateway' create operation succeeded", + "schema": { + "$ref": "#/definitions/InternetGateway" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Create_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "InternetGateways_Update", + "tags": [ + "InternetGateways" + ], + "description": "Execute patch on Network Fabric Service Internet Gateway.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "API to update certain properties of the InternetGateway resource..", + "required": true, + "schema": { + "$ref": "#/definitions/InternetGatewayPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternetGateway" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Update_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "InternetGateways_Delete", + "tags": [ + "InternetGateways" + ], + "description": "Execute a delete on Network Fabric Service Internet Gateway.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "internetGatewayName", + "in": "path", + "description": "Name of the Internet Gateway.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternetGateways_Delete_MaximumSet_Gen": { + "$ref": "./examples/InternetGateways_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities": { + "get": { + "operationId": "IpCommunities_ListByResourceGroup", + "tags": [ + "IpCommunities" + ], + "description": "Implements IP Communities list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}": { + "get": { + "operationId": "IpCommunities_Get", + "tags": [ + "IpCommunities" + ], + "description": "Implements an IP Community GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Get_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Get.json" + } + } + }, + "put": { + "operationId": "IpCommunities_Create", + "tags": [ + "IpCommunities" + ], + "description": "Implements an IP Community PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/IpCommunity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IpCommunity' update operation succeeded", + "schema": { + "$ref": "#/definitions/IpCommunity" + } + }, + "201": { + "description": "Resource 'IpCommunity' create operation succeeded", + "schema": { + "$ref": "#/definitions/IpCommunity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Create_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IpCommunities_Update", + "tags": [ + "IpCommunities" + ], + "description": "API to update certain properties of the IP Community resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "IP Community properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/IpCommunityPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpCommunity" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Update_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IpCommunities_Delete", + "tags": [ + "IpCommunities" + ], + "description": "Implements IP Community DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipCommunityName", + "in": "path", + "description": "Name of the IP Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpCommunities_Delete_MaximumSet_Gen": { + "$ref": "./examples/IpCommunities_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities": { + "get": { + "operationId": "IpExtendedCommunities_ListByResourceGroup", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IpExtendedCommunities list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}": { + "get": { + "operationId": "IpExtendedCommunities_Get", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IP Extended Community GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Get_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Get.json" + } + } + }, + "put": { + "operationId": "IpExtendedCommunities_Create", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IP Extended Community PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IpExtendedCommunity' update operation succeeded", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "201": { + "description": "Resource 'IpExtendedCommunity' create operation succeeded", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Create_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IpExtendedCommunities_Update", + "tags": [ + "IpExtendedCommunities" + ], + "description": "API to update certain properties of the IP Extended Community resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "IP Extended Community properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/IpExtendedCommunityPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Update_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IpExtendedCommunities_Delete", + "tags": [ + "IpExtendedCommunities" + ], + "description": "Implements IP Extended Community DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipExtendedCommunityName", + "in": "path", + "description": "Name of the IP Extended Community.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpExtendedCommunities_Delete_MaximumSet_Gen": { + "$ref": "./examples/IpExtendedCommunities_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes": { + "get": { + "operationId": "IpPrefixes_ListByResourceGroup", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IpPrefixes list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefixListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}": { + "get": { + "operationId": "IpPrefixes_Get", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IP Prefix GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefix" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Get_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Get.json" + } + } + }, + "put": { + "operationId": "IpPrefixes_Create", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IP Prefix PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/IpPrefix" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IpPrefix' update operation succeeded", + "schema": { + "$ref": "#/definitions/IpPrefix" + } + }, + "201": { + "description": "Resource 'IpPrefix' create operation succeeded", + "schema": { + "$ref": "#/definitions/IpPrefix" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Create_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IpPrefixes_Update", + "tags": [ + "IpPrefixes" + ], + "description": "API to update certain properties of the IP Prefix resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "IP Prefix properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/IpPrefixPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IpPrefix" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Update_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IpPrefixes_Delete", + "tags": [ + "IpPrefixes" + ], + "description": "Implements IP Prefix DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "ipPrefixName", + "in": "path", + "description": "Name of the IP Prefix.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IpPrefixes_Delete_MaximumSet_Gen": { + "$ref": "./examples/IpPrefixes_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains": { + "get": { + "operationId": "L2IsolationDomains_ListByResourceGroup", + "tags": [ + "L2IsolationDomains" + ], + "description": "Displays L2IsolationDomains list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}": { + "get": { + "operationId": "L2IsolationDomains_Get", + "tags": [ + "L2IsolationDomains" + ], + "description": "Implements L2 Isolation Domain GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Get_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Get.json" + } + } + }, + "put": { + "operationId": "L2IsolationDomains_Create", + "tags": [ + "L2IsolationDomains" + ], + "description": "Creates layer 2 network connectivity between compute nodes within a rack and across racks.The configuration is applied on the devices only after the isolation domain is enabled.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + } + ], + "responses": { + "200": { + "description": "Resource 'L2IsolationDomain' update operation succeeded", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "201": { + "description": "Resource 'L2IsolationDomain' create operation succeeded", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Create_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "L2IsolationDomains_Update", + "tags": [ + "L2IsolationDomains" + ], + "description": "API to update certain properties of the L2 Isolation Domain resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "API to update certain properties of the L2 Isolation Domain resource..", + "required": true, + "schema": { + "$ref": "#/definitions/L2IsolationDomainPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Update_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "L2IsolationDomains_Delete", + "tags": [ + "L2IsolationDomains" + ], + "description": "Deletes layer 2 connectivity between compute nodes by managed by named L2 Isolation name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_Delete_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/commitConfiguration": { + "post": { + "operationId": "L2IsolationDomains_CommitConfiguration", + "tags": [ + "L2IsolationDomains" + ], + "description": "Commits the configuration of the given resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/updateAdministrativeState": { + "post": { + "operationId": "L2IsolationDomains_UpdateAdministrativeState", + "tags": [ + "L2IsolationDomains" + ], + "description": "Enables isolation domain across the fabric or on specified racks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/validateConfiguration": { + "post": { + "operationId": "L2IsolationDomains_ValidateConfiguration", + "tags": [ + "L2IsolationDomains" + ], + "description": "Validates the configuration of the resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l2IsolationDomainName", + "in": "path", + "description": "Name of the L2 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L2IsolationDomains_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L2IsolationDomains_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains": { + "get": { + "operationId": "L3IsolationDomains_ListByResourceGroup", + "tags": [ + "L3IsolationDomains" + ], + "description": "Displays L3IsolationDomains list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomainListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}": { + "get": { + "operationId": "L3IsolationDomains_Get", + "tags": [ + "L3IsolationDomains" + ], + "description": "Retrieves details of this L3 Isolation Domain.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Get_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Get.json" + } + } + }, + "put": { + "operationId": "L3IsolationDomains_Create", + "tags": [ + "L3IsolationDomains" + ], + "description": "Create isolation domain resources for layer 3 connectivity between compute nodes and for communication with external services .This configuration is applied on the devices only after the creation of networks is completed and isolation domain is enabled.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + } + ], + "responses": { + "200": { + "description": "Resource 'L3IsolationDomain' update operation succeeded", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "201": { + "description": "Resource 'L3IsolationDomain' create operation succeeded", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Create_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "L3IsolationDomains_Update", + "tags": [ + "L3IsolationDomains" + ], + "description": "API to update certain properties of the L3 Isolation Domain resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "API to update certain properties of the L3 Isolation Domain resource.", + "required": true, + "schema": { + "$ref": "#/definitions/L3IsolationDomainPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Update_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "L3IsolationDomains_Delete", + "tags": [ + "L3IsolationDomains" + ], + "description": "Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_Delete_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/commitConfiguration": { + "post": { + "operationId": "L3IsolationDomains_CommitConfiguration", + "tags": [ + "L3IsolationDomains" + ], + "description": "Commits the configuration of the given resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks": { + "get": { + "operationId": "ExternalNetworks_ListByL3IsolationDomain", + "tags": [ + "ExternalNetworks" + ], + "description": "Implements External Networks list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_ListByL3IsolationDomain.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}": { + "get": { + "operationId": "ExternalNetworks_Get", + "tags": [ + "ExternalNetworks" + ], + "description": "Implements ExternalNetworks GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Get_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "ExternalNetworks_Create", + "tags": [ + "ExternalNetworks" + ], + "description": "Creates ExternalNetwork PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ExternalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "201": { + "description": "Resource 'ExternalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Create_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ExternalNetworks_Update", + "tags": [ + "ExternalNetworks" + ], + "description": "API to update certain properties of the ExternalNetworks resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "ExternalNetwork properties to update. Only annotations are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalNetworkPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Update_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ExternalNetworks_Delete", + "tags": [ + "ExternalNetworks" + ], + "description": "Implements ExternalNetworks DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_Delete_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}/updateAdministrativeState": { + "post": { + "operationId": "ExternalNetworks_UpdateAdministrativeState", + "tags": [ + "ExternalNetworks" + ], + "description": "Executes update operation to enable or disable administrative State for externalNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/ExternalNetworks_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}/updateBfdAdministrativeState": { + "post": { + "operationId": "ExternalNetworks_UpdateBfdAdministrativeState", + "tags": [ + "ExternalNetworks" + ], + "description": "BFD administrative state for either static or bgp for internalNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "externalNetworkName", + "in": "path", + "description": "Name of the External Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalNetworkBfdAdministrativeStateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ExternalNetworkBfdAdministrativeStateResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalNetworks_UpdateBfdAdministrativeState": { + "$ref": "./examples/ExternalNetworks_UpdateBfdAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks": { + "get": { + "operationId": "InternalNetworks_ListByL3IsolationDomain", + "tags": [ + "InternalNetworks" + ], + "description": "Displays InternalNetworks list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_ListByL3IsolationDomain_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_ListByL3IsolationDomain.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}": { + "get": { + "operationId": "InternalNetworks_Get", + "tags": [ + "InternalNetworks" + ], + "description": "Gets a InternalNetworks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Get_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "InternalNetworks_Create", + "tags": [ + "InternalNetworks" + ], + "description": "Creates InternalNetwork PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InternalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "201": { + "description": "Resource 'InternalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/InternalNetwork" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Create_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "InternalNetworks_Update", + "tags": [ + "InternalNetworks" + ], + "description": "Updates a InternalNetworks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "InternalNetwork properties to update. Only annotations are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/InternalNetworkPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Update_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "InternalNetworks_Delete", + "tags": [ + "InternalNetworks" + ], + "description": "Implements InternalNetworks DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_Delete_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateAdministrativeState": { + "post": { + "operationId": "InternalNetworks_UpdateAdministrativeState", + "tags": [ + "InternalNetworks" + ], + "description": "Update Administrative state of InternalNetworks on resources referred by their resource ids.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateBfdAdministrativeState": { + "post": { + "operationId": "InternalNetworks_UpdateBfdAdministrativeState", + "tags": [ + "InternalNetworks" + ], + "description": "BFD administrative state for either static or bgp for internalNetwork.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternalNetworkBfdAdministrativeStateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetworkBfdAdministrativeStateResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_UpdateBfdAdministrativeState": { + "$ref": "./examples/InternalNetworks_UpdateBfdAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateBgpAdministrativeState": { + "post": { + "operationId": "InternalNetworks_UpdateBgpAdministrativeState", + "tags": [ + "InternalNetworks" + ], + "description": "Update BGP state for internalNetwork. Allowed only on edge devices.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "internalNetworkName", + "in": "path", + "description": "Name of the Internal Network.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/InternalNetworkBgpAdministrativeStateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InternalNetworkBgpAdministrativeStateResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "InternalNetworks_UpdateBgpAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/InternalNetworks_UpdateBgpAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/updateAdministrativeState": { + "post": { + "operationId": "L3IsolationDomains_UpdateAdministrativeState", + "tags": [ + "L3IsolationDomains" + ], + "description": "Enables racks for this Isolation Domain.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/validateConfiguration": { + "post": { + "operationId": "L3IsolationDomains_ValidateConfiguration", + "tags": [ + "L3IsolationDomains" + ], + "description": "Validates the configuration of the resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "l3IsolationDomainName", + "in": "path", + "description": "Name of the L3 Isolation Domain.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "L3IsolationDomains_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/L3IsolationDomains_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups": { + "get": { + "operationId": "NeighborGroups_ListByResourceGroup", + "tags": [ + "NeighborGroups" + ], + "description": "Displays NeighborGroups list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}": { + "get": { + "operationId": "NeighborGroups_Get", + "tags": [ + "NeighborGroups" + ], + "description": "Gets the Neighbor Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Get_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Get.json" + } + } + }, + "put": { + "operationId": "NeighborGroups_Create", + "tags": [ + "NeighborGroups" + ], + "description": "Implements the Neighbor Group PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NeighborGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "201": { + "description": "Resource 'NeighborGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NeighborGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Create_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NeighborGroups_Update", + "tags": [ + "NeighborGroups" + ], + "description": "Updates the Neighbor Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Neighbor Group properties to update. Only annotations are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/NeighborGroupPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Update_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NeighborGroups_Delete", + "tags": [ + "NeighborGroups" + ], + "description": "Implements Neighbor Group DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "neighborGroupName", + "in": "path", + "description": "Name of the Neighbor Group.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NeighborGroups_Delete_MaximumSet_Gen": { + "$ref": "./examples/NeighborGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices": { + "get": { + "operationId": "NetworkDevices_ListByResourceGroup", + "tags": [ + "NetworkDevices" + ], + "description": "List all the Network Device resources in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}": { + "get": { + "operationId": "NetworkDevices_Get", + "tags": [ + "NetworkDevices" + ], + "description": "Gets the Network Device resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Get.json" + } + } + }, + "put": { + "operationId": "NetworkDevices_Create", + "tags": [ + "NetworkDevices" + ], + "description": "Create a Network Device resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkDevice' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "201": { + "description": "Resource 'NetworkDevice' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkDevice" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkDevices_Update", + "tags": [ + "NetworkDevices" + ], + "description": "Update certain properties of the Network Device resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Device properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkDevicePatchParameters" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkDevices_Delete", + "tags": [ + "NetworkDevices" + ], + "description": "Delete the Network Device resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListByNetworkDevice", + "tags": [ + "NetworkInterfaces" + ], + "description": "List all the Network Interface resources in a given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_ListByNetworkDevice_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_ListByNetworkDevice.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}": { + "get": { + "operationId": "NetworkInterfaces_Get", + "tags": [ + "NetworkInterfaces" + ], + "description": "Get the Network Interface resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "NetworkInterfaces_Create", + "tags": [ + "NetworkInterfaces" + ], + "description": "Create a Network Interface resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "201": { + "description": "Resource 'NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkInterfaces_Update", + "tags": [ + "NetworkInterfaces" + ], + "description": "Update certain properties of the Network Interface resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "NetworkInterface properties to update. Only tags are supported.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfacePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkInterfaces_Delete", + "tags": [ + "NetworkInterfaces" + ], + "description": "Delete the Network Interface resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkInterfaces_UpdateAdministrativeState", + "tags": [ + "NetworkInterfaces" + ], + "description": "Update the admin state of the Network Interface.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkInterfaceName", + "in": "path", + "description": "Name of the Network Interface.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkInterfaces_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkInterfaces_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/reboot": { + "post": { + "operationId": "NetworkDevices_Reboot", + "tags": [ + "NetworkDevices" + ], + "description": "Reboot the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/RebootProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Reboot_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Reboot.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/refreshConfiguration": { + "post": { + "operationId": "NetworkDevices_RefreshConfiguration", + "tags": [ + "NetworkDevices" + ], + "description": "Refreshes the configuration the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_RefreshConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_RefreshConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/runRoCommand": { + "post": { + "operationId": "NetworkDevices_RunRoCommand", + "tags": [ + "NetworkDevices" + ], + "description": "Run the RO Command on the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request the command.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceRoCommand" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceROCommandsOperationStatusResult" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_RunRoCommand_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_RunRoCommand.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/runRwCommand": { + "post": { + "operationId": "NetworkDevices_RunRwCommand", + "tags": [ + "NetworkDevices" + ], + "description": "Run the RW Command on the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request the command.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceRwCommand" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceRWCommands" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_RunRwCommand_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_RunRwCommand.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkDevices_UpdateAdministrativeState", + "tags": [ + "NetworkDevices" + ], + "description": "Updates the Administrative state of the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateDeviceAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/upgrade": { + "post": { + "operationId": "NetworkDevices_Upgrade", + "tags": [ + "NetworkDevices" + ], + "description": "Upgrades the version of the Network Device.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkDeviceName", + "in": "path", + "description": "Name of the Network Device.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateVersion" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkDevices_Upgrade_MaximumSet_Gen": { + "$ref": "./examples/NetworkDevices_Upgrade.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers": { + "get": { + "operationId": "NetworkFabricControllers_ListByResourceGroup", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Lists all the NetworkFabricControllers thats available in the resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricControllerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/{networkFabricControllerName}": { + "get": { + "operationId": "NetworkFabricControllers_Get", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Shows the provisioning status of Network Fabric Controller.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFabricControllers_Create", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Creates a Network Fabric Controller.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFabricController' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "201": { + "description": "Resource 'NetworkFabricController' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFabricControllers_Update", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Updates are currently not supported for the Network Fabric Controller resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Fabric Controller properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricControllerPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFabricControllers_Delete", + "tags": [ + "NetworkFabricControllers" + ], + "description": "Deletes the Network Fabric Controller resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricControllerName", + "in": "path", + "description": "Name of the Network Fabric Controller.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabricControllers_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabricControllers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics": { + "get": { + "operationId": "NetworkFabrics_ListByResourceGroup", + "tags": [ + "NetworkFabrics" + ], + "description": "List all the Network Fabric resources in the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabricListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}": { + "get": { + "operationId": "NetworkFabrics_Get", + "tags": [ + "NetworkFabrics" + ], + "description": "Get Network Fabric resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFabrics_Create", + "tags": [ + "NetworkFabrics" + ], + "description": "Create Network Fabric resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFabric' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "201": { + "description": "Resource 'NetworkFabric' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFabric" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFabrics_Update", + "tags": [ + "NetworkFabrics" + ], + "description": "Update certain properties of the Network Fabric resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Fabric properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFabrics_Delete", + "tags": [ + "NetworkFabrics" + ], + "description": "Delete Network Fabric resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/armConfigurationDiff": { + "post": { + "operationId": "NetworkFabrics_ArmConfigurationDiff", + "tags": [ + "NetworkFabrics" + ], + "description": "Post action: Triggers diff of NetworkFabric ARM Configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ArmConfigurationDiffResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ArmConfigurationDiff_MaximumSet": { + "$ref": "./examples/NetworkFabrics_ArmConfigurationDiff.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/commitBatchStatus": { + "post": { + "operationId": "NetworkFabrics_CommitBatchStatus", + "tags": [ + "NetworkFabrics" + ], + "description": "Post action: Returns a status of commit batch operation.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/CommitBatchStatusRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommitBatchStatusResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_CommitBatchStatus_MaximumSet": { + "$ref": "./examples/NetworkFabrics_CommitBatchStatus.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/commitConfiguration": { + "post": { + "operationId": "NetworkFabrics_CommitConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/deprovision": { + "post": { + "operationId": "NetworkFabrics_Deprovision", + "tags": [ + "NetworkFabrics" + ], + "description": "Deprovisions the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Deprovision_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Deprovision.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/discardCommitBatch": { + "post": { + "operationId": "NetworkFabrics_DiscardCommitBatch", + "tags": [ + "NetworkFabrics" + ], + "description": "Post action: Discards a Batch operation in progress.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/DiscardCommitBatchRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DiscardCommitBatchResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_DiscardCommitBatch": { + "$ref": "./examples/NetworkFabrics_DiscardCommitBatch.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/getTopology": { + "post": { + "operationId": "NetworkFabrics_GetTopology", + "tags": [ + "NetworkFabrics" + ], + "description": "Gets Topology of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_GetTopology_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_GetTopology.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/lockFabric": { + "post": { + "operationId": "NetworkFabrics_LockFabric", + "tags": [ + "NetworkFabrics" + ], + "description": "Post action: Triggers network fabric lock operation.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFabricLockRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_LockFabric_MaximumSet": { + "$ref": "./examples/NetworkFabrics_LockFabric.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects": { + "get": { + "operationId": "NetworkToNetworkInterconnects_ListByNetworkFabric", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Implements Network To Network Interconnects list by Network Fabric GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_ListByNetworkFabric_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_ListByNetworkFabric.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}": { + "get": { + "operationId": "NetworkToNetworkInterconnects_Get", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Implements NetworkToNetworkInterconnects GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Get.json" + } + } + }, + "put": { + "operationId": "NetworkToNetworkInterconnects_Create", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Configuration used to setup CE-PE connectivity PUT Method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkToNetworkInterconnect' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "201": { + "description": "Resource 'NetworkToNetworkInterconnect' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkToNetworkInterconnects_Update", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Update certain properties of the Network To NetworkInterconnects resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network to Network Interconnect properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnectPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkToNetworkInterconnects_Delete", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Implements NetworkToNetworkInterconnects DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkToNetworkInterconnects_UpdateAdministrativeState", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Updates the Admin State.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkToNetworkInterconnects_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}/updateBfdAdministrativeState": { + "post": { + "operationId": "NetworkToNetworkInterconnects_UpdateBfdAdministrativeState", + "tags": [ + "NetworkToNetworkInterconnects" + ], + "description": "Updates the Admin State.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "networkToNetworkInterconnectName", + "in": "path", + "description": "Name of the Network to Network Interconnect.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NniBfdAdministrativeStateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NniBfdAdministrativeStateResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkToNetworkInterconnects_UpdateBfdAdministrativeState": { + "$ref": "./examples/NetworkToNetworkInterconnects_UpdateBfdAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/provision": { + "post": { + "operationId": "NetworkFabrics_Provision", + "tags": [ + "NetworkFabrics" + ], + "description": "Provisions the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Provision_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Provision.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/refreshConfiguration": { + "post": { + "operationId": "NetworkFabrics_RefreshConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Refreshes the configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_RefreshConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_RefreshConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/updateInfraManagementBfdConfiguration": { + "post": { + "operationId": "NetworkFabrics_UpdateInfraManagementBfdConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_UpdateInfraManagementBfdConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_UpdateInfraManagementBfdConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/updateWorkloadManagementBfdConfiguration": { + "post": { + "operationId": "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_UpdateWorkloadManagementBfdConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_UpdateWorkloadManagementBfdConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/upgrade": { + "post": { + "operationId": "NetworkFabrics_Upgrade", + "tags": [ + "NetworkFabrics" + ], + "description": "Upgrades the version of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Network Fabric properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/UpgradeNetworkFabricProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_Upgrade_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_Upgrade.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/validateConfiguration": { + "post": { + "operationId": "NetworkFabrics_ValidateConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Validates the configuration of the underlying resources in the given Network Fabric instance.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Validate configuration properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateConfigurationProperties" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkFabrics_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/viewDeviceConfiguration": { + "post": { + "operationId": "NetworkFabrics_ViewDeviceConfiguration", + "tags": [ + "NetworkFabrics" + ], + "description": "Post action: Triggers view of network fabric configuration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkFabricName", + "in": "path", + "description": "Name of the Network Fabric.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ViewDeviceConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFabrics_ViewDeviceConfiguration_MaximumSet": { + "$ref": "./examples/NetworkFabrics_ViewDeviceConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkMonitors": { + "get": { + "operationId": "NetworkMonitors_ListByResourceGroup", + "tags": [ + "NetworkMonitors" + ], + "description": "Displays NetworkMonitors list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkMonitorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_ListByResourceGroup": { + "$ref": "./examples/NetworkMonitors_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkMonitors/{networkMonitorName}": { + "get": { + "operationId": "NetworkMonitors_Get", + "tags": [ + "NetworkMonitors" + ], + "description": "Implements NetworkMonitor GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkMonitorName", + "in": "path", + "description": "Name of the Network Monitor.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkMonitor" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_Get_MaximumSet": { + "$ref": "./examples/NetworkMonitors_Get.json" + } + } + }, + "put": { + "operationId": "NetworkMonitors_Create", + "tags": [ + "NetworkMonitors" + ], + "description": "Creates NetworkMonitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkMonitorName", + "in": "path", + "description": "Name of the Network Monitor.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkMonitor" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkMonitor' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkMonitor" + } + }, + "201": { + "description": "Resource 'NetworkMonitor' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkMonitor" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_Create": { + "$ref": "./examples/NetworkMonitors_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkMonitors_Update", + "tags": [ + "NetworkMonitors" + ], + "description": "API to update certain properties of the NetworkMonitor resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkMonitorName", + "in": "path", + "description": "Name of the Network Monitor.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkMonitorPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkMonitor" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_Update": { + "$ref": "./examples/NetworkMonitors_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkMonitors_Delete", + "tags": [ + "NetworkMonitors" + ], + "description": "Deletes layer 2 connectivity between compute nodes by managed by named NetworkMonitor name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkMonitorName", + "in": "path", + "description": "Name of the Network Monitor.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_Delete_MaximumSet": { + "$ref": "./examples/NetworkMonitors_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkMonitors/{networkMonitorName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkMonitors_UpdateAdministrativeState", + "tags": [ + "NetworkMonitors" + ], + "description": "Enables isolation domain across the fabric or on specified racks.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkMonitorName", + "in": "path", + "description": "Name of the Network Monitor.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkMonitors_UpdateAdministrativeState": { + "$ref": "./examples/NetworkMonitors_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers": { + "get": { + "operationId": "NetworkPacketBrokers_ListByResourceGroup", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Displays NetworkPacketBrokers list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBrokerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/{networkPacketBrokerName}": { + "get": { + "operationId": "NetworkPacketBrokers_Get", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Retrieves details of this Network Packet Broker.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Get.json" + } + } + }, + "put": { + "operationId": "NetworkPacketBrokers_Create", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Creates a Network Packet Broker.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkPacketBroker' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "201": { + "description": "Resource 'NetworkPacketBroker' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkPacketBrokers_Update", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "API to update certain properties of the Network Packet Broker resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Packet Broker properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkPacketBrokerPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkPacketBrokers_Delete", + "tags": [ + "NetworkPacketBrokers" + ], + "description": "Deletes Network Packet Broker.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkPacketBrokerName", + "in": "path", + "description": "Name of the Network Packet Broker.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkPacketBrokers_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkPacketBrokers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks": { + "get": { + "operationId": "NetworkRacks_ListByResourceGroup", + "tags": [ + "NetworkRacks" + ], + "description": "List all Network Rack resources in the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRackListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks/{networkRackName}": { + "get": { + "operationId": "NetworkRacks_Get", + "tags": [ + "NetworkRacks" + ], + "description": "Get Network Rack resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRack" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Get.json" + } + } + }, + "put": { + "operationId": "NetworkRacks_Create", + "tags": [ + "NetworkRacks" + ], + "description": "Create Network Rack resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRack" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkRack' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkRack" + } + }, + "201": { + "description": "Resource 'NetworkRack' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkRack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkRacks_Update", + "tags": [ + "NetworkRacks" + ], + "description": "Update certain properties of the Network Rack resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Rack properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRackPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkRack" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkRacks_Delete", + "tags": [ + "NetworkRacks" + ], + "description": "Delete Network Rack resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkRackName", + "in": "path", + "description": "Name of the Network Rack.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkRacks_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkRacks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules": { + "get": { + "operationId": "NetworkTapRules_ListByResourceGroup", + "tags": [ + "NetworkTapRules" + ], + "description": "List all the Network Tap Rule resources in the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}": { + "get": { + "operationId": "NetworkTapRules_Get", + "tags": [ + "NetworkTapRules" + ], + "description": "Get Network Tap Rule resource details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Get.json" + } + } + }, + "put": { + "operationId": "NetworkTapRules_Create", + "tags": [ + "NetworkTapRules" + ], + "description": "Create Network Tap Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkTapRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "201": { + "description": "Resource 'NetworkTapRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkTapRules_Update", + "tags": [ + "NetworkTapRules" + ], + "description": "Update certain properties of the Network Tap Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Tap Rule properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTapRulePatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkTapRules_Delete", + "tags": [ + "NetworkTapRules" + ], + "description": "Delete Network Tap Rule resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/resync": { + "post": { + "operationId": "NetworkTapRules_Resync", + "tags": [ + "NetworkTapRules" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_Resync_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_Resync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkTapRules_UpdateAdministrativeState", + "tags": [ + "NetworkTapRules" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/validateConfiguration": { + "post": { + "operationId": "NetworkTapRules_ValidateConfiguration", + "tags": [ + "NetworkTapRules" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapRuleName", + "in": "path", + "description": "Name of the Network Tap Rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTapRules_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/NetworkTapRules_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps": { + "get": { + "operationId": "NetworkTaps_ListByResourceGroup", + "tags": [ + "NetworkTaps" + ], + "description": "Displays Network Taps list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTapListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}": { + "get": { + "operationId": "NetworkTaps_Get", + "tags": [ + "NetworkTaps" + ], + "description": "Retrieves details of this Network Tap.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTap" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Get_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Get.json" + } + } + }, + "put": { + "operationId": "NetworkTaps_Create", + "tags": [ + "NetworkTaps" + ], + "description": "Creates a Network Tap.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTap" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkTap' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTap" + } + }, + "201": { + "description": "Resource 'NetworkTap' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkTap" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Create_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkTaps_Update", + "tags": [ + "NetworkTaps" + ], + "description": "API to update certain properties of the Network Tap resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Network Tap properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkTapPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkTap" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Update_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkTaps_Delete", + "tags": [ + "NetworkTaps" + ], + "description": "Deletes Network Tap.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Delete_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}/resync": { + "post": { + "operationId": "NetworkTaps_Resync", + "tags": [ + "NetworkTaps" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_Resync_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_Resync.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}/updateAdministrativeState": { + "post": { + "operationId": "NetworkTaps_UpdateAdministrativeState", + "tags": [ + "NetworkTaps" + ], + "description": "Implements the operation to the underlying resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "networkTapName", + "in": "path", + "description": "Name of the Network Tap.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkTaps_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/NetworkTaps_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies": { + "get": { + "operationId": "RoutePolicies_ListByResourceGroup", + "tags": [ + "RoutePolicies" + ], + "description": "Implements RoutePolicies list by resource group GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}": { + "get": { + "operationId": "RoutePolicies_Get", + "tags": [ + "RoutePolicies" + ], + "description": "Implements Route Policy GET method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Get_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Get.json" + } + } + }, + "put": { + "operationId": "RoutePolicies_Create", + "tags": [ + "RoutePolicies" + ], + "description": "Implements Route Policy PUT method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "resource", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RoutePolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "201": { + "description": "Resource 'RoutePolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/RoutePolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Create_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RoutePolicies_Update", + "tags": [ + "RoutePolicies" + ], + "description": "API to update certain properties of the Route Policy resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "properties", + "in": "body", + "description": "Route Policy properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/RoutePolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Update_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RoutePolicies_Delete", + "tags": [ + "RoutePolicies" + ], + "description": "Implements Route Policy DELETE method.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_Delete_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/commitConfiguration": { + "post": { + "operationId": "RoutePolicies_CommitConfiguration", + "tags": [ + "RoutePolicies" + ], + "description": "Commits the configuration of the given resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForStateUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_CommitConfiguration_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_CommitConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/updateAdministrativeState": { + "post": { + "operationId": "RoutePolicies_UpdateAdministrativeState", + "tags": [ + "RoutePolicies" + ], + "description": "Updated the admin state for this Route Policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + }, + { + "name": "body", + "in": "body", + "description": "Request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateAdministrativeState" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceUpdate" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_UpdateAdministrativeState_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_UpdateAdministrativeState.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/validateConfiguration": { + "post": { + "operationId": "RoutePolicies_ValidateConfiguration", + "tags": [ + "RoutePolicies" + ], + "description": "Validates the configuration of the resources.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "routePolicyName", + "in": "path", + "description": "Name of the Route Policy.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z]{1}[a-zA-Z0-9-_]{2,127}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateConfigurationResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RoutePolicies_ValidateConfiguration_MaximumSet_Gen": { + "$ref": "./examples/RoutePolicies_ValidateConfiguration.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessControlList": { + "type": "object", + "description": "The Access Control List resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/AccessControlListProperties", + "description": "The Access ControlList properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AccessControlListAction": { + "type": "object", + "description": "Action that need to performed.", + "properties": { + "type": { + "$ref": "#/definitions/AclActionType", + "description": "Type of actions that can be performed." + }, + "counterName": { + "type": "string", + "description": "Name of the counter block to get match count information.", + "minLength": 1 + }, + "remarkComment": { + "type": "string", + "description": "Remark comment" + }, + "policeRateConfiguration": { + "$ref": "#/definitions/PoliceRateConfigurationProperties", + "description": "Police rate configuration" + } + } + }, + "AccessControlListActionPatch": { + "type": "object", + "description": "Action that need to be performed", + "properties": { + "type": { + "$ref": "#/definitions/AclActionType", + "description": "Type of actions that can be performed." + }, + "counterName": { + "type": "string", + "description": "Name of the counter block to get match count information.", + "minLength": 1 + }, + "remarkComment": { + "type": "string", + "description": "Remark comment" + }, + "policeRateConfiguration": { + "$ref": "#/definitions/PoliceRateConfigurationProperties", + "description": "Police rate configuration" + } + } + }, + "AccessControlListListResult": { + "type": "object", + "description": "The response of a AccessControlList list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AccessControlList items on this page", + "items": { + "$ref": "#/definitions/AccessControlList" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccessControlListMatchCondition": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchCondition", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchCondition", + "description": "IP condition that needs to be matched." + }, + "etherTypes": { + "type": "array", + "description": "List of ether type values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "fragments": { + "type": "array", + "description": "List of IP fragment packets that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipLengths": { + "type": "array", + "description": "List of IP Lengths that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ttlValues": { + "type": "array", + "description": "List of TTL [Time To Live] values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "dscpMarkings": { + "type": "array", + "description": "List of DSCP Markings that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "protocolNeighbors": { + "type": "array", + "description": "Protocol neighbors that need to be matched.", + "items": { + "type": "string" + } + }, + "portCondition": { + "$ref": "#/definitions/AccessControlListPortCondition", + "description": "Defines the port condition that needs to be matched." + }, + "icmpConfiguration": { + "$ref": "#/definitions/IcmpConfigurationProperties", + "description": "Internet Control Message Protocol (ICMP) configuration" + } + } + }, + "AccessControlListMatchConditionPatch": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchConditionPatch", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchConditionPatch", + "description": "IP condition that needs to be matched." + }, + "etherTypes": { + "type": "array", + "description": "List of ether type values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "fragments": { + "type": "array", + "description": "List of IP fragment packets that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipLengths": { + "type": "array", + "description": "List of IP Lengths that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ttlValues": { + "type": "array", + "description": "List of TTL [Time To Live] values that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "dscpMarkings": { + "type": "array", + "description": "List of DSCP Markings that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "portCondition": { + "$ref": "#/definitions/AccessControlListPortConditionPatch", + "description": "Defines the port condition that needs to be matched." + }, + "protocolNeighbors": { + "type": "array", + "description": "Protocol neighbors that need to be matched.", + "items": { + "type": "string" + } + }, + "icmpConfiguration": { + "$ref": "#/definitions/IcmpConfigurationPatchProperties", + "description": "Internet Control Message Protocol (ICMP) configuration" + } + } + }, + "AccessControlListMatchConfiguration": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchCondition" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListAction" + }, + "x-ms-identifiers": [] + } + } + }, + "AccessControlListMatchConfigurationPatch": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchConditionPatch" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListActionPatch" + }, + "x-ms-identifiers": [] + } + } + }, + "AccessControlListPatch": { + "type": "object", + "description": "The Access Control Lists patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AccessControlListPatchProperties", + "description": "Access Control Lists patch properties." + } + } + }, + "AccessControlListPatchProperties": { + "type": "object", + "description": "Access Control Lists patch properties.", + "properties": { + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Access Control List." + }, + "aclsUrl": { + "type": "string", + "format": "uri", + "description": "Access Control List file URL." + }, + "defaultAction": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny." + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + }, + "aclType": { + "$ref": "#/definitions/AclType", + "description": "Access Control List (ACL) Type" + }, + "deviceRole": { + "$ref": "#/definitions/DeviceRole", + "description": "Device Role" + }, + "globalAccessControlListActions": { + "$ref": "#/definitions/GlobalAccessControlListActionPatchProperties", + "description": "Global Access Control List (ACL) actions" + }, + "annotation": { + "type": "string", + "description": "Switch configuration description." + } + } + }, + "AccessControlListPortCondition": { + "type": "object", + "description": "Defines the port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + }, + "flags": { + "type": "array", + "description": "List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg", + "items": { + "type": "string" + } + } + }, + "required": [ + "layer4Protocol" + ] + }, + "AccessControlListPortConditionPatch": { + "type": "object", + "description": "Defines the port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + }, + "flags": { + "type": "array", + "description": "List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg", + "items": { + "type": "string" + } + } + } + }, + "AccessControlListProperties": { + "type": "object", + "description": "Access Control List Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Access Control List." + }, + "aclsUrl": { + "type": "string", + "format": "uri", + "description": "Access Control List file URL." + }, + "defaultAction": { + "type": "string", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny.", + "default": "Permit", + "enum": [ + "Permit", + "Deny" + ], + "x-ms-enum": { + "name": "CommunityActionTypes", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Permit Community Action Types" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny Community Action Types" + } + ] + } + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AccessControlListMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "lastSyncedTime": { + "type": "string", + "format": "date-time", + "description": "The last synced timestamp.", + "readOnly": true + }, + "aclType": { + "$ref": "#/definitions/AclType", + "description": "Access Control List (ACL) Type" + }, + "deviceRole": { + "$ref": "#/definitions/DeviceRole", + "description": "Device Role" + }, + "globalAccessControlListActions": { + "$ref": "#/definitions/GlobalAccessControlListActionProperties", + "description": "Global Access Control List (ACL) actions" + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "configurationType" + ] + }, + "AclActionType": { + "type": "string", + "description": "Type of actions that can be performed.", + "enum": [ + "Drop", + "Count", + "Log", + "Remark", + "PoliceRate" + ], + "x-ms-enum": { + "name": "AclActionType", + "modelAsString": true, + "values": [ + { + "name": "Drop", + "value": "Drop", + "description": "AclActionType Drop" + }, + { + "name": "Count", + "value": "Count", + "description": "AclActionType Count" + }, + { + "name": "Log", + "value": "Log", + "description": "AclActionType Log" + }, + { + "name": "Remark", + "value": "Remark", + "description": "AclActionType Remark" + }, + { + "name": "PoliceRate", + "value": "PoliceRate", + "description": "AclActionType PoliceRate" + } + ] + } + }, + "AclType": { + "type": "string", + "description": "Access Control List (ACL) Type", + "enum": [ + "ControlPlaneTrafficPolicy", + "Tenant", + "Management" + ], + "x-ms-enum": { + "name": "AclType", + "modelAsString": true, + "values": [ + { + "name": "Cp", + "value": "ControlPlaneTrafficPolicy", + "description": "AclType Control Plane Traffic Policy" + }, + { + "name": "Tenant", + "value": "Tenant", + "description": "AclType Tenant" + }, + { + "name": "Management", + "value": "Management", + "description": "AclType Management" + } + ] + } + }, + "Action": { + "type": "string", + "description": "Specify action.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Action Allow" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Action Deny" + } + ] + } + }, + "ActionIpCommunityPatchProperties": { + "type": "object", + "description": "IP Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "set": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + } + } + }, + "ActionIpCommunityProperties": { + "type": "object", + "description": "IP Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + }, + "set": { + "$ref": "#/definitions/IpCommunityIdList", + "description": "List of IP Community IDs." + } + } + }, + "ActionIpExtendedCommunityPatchProperties": { + "type": "object", + "description": "IP Extended Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "set": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + } + } + }, + "ActionIpExtendedCommunityProperties": { + "type": "object", + "description": "IP Extended Community Properties.", + "properties": { + "add": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "delete": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + }, + "set": { + "$ref": "#/definitions/IpExtendedCommunityIdList", + "description": "List of IP Extended Community IDs." + } + } + }, + "AdministrativeState": { + "type": "string", + "description": "State defined to represent administrative actions or post actions on a particular resource.", + "enum": [ + "Enabled", + "Disabled", + "MAT", + "RMA", + "UnderMaintenance" + ], + "x-ms-enum": { + "name": "AdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled Administrative State" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled Administrative State" + }, + { + "name": "MAT", + "value": "MAT", + "description": "MAT(Manual Action Taken) Administrative State" + }, + { + "name": "RMA", + "value": "RMA", + "description": "RMA(Return Material Authorization) Administrative State" + }, + { + "name": "UnderMaintenance", + "value": "UnderMaintenance", + "description": "UnderMaintenance Administrative State" + } + ] + } + }, + "AggregateRoute": { + "type": "object", + "description": "aggregateIpv4Route model.", + "properties": { + "prefix": { + "type": "string", + "description": "IPv4 Prefix of the aggregate Ipv4Route.", + "minLength": 1 + } + }, + "required": [ + "prefix" + ] + }, + "AggregateRouteConfiguration": { + "type": "object", + "description": "List of IPv4 and IPv6 aggregate routes.", + "properties": { + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Route prefixes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AggregateRoute" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of Ipv6Routes prefixes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AggregateRoute" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "AggregateRoutePatchConfiguration": { + "type": "object", + "description": "List of IPv4 and IPv6 aggregate routes.", + "properties": { + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Route prefixes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AggregateRoute" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of Ipv6Routes prefixes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/AggregateRoute" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "AllowASOverride": { + "type": "string", + "description": "Enable Or Disable state.", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "AllowASOverride", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "AllowASOverride-Enable" + }, + { + "name": "Disable", + "value": "Disable", + "description": "AllowASOverride-Disable" + } + ] + } + }, + "ArmConfigurationDiffResponse": { + "type": "object", + "description": "Arm Configuration Diff Response.", + "properties": { + "configurationDiffUrl": { + "type": "string", + "description": "Storage URL to the diff file." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "BfdAdministrativeState": { + "type": "string", + "description": "Administrative state of the BfdConfiguration. Example: Enabled | Disabled.", + "enum": [ + "Enabled", + "Disabled", + "MAT", + "RMA" + ], + "x-ms-enum": { + "name": "BfdAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Represents the enabled state of BFD administrative state." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Represents the disabled state of BFD administrative state." + }, + { + "name": "MAT", + "value": "MAT", + "description": "Represents the MAT(Manual Action Taken) state of BFD administrative state." + }, + { + "name": "RMA", + "value": "RMA", + "description": "Represents the RMA(Return Material Authorization) state of BFD administrative state." + } + ] + } + }, + "BfdConfiguration": { + "type": "object", + "description": "BFD configuration properties", + "properties": { + "administrativeState": { + "type": "string", + "description": "Administrative state of the BfdConfiguration. Example: Enabled | Disabled.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled", + "MAT", + "RMA" + ], + "x-ms-enum": { + "name": "BfdAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Represents the enabled state of BFD administrative state." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Represents the disabled state of BFD administrative state." + }, + { + "name": "MAT", + "value": "MAT", + "description": "Represents the MAT(Manual Action Taken) state of BFD administrative state." + }, + { + "name": "RMA", + "value": "RMA", + "description": "Represents the RMA(Return Material Authorization) state of BFD administrative state." + } + ] + }, + "readOnly": true + }, + "intervalInMilliSeconds": { + "type": "integer", + "format": "int32", + "description": "Interval in milliseconds. Example: 300.", + "default": 300 + }, + "multiplier": { + "type": "integer", + "format": "int32", + "description": "Multiplier for the Bfd Configuration. Example: 5.", + "default": 5 + } + } + }, + "BfdPatchConfiguration": { + "type": "object", + "description": "BFD configuration properties", + "properties": { + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "Administrative state of the BfdConfiguration. Example: Enabled | Disabled.", + "readOnly": true + }, + "intervalInMilliSeconds": { + "type": "integer", + "format": "int32", + "description": "Interval in milliseconds. Example: 300." + }, + "multiplier": { + "type": "integer", + "format": "int32", + "description": "Multiplier for the Bfd Configuration. Example: 5." + } + } + }, + "BgpAdministrativeState": { + "type": "string", + "description": "Border Gateway Protocol (BGP) Administrative State values", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "BgpAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "BgpAdministrativeState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "BgpAdministrativeState-Disabled" + } + ] + } + }, + "BgpConfiguration": { + "type": "object", + "description": "BGP configuration properties", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "defaultRouteOriginate": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Originate a defaultRoute. Ex: \"True\" | \"False\"." + }, + "allowAS": { + "type": "integer", + "format": "int32", + "description": "Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2.", + "default": 2, + "minimum": 0, + "maximum": 10 + }, + "allowASOverride": { + "$ref": "#/definitions/AllowASOverride", + "description": "Enable Or Disable state." + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of Network Fabric. Example: 65048.", + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN. Example: 65047.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipv4ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv4 Listen Range prefixes.", + "items": { + "type": "string" + } + }, + "ipv6ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv6 Listen Ranges prefixes.", + "items": { + "type": "string" + } + }, + "ipv4NeighborAddress": { + "type": "array", + "description": "List with stringified IPv4 Neighbor Addresses.", + "items": { + "$ref": "#/definitions/NeighborAddress" + }, + "x-ms-identifiers": [ + "address" + ] + }, + "ipv6NeighborAddress": { + "type": "array", + "description": "List with stringified IPv6 Neighbor Address.", + "items": { + "$ref": "#/definitions/NeighborAddress" + }, + "x-ms-identifiers": [ + "address" + ] + }, + "bmpConfiguration": { + "$ref": "#/definitions/InternalNetworkBmpProperties", + "description": "InternalNetwork BMP Configuration" + }, + "v4OverV6BgpSession": { + "type": "string", + "description": "V4 over V6 bgp session.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "V4OverV6BgpSessionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "V4OverV6BgpSessionState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "V4OverV6BgpSessionState-Disabled" + } + ] + } + }, + "v6OverV4BgpSession": { + "type": "string", + "description": "v6 over v4 bgp session.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "V6OverV4BgpSessionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "V6OverV4BgpSessionState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "V6OverV4BgpSessionState-Disabled" + } + ] + } + } + }, + "required": [ + "peerASN" + ] + }, + "BgpPatchConfiguration": { + "type": "object", + "description": "BGP configuration properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "defaultRouteOriginate": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Originate a defaultRoute. Ex: \"True\" | \"False\"." + }, + "allowAS": { + "type": "integer", + "format": "int32", + "description": "Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2.", + "minimum": 0, + "maximum": 10 + }, + "allowASOverride": { + "$ref": "#/definitions/AllowASOverride", + "description": "Enable Or Disable state." + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of Network Fabric. Example: 65048.", + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN. Example: 65047.", + "minimum": 1, + "maximum": 4294967295 + }, + "ipv4ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv4 Listen Range prefixes.", + "items": { + "type": "string" + } + }, + "ipv6ListenRangePrefixes": { + "type": "array", + "description": "List of BGP IPv6 Listen Ranges prefixes.", + "items": { + "type": "string" + } + }, + "ipv4NeighborAddress": { + "type": "array", + "description": "List with stringified IPv4 Neighbor Addresses.", + "items": { + "$ref": "#/definitions/NeighborAddressPatch" + }, + "x-ms-identifiers": [ + "address" + ] + }, + "ipv6NeighborAddress": { + "type": "array", + "description": "List with stringified IPv6 Neighbor Address.", + "items": { + "$ref": "#/definitions/NeighborAddressPatch" + }, + "x-ms-identifiers": [ + "address" + ] + }, + "bmpConfiguration": { + "$ref": "#/definitions/InternalNetworkBmpPatchProperties", + "description": "InternalNetwork BMP Configuration" + }, + "v4OverV6BgpSession": { + "$ref": "#/definitions/V4OverV6BgpSessionState", + "description": "V4 over V6 bgp session." + }, + "v6OverV4BgpSession": { + "$ref": "#/definitions/V6OverV4BgpSessionState", + "description": "v6 over v4 bgp session." + } + } + }, + "BitRate": { + "type": "object", + "description": "Bit rate in bits per second.", + "properties": { + "rate": { + "type": "integer", + "format": "int64", + "description": "Bitrate." + }, + "unit": { + "$ref": "#/definitions/BitRateUnit", + "description": "Bitrate unit." + } + } + }, + "BitRateUnit": { + "type": "string", + "description": "Bit rate unit.", + "enum": [ + "bps", + "Kbps", + "Mbps", + "Gbps" + ], + "x-ms-enum": { + "name": "BitRateUnit", + "modelAsString": true, + "values": [ + { + "name": "bps", + "value": "bps", + "description": "Bit rate unit in bits per second." + }, + { + "name": "Kbps", + "value": "Kbps", + "description": "Bit rate unit in kilobits per second." + }, + { + "name": "Mbps", + "value": "Mbps", + "description": "Bit rate unit in megabits per second." + }, + { + "name": "Gbps", + "value": "Gbps", + "description": "Bit rate unit in gigabits per second." + } + ] + } + }, + "BmpConfigurationPatchProperties": { + "type": "object", + "description": "BMP Configuration patch properties.", + "properties": { + "stationConfigurationState": { + "$ref": "#/definitions/StationConfigurationState", + "description": "Enabling a station. Either True/False." + }, + "scopeResourceId": { + "type": "string", + "format": "arm-id", + "description": "Scope resource ARM Identifier.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "stationName": { + "type": "string", + "description": "Name of the station." + }, + "stationIp": { + "type": "string", + "description": "IP Address of the station." + }, + "stationPort": { + "type": "integer", + "format": "int32", + "description": "Port of the station. Default value is 5000.", + "minimum": 1, + "maximum": 65535 + }, + "stationConnectionMode": { + "$ref": "#/definitions/StationConnectionMode", + "description": "Station Connection Mode." + }, + "stationConnectionProperties": { + "$ref": "#/definitions/StationConnectionPatchProperties", + "description": "Station Connection Properties." + }, + "stationNetwork": { + "type": "string", + "format": "arm-id", + "description": "Network of the station", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/l3Isolationdomains/internalNetwork" + }, + { + "type": "Microsoft.ManagedNetworkFabric/l3Isolationdomains/externalNetwork" + } + ] + } + }, + "monitoredNetworks": { + "type": "array", + "description": "The List of Network ID's that need to be monitored.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/l3IsolationDomains" + } + ] + } + } + }, + "exportPolicy": { + "$ref": "#/definitions/BmpExportPolicy", + "description": "Export Policy for the BMP Configuration." + }, + "monitoredAddressFamilies": { + "type": "array", + "description": "Monitored Address Families for the BMP Configuration.", + "items": { + "$ref": "#/definitions/BmpMonitoredAddressFamily" + } + } + } + }, + "BmpConfigurationProperties": { + "type": "object", + "description": "BGP Monitoring Protocol (BMP) Configuration properties.", + "properties": { + "stationConfigurationState": { + "$ref": "#/definitions/StationConfigurationState", + "description": "Enabling a station. Either True/False." + }, + "scopeResourceId": { + "type": "string", + "format": "arm-id", + "description": "Scope resource ARM Identifier.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "stationName": { + "type": "string", + "description": "Name of the station." + }, + "stationIp": { + "type": "string", + "description": "IP Address of the station." + }, + "stationPort": { + "type": "integer", + "format": "int32", + "description": "Port of the station. Default value is 5000.", + "default": 5000, + "minimum": 1, + "maximum": 65535 + }, + "stationConnectionMode": { + "$ref": "#/definitions/StationConnectionMode", + "description": "Station Connection Mode." + }, + "stationConnectionProperties": { + "$ref": "#/definitions/StationConnectionProperties", + "description": "Station Connection Properties." + }, + "stationNetwork": { + "type": "string", + "format": "arm-id", + "description": "Network of the station", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/l3Isolationdomains/internalNetwork" + }, + { + "type": "Microsoft.ManagedNetworkFabric/l3Isolationdomains/externalNetwork" + } + ] + } + }, + "monitoredNetworks": { + "type": "array", + "description": "The List of Network ID's that need to be monitored.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/l3IsolationDomains" + } + ] + } + } + }, + "exportPolicy": { + "type": "string", + "description": "Export Policy for the BMP Configuration.", + "default": "All", + "enum": [ + "Pre-Policy", + "Post-Policy", + "All" + ], + "x-ms-enum": { + "name": "BmpExportPolicy", + "modelAsString": true, + "values": [ + { + "name": "PrePolicy", + "value": "Pre-Policy", + "description": "BMP ExportPolicy Pre-Policy" + }, + { + "name": "PostPolicy", + "value": "Post-Policy", + "description": "BMP ExportPolicy Post-Policy" + }, + { + "name": "All", + "value": "All", + "description": "BMP ExportPolicy All" + } + ] + } + }, + "monitoredAddressFamilies": { + "type": "array", + "description": "Monitored Address Families for the BMP Configuration.", + "default": [ + "All" + ], + "items": { + "$ref": "#/definitions/BmpMonitoredAddressFamily" + } + } + } + }, + "BmpConfigurationState": { + "type": "string", + "description": "BGP Monitoring Protocol (BMP) configuration state.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "BmpConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "BGP Monitoring Protocol (BMP) ConfigurationState - Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "BGP Monitoring Protocol (BMP) ConfigurationState - Disabled" + } + ] + } + }, + "BmpExportPolicy": { + "type": "string", + "description": "Export Policy for the BGP Monitoring Protocol (BMP) Configuration.", + "enum": [ + "Pre-Policy", + "Post-Policy", + "All" + ], + "x-ms-enum": { + "name": "BmpExportPolicy", + "modelAsString": true, + "values": [ + { + "name": "PrePolicy", + "value": "Pre-Policy", + "description": "BMP ExportPolicy Pre-Policy" + }, + { + "name": "PostPolicy", + "value": "Post-Policy", + "description": "BMP ExportPolicy Post-Policy" + }, + { + "name": "All", + "value": "All", + "description": "BMP ExportPolicy All" + } + ] + } + }, + "BmpMonitoredAddressFamily": { + "type": "string", + "description": "Monitored Address Family.", + "enum": [ + "ipv4Unicast", + "ipv6Unicast", + "vpnIpv4", + "vpnIpv6", + "All" + ], + "x-ms-enum": { + "name": "BmpMonitoredAddressFamily", + "modelAsString": true, + "values": [ + { + "name": "ipv4Unicast", + "value": "ipv4Unicast", + "description": "IPv4 Unicast" + }, + { + "name": "ipv6Unicast", + "value": "ipv6Unicast", + "description": "IPv6 Unicast" + }, + { + "name": "vpnIpv4", + "value": "vpnIpv4", + "description": "VPN IPv4" + }, + { + "name": "vpnIpv6", + "value": "vpnIpv6", + "description": "VPN IPv6" + }, + { + "name": "All", + "value": "All", + "description": "All Address Families" + } + ] + } + }, + "BooleanEnumProperty": { + "type": "string", + "description": "Boolean union. Example- True/False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "BooleanEnumProperty", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "EnumProperty-True" + }, + { + "name": "False", + "value": "False", + "description": "EnumProperty-False" + } + ] + } + }, + "BurstSize": { + "type": "object", + "description": "Burst size in packets.", + "properties": { + "size": { + "type": "integer", + "format": "int64", + "description": "Burst size." + }, + "unit": { + "$ref": "#/definitions/BurstSizeUnit", + "description": "Burst size unit." + } + } + }, + "BurstSizeUnit": { + "type": "string", + "description": "Burst size unit in packets.", + "enum": [ + "Bytes", + "KBytes", + "MBytes", + "GBytes" + ], + "x-ms-enum": { + "name": "BurstSizeUnit", + "modelAsString": true, + "values": [ + { + "name": "Bytes", + "value": "Bytes", + "description": "Burst size unit in bytes." + }, + { + "name": "KBytes", + "value": "KBytes", + "description": "Burst size unit in kilobytes." + }, + { + "name": "MBytes", + "value": "MBytes", + "description": "Burst size unit in megabytes." + }, + { + "name": "GBytes", + "value": "GBytes", + "description": "Burst size unit in gigabytes." + } + ] + } + }, + "CommitBatchDetails": { + "type": "object", + "description": "Commit Batch Details.", + "properties": { + "failedDevices": { + "type": "array", + "description": "List of devices for which the commit operation failed.", + "items": { + "type": "string" + } + } + } + }, + "CommitBatchState": { + "type": "string", + "description": "Commit Batch State.", + "enum": [ + "Processing", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "CommitBatchState", + "modelAsString": true, + "values": [ + { + "name": "Processing", + "value": "Processing", + "description": "CommitBatchState-PartialSuccess" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "CommitBatchState-Succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "CommitBatchState-Failed" + } + ] + }, + "readOnly": true + }, + "CommitBatchStatusRequest": { + "type": "object", + "description": "Commit Batch Status Request.", + "properties": { + "commitBatchId": { + "type": "string", + "description": "Commit Batch Identifier. If not provided, the latest commit batch status will be returned." + } + } + }, + "CommitBatchStatusResponse": { + "type": "object", + "description": "Commit Batch Status Response.", + "properties": { + "commitBatchId": { + "type": "string", + "description": "Commit Batch Identifier." + }, + "commitBatchState": { + "$ref": "#/definitions/CommitBatchState", + "description": "Commit Batch State." + }, + "commitBatchDetails": { + "$ref": "#/definitions/CommitBatchDetails", + "description": "Commit Batch Details." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "CommonDynamicMatchConfiguration": { + "type": "object", + "description": "Dynamic match configuration object.", + "properties": { + "ipGroups": { + "type": "array", + "description": "List of IP Groups.", + "items": { + "$ref": "#/definitions/IpGroupProperties" + }, + "x-ms-identifiers": [] + }, + "vlanGroups": { + "type": "array", + "description": "List of vlan groups.", + "items": { + "$ref": "#/definitions/VlanGroupProperties" + }, + "x-ms-identifiers": [] + }, + "portGroups": { + "type": "array", + "description": "List of the port groups.", + "items": { + "$ref": "#/definitions/PortGroupProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "CommonDynamicMatchConfigurationPatch": { + "type": "object", + "description": "Dynamic match configuration object.", + "properties": { + "ipGroups": { + "type": "array", + "description": "List of IP Groups.", + "items": { + "$ref": "#/definitions/IpGroupPatchProperties" + }, + "x-ms-identifiers": [] + }, + "vlanGroups": { + "type": "array", + "description": "List of vlan groups.", + "items": { + "$ref": "#/definitions/VlanGroupPatchProperties" + }, + "x-ms-identifiers": [] + }, + "portGroups": { + "type": "array", + "description": "List of the port groups.", + "items": { + "$ref": "#/definitions/PortGroupPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "CommonPostActionResponseForDeviceROCommands": { + "type": "object", + "description": "Common response for device Ro Commands.", + "properties": { + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "outputUrl": { + "type": "string", + "description": "Predefined link containing Device RO Command output." + }, + "deviceConfigurationPreview": { + "type": "string", + "description": "Device RO command Response limited to 4000 characters." + } + } + }, + "CommonPostActionResponseForDeviceROCommandsOperationStatusResult": { + "type": "object", + "description": "The current status of an async operation.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Fully qualified ID for the async operation.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the async operation.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/CommonPostActionResponseForDeviceROCommands", + "description": "The additional properties of the operation status result." + }, + "resourceId": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ID of the resource against which the original async operation was started.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices" + } + ] + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Operation status." + } + }, + "required": [ + "status" + ] + }, + "CommonPostActionResponseForDeviceRWCommands": { + "type": "object", + "description": "Common response for device Rw Commands.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "outputUrl": { + "type": "string", + "description": "Predefined link containing Device Rw Command output." + } + } + }, + "CommonPostActionResponseForDeviceUpdate": { + "type": "object", + "description": "Common response for device updates.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "successfulDevices": { + "type": "array", + "description": "List of ARM Resource IDs for which the given action applied successfully.", + "items": { + "type": "string" + } + }, + "failedDevices": { + "type": "array", + "description": "List of ARM Resource IDs for which the given action failed to apply.", + "items": { + "type": "string" + } + } + } + }, + "CommonPostActionResponseForStateUpdate": { + "type": "object", + "description": "Common response for the state updates.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + } + } + }, + "CommunityActionTypes": { + "type": "string", + "description": "Community action types. Example: Permit | Deny.", + "enum": [ + "Permit", + "Deny" + ], + "x-ms-enum": { + "name": "CommunityActionTypes", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Permit Community Action Types" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny Community Action Types" + } + ] + } + }, + "Condition": { + "type": "string", + "description": "Specify prefix-list bounds.", + "enum": [ + "EqualTo", + "GreaterThanOrEqualTo", + "LesserThanOrEqualTo", + "Range" + ], + "x-ms-enum": { + "name": "Condition", + "modelAsString": true, + "values": [ + { + "name": "EqualTo", + "value": "EqualTo", + "description": "Condition-EqualTo" + }, + { + "name": "GreaterThanOrEqualTo", + "value": "GreaterThanOrEqualTo", + "description": "Condition-GreaterThanOrEqualTo" + }, + { + "name": "LesserThanOrEqualTo", + "value": "LesserThanOrEqualTo", + "description": "Condition-LesserThanOrEqualTo" + }, + { + "name": "Range", + "value": "Range", + "description": "Condition-Range" + } + ] + } + }, + "ConditionalDefaultRouteProperties": { + "type": "object", + "description": "Conditional Default Route Configuration properties.", + "properties": { + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "ConfigurationState": { + "type": "string", + "description": "Configuration state for the resource.", + "enum": [ + "Succeeded", + "Failed", + "Rejected", + "Accepted", + "Provisioned", + "ErrorProvisioning", + "Deprovisioning", + "Deprovisioned", + "ErrorDeprovisioning", + "DeferredControl", + "Provisioning", + "PendingCommit" + ], + "x-ms-enum": { + "name": "ConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Success Configuration State" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Configuration State" + }, + { + "name": "Rejected", + "value": "Rejected", + "description": "Rejected Configuration State" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Accepted Configuration State" + }, + { + "name": "Provisioned", + "value": "Provisioned", + "description": "Provisioned Configuration State" + }, + { + "name": "ErrorProvisioning", + "value": "ErrorProvisioning", + "description": "ErrorProvisioning Configuration State" + }, + { + "name": "Deprovisioning", + "value": "Deprovisioning", + "description": "Deprovisioning Configuration State" + }, + { + "name": "Deprovisioned", + "value": "Deprovisioned", + "description": "Deprovisioned Configuration State" + }, + { + "name": "ErrorDeprovisioning", + "value": "ErrorDeprovisioning", + "description": "ErrorDeprovisioning Configuration State" + }, + { + "name": "DeferredControl", + "value": "DeferredControl", + "description": "DeferredControl Configuration State" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Provisioning Configuration State" + }, + { + "name": "PendingCommit", + "value": "PendingCommit", + "description": "PendingCommit Configuration State" + } + ] + }, + "readOnly": true + }, + "ConfigurationType": { + "type": "string", + "description": "Input method to configure Access Control List.", + "enum": [ + "File", + "Inline" + ], + "x-ms-enum": { + "name": "ConfigurationType", + "modelAsString": true, + "values": [ + { + "name": "File", + "value": "File", + "description": "File Configuration Type" + }, + { + "name": "Inline", + "value": "Inline", + "description": "Inline Configuration Type" + } + ] + } + }, + "ConnectedSubnet": { + "type": "object", + "description": "Connected Subnet properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "prefix": { + "type": "string", + "description": "Prefix of the Connected Subnet.", + "minLength": 1 + } + }, + "required": [ + "prefix" + ] + }, + "ConnectedSubnetPatch": { + "type": "object", + "description": "Connected Subnet properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "prefix": { + "type": "string", + "description": "Prefix of the Connected Subnet.", + "minLength": 1 + } + }, + "required": [ + "prefix" + ] + }, + "ConnectedSubnetRoutePolicy": { + "type": "object", + "description": "Connected Subnet Route Policy properties.", + "properties": { + "exportRoutePolicy": { + "$ref": "#/definitions/L3ExportRoutePolicy", + "description": "Array of ARM Resource ID of the RoutePolicies." + } + } + }, + "ConnectedSubnetRoutePolicyPatch": { + "type": "object", + "description": "Connected Subnet Route Policy properties.", + "properties": { + "exportRoutePolicy": { + "$ref": "#/definitions/L3ExportRoutePolicyPatch", + "description": "Array of ARM Resource ID of the RoutePolicies." + } + } + }, + "ControllerServices": { + "type": "object", + "description": "Network Fabric Controller services.", + "properties": { + "ipv4AddressSpaces": { + "type": "array", + "description": "The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute.", + "items": { + "type": "string" + } + }, + "ipv6AddressSpaces": { + "type": "array", + "description": "The IPv6 is not supported right now.", + "items": { + "type": "string" + } + } + } + }, + "DestinationPatchProperties": { + "type": "object", + "description": "The network tap destination properties.", + "properties": { + "name": { + "type": "string", + "description": "Destination name.", + "minLength": 1 + }, + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Type of destination. Input can be IsolationDomain or Direct." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "The destination Id. ARM Resource ID of either NNI or Internal Networks.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkToNetworkInterconnects" + }, + { + "type": "Microsoft.ManagedNetworkFabric/l3IsolationDomains/internalNetworks" + } + ] + } + }, + "isolationDomainProperties": { + "$ref": "#/definitions/IsolationDomainPatchProperties", + "description": "Isolation Domain Properties." + }, + "destinationTapRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of destination Tap Rule that contains match configurations.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + } + } + }, + "DestinationProperties": { + "type": "object", + "description": "The network tap destination properties.", + "properties": { + "name": { + "type": "string", + "description": "Destination name.", + "minLength": 1 + }, + "destinationType": { + "$ref": "#/definitions/DestinationType", + "description": "Type of destination. Input can be IsolationDomain or Direct." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "The destination Id. ARM Resource ID of either NNI or Internal Networks.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkToNetworkInterconnects" + }, + { + "type": "Microsoft.ManagedNetworkFabric/l3IsolationDomains/internalNetworks" + } + ] + } + }, + "isolationDomainProperties": { + "$ref": "#/definitions/IsolationDomainProperties", + "description": "Isolation Domain Properties." + }, + "destinationTapRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of destination Tap Rule that contains match configurations.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + } + }, + "required": [ + "name", + "destinationType", + "destinationId" + ] + }, + "DestinationType": { + "type": "string", + "description": "Type of destination. Input can be IsolationDomain or Direct.", + "enum": [ + "IsolationDomain", + "Direct" + ], + "x-ms-enum": { + "name": "DestinationType", + "modelAsString": true, + "values": [ + { + "name": "IsolationDomain", + "value": "IsolationDomain", + "description": "DestinationType-IsolationDomain" + }, + { + "name": "Direct", + "value": "Direct", + "description": "DestinationType-Direct" + } + ] + } + }, + "DeviceAdministrativeState": { + "type": "string", + "description": "Administrative state.", + "enum": [ + "RMA", + "UngracefulRMA", + "Resync", + "GracefulQuarantine", + "UngracefulQuarantine", + "Quarantine", + "UnderMaintenance", + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "DeviceAdministrativeState", + "modelAsString": true, + "values": [ + { + "name": "RMA", + "value": "RMA", + "description": "Device AdministrativeState-RMA" + }, + { + "name": "UngracefulRMA", + "value": "UngracefulRMA", + "description": "Device AdministrativeState-RMA(Return Material Authorization) Ungraceful" + }, + { + "name": "Resync", + "value": "Resync", + "description": "Device AdministrativeState-Resync" + }, + { + "name": "GracefulQuarantine", + "value": "GracefulQuarantine", + "description": "Device AdministrativeState-GracefulQuarantine" + }, + { + "name": "UngracefulQuarantine", + "value": "UngracefulQuarantine", + "description": "Device AdministrativeState-UngracefulQuarantine" + }, + { + "name": "Quarantine", + "value": "Quarantine", + "description": "Device AdministrativeState-Quarantine" + }, + { + "name": "UnderMaintenance", + "value": "UnderMaintenance", + "description": "Device AdministrativeState-UnderMaintenance" + }, + { + "name": "Enable", + "value": "Enable", + "description": "Device AdministrativeState-Enable" + }, + { + "name": "Disable", + "value": "Disable", + "description": "Device AdministrativeState-Disable" + } + ] + } + }, + "DeviceInterfaceProperties": { + "type": "object", + "description": "Network device interface properties.", + "properties": { + "identifier": { + "type": "string", + "description": "Interface identifier. Example: HundredGigE0/0." + }, + "interfaceType": { + "type": "string", + "description": "Interface type." + }, + "supportedConnectorTypes": { + "type": "array", + "description": "List of supported connector types.", + "items": { + "$ref": "#/definitions/SupportedConnectorProperties" + }, + "x-ms-identifiers": [ + "connectorType" + ] + } + } + }, + "DeviceRoCommand": { + "type": "object", + "description": "Provide the RO command", + "properties": { + "command": { + "type": "string", + "description": "Specify the command." + } + } + }, + "DeviceRole": { + "type": "string", + "description": "Device Role", + "enum": [ + "CE", + "ToR", + "NPB", + "ManagementSwitch" + ], + "x-ms-enum": { + "name": "DeviceRole", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "DeviceRole - Customer Edge (CE)" + }, + { + "name": "ToR", + "value": "ToR", + "description": "DeviceRole - Top of Rack (ToR)" + }, + { + "name": "NPB", + "value": "NPB", + "description": "DeviceRole - Network Packet Broker (NPB)" + }, + { + "name": "ManagementSwitch", + "value": "ManagementSwitch", + "description": "Device Role Management Switch" + } + ] + } + }, + "DeviceRwCommand": { + "type": "object", + "description": "Provide the Rw command", + "properties": { + "command": { + "type": "string", + "description": "Specify the command." + } + } + }, + "DiscardCommitBatchRequest": { + "type": "object", + "description": "Discard Commit Batch Request.", + "properties": { + "commitBatchId": { + "type": "string", + "description": "Commit Batch Identifier. If not provided, the latest commit batch status will be returned." + } + } + }, + "DiscardCommitBatchResponse": { + "type": "object", + "description": "Discard Commit Batch Response.", + "properties": { + "commitBatchId": { + "type": "string", + "description": "Commit Batch Identifier." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "EnableDisableState": { + "type": "string", + "description": "Administrative state.", + "enum": [ + "Enable", + "Disable", + "UnderMaintenance" + ], + "x-ms-enum": { + "name": "EnableDisableState", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "AdministrativeState Enable" + }, + { + "name": "Disable", + "value": "Disable", + "description": "AdministrativeState Disable" + }, + { + "name": "UnderMaintenance", + "value": "UnderMaintenance", + "description": "AdministrativeState UnderMaintenance" + } + ] + } + }, + "Encapsulation": { + "type": "string", + "description": "Type of encapsulation.", + "enum": [ + "None", + "GRE" + ], + "x-ms-enum": { + "name": "Encapsulation", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Encapsulation-None" + }, + { + "name": "GRE", + "value": "GRE", + "description": "Encapsulation-GRE" + } + ] + } + }, + "EncapsulationType": { + "type": "string", + "description": "Encapsulation Type that needs to be matched.", + "enum": [ + "None", + "GTPv1" + ], + "x-ms-enum": { + "name": "EncapsulationType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None EncapsulationType" + }, + { + "name": "GTPv1", + "value": "GTPv1", + "description": "GTPv1 EncapsulationType" + } + ] + } + }, + "ExportRoutePolicy": { + "type": "object", + "description": "Export Route Policy either IPv4 or IPv6.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExportRoutePolicyInformation": { + "type": "object", + "description": "Export Route Policy Configuration.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExportRoutePolicyInformationPatch": { + "type": "object", + "description": "Export Route Policy Configuration.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Export IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExportRoutePolicyPatch": { + "type": "object", + "description": "Export Route Policy either IPv4 or IPv6.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ExpressRouteConnectionInformation": { + "type": "object", + "description": "The ExpressRoute circuit ID and the Auth Key are required for you to successfully deploy NFC service.", + "properties": { + "expressRouteCircuitId": { + "type": "string", + "format": "arm-id", + "description": "The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/expressRouteCircuits" + } + ] + } + }, + "expressRouteAuthorizationKey": { + "type": "string", + "format": "password", + "description": "Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute.", + "x-ms-secret": true + } + }, + "required": [ + "expressRouteCircuitId", + "expressRouteAuthorizationKey" + ] + }, + "ExtendedVlan": { + "type": "string", + "description": "Extended VLAN status.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExtendedVlan", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Extended VLAN is enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Extended VLAN is disabled." + } + ] + } + }, + "ExternalNetwork": { + "type": "object", + "description": "Defines the External Network resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ExternalNetworkProperties", + "description": "External Network Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ExternalNetworkBfdAdministrativeStateRequest": { + "type": "object", + "description": "External Network Administrative State request", + "properties": { + "routeType": { + "$ref": "#/definitions/ExternalNetworkRouteType", + "description": "Route Type that helps to know which bfd we are updating." + }, + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "Administrative state." + } + } + }, + "ExternalNetworkBfdAdministrativeStateResponse": { + "type": "object", + "description": "External Network Administrative State response", + "properties": { + "routeType": { + "$ref": "#/definitions/ExternalNetworkRouteType", + "description": "Route Type that helps to know which bfd we are updating." + }, + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "Administrative state." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "ExternalNetworkBmpPatchProperties": { + "type": "object", + "description": "BMP Monitoring Configuration patch properties.", + "properties": { + "configurationState": { + "$ref": "#/definitions/BmpConfigurationState", + "description": "BMP Configuration State." + } + } + }, + "ExternalNetworkBmpProperties": { + "type": "object", + "description": "BGP Monitoring Protocol (BMP) Configuration properties.", + "properties": { + "configurationState": { + "type": "string", + "description": "BMP Configuration State.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "BmpConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "BGP Monitoring Protocol (BMP) ConfigurationState - Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "BGP Monitoring Protocol (BMP) ConfigurationState - Disabled" + } + ] + } + } + } + }, + "ExternalNetworkListResult": { + "type": "object", + "description": "The response of a ExternalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ExternalNetwork items on this page", + "items": { + "$ref": "#/definitions/ExternalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ExternalNetworkPatch": { + "type": "object", + "description": "The ExternalNetwork patch resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/ExternalNetworkPatchProperties", + "description": "External Network Patch properties." + } + } + }, + "ExternalNetworkPatchProperties": { + "type": "object", + "description": "External Network Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicyPatch", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicyPatch", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/L3OptionBPatchProperties", + "description": "option B properties object" + }, + "optionAProperties": { + "$ref": "#/definitions/ExternalNetworkPatchPropertiesOptionAProperties", + "description": "option A properties object" + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/ExternalNetworkStaticRoutePatchConfiguration", + "description": "Static Route Configuration." + } + } + }, + "ExternalNetworkPatchPropertiesOptionAProperties": { + "type": "object", + "description": "option A properties object", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan identifier. Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "Fabric ASN number. Example 65001", + "minimum": 1, + "maximum": 4294967295, + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "bmpConfiguration": { + "$ref": "#/definitions/ExternalNetworkBmpPatchProperties", + "description": "BMP Monitor Configuration." + }, + "v4OverV6BgpSession": { + "$ref": "#/definitions/V4OverV6BgpSessionState", + "description": "V4OverV6 BGP Session state" + }, + "v6OverV4BgpSession": { + "$ref": "#/definitions/V6OverV4BgpSessionState", + "description": "V6OverV4 BGP Session state" + }, + "nativeIpv4PrefixLimit": { + "$ref": "#/definitions/NativeIpv4PrefixLimitPatchProperties", + "description": "Native IPv4 prefix limit configuration" + }, + "nativeIpv6PrefixLimit": { + "$ref": "#/definitions/NativeIpv6PrefixLimitPatchProperties", + "description": "Native IPv6 prefix limit configuration" + } + } + }, + "ExternalNetworkProperties": { + "type": "object", + "description": "External Network Properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicy", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicy", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/L3OptionBProperties", + "description": "option B properties object" + }, + "optionAProperties": { + "$ref": "#/definitions/ExternalNetworkPropertiesOptionAProperties", + "description": "option A properties object" + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/ExternalNetworkStaticRouteConfiguration", + "description": "Static Route Configuration." + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "peeringOption" + ] + }, + "ExternalNetworkPropertiesOptionAProperties": { + "type": "object", + "description": "option A properties object", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan identifier. Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "Fabric ASN number. Example 65001", + "minimum": 1, + "maximum": 4294967295, + "readOnly": true + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "bmpConfiguration": { + "$ref": "#/definitions/ExternalNetworkBmpProperties", + "description": "BMP Monitor Configuration." + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "v4OverV6BgpSession": { + "type": "string", + "description": "V4OverV6 BGP Session state", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "V4OverV6BgpSessionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "V4OverV6BgpSessionState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "V4OverV6BgpSessionState-Disabled" + } + ] + } + }, + "v6OverV4BgpSession": { + "type": "string", + "description": "V6OverV4 BGP Session state", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "V6OverV4BgpSessionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "V6OverV4BgpSessionState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "V6OverV4BgpSessionState-Disabled" + } + ] + } + }, + "nativeIpv4PrefixLimit": { + "$ref": "#/definitions/NativeIpv4PrefixLimitProperties", + "description": "Native IPv4 prefix limits configuration" + }, + "nativeIpv6PrefixLimit": { + "$ref": "#/definitions/NativeIpv6PrefixLimitProperties", + "description": "Native IPv6 prefix limits configuration" + } + }, + "required": [ + "vlanId", + "peerASN" + ] + }, + "ExternalNetworkRouteType": { + "type": "string", + "description": "External Network RouteType.", + "enum": [ + "Static", + "OptionA" + ], + "x-ms-enum": { + "name": "ExternalNetworkRouteType", + "modelAsString": true, + "values": [ + { + "name": "Static", + "value": "Static", + "description": "ExternalNetwork Static." + }, + { + "name": "OptionA", + "value": "OptionA", + "description": "ExternalNetwork OptionA." + } + ] + } + }, + "ExternalNetworkStaticRouteConfiguration": { + "type": "object", + "description": "Static Route Configuration properties for ExternalNetwork.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "ExternalNetworkStaticRoutePatchConfiguration": { + "type": "object", + "description": "Static Route Configuration properties for External Network.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "FabricLockProperties": { + "type": "object", + "description": "Network Fabric Lock Configuration.", + "properties": { + "lockState": { + "$ref": "#/definitions/LockConfigurationState", + "description": "NetworkFabric Lock State." + }, + "lockType": { + "$ref": "#/definitions/NetworkFabricLockType", + "description": "NetworkFabric Lock Type." + } + } + }, + "FabricSkuType": { + "type": "string", + "description": "Type of Network Fabric SKU.", + "enum": [ + "SingleRack", + "MultiRack" + ], + "x-ms-enum": { + "name": "FabricSkuType", + "modelAsString": true, + "values": [ + { + "name": "SingleRack", + "value": "SingleRack", + "description": "FabricSkuType-SingleRack" + }, + { + "name": "MultiRack", + "value": "MultiRack", + "description": "FabricSkuType-MultiRack" + } + ] + } + }, + "FeatureFlagProperties": { + "type": "object", + "description": "Feature flag properties.", + "properties": { + "featureFlagName": { + "type": "string", + "description": "Feature flag name." + }, + "featureFlagValue": { + "type": "string", + "description": "Feature flag value." + } + } + }, + "GatewayType": { + "type": "string", + "description": "Gateway Type of the resource.", + "enum": [ + "Infrastructure", + "Workload" + ], + "x-ms-enum": { + "name": "GatewayType", + "modelAsString": true, + "values": [ + { + "name": "Infrastructure", + "value": "Infrastructure", + "description": "GatewayType Infrastructure" + }, + { + "name": "Workload", + "value": "Workload", + "description": "GatewayType Workload" + } + ] + } + }, + "GlobalAccessControlListActionPatchProperties": { + "type": "object", + "description": "Global Access Control List actions patch properties", + "properties": { + "enableCount": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Configuration to enable or disable ACL action count." + } + } + }, + "GlobalAccessControlListActionProperties": { + "type": "object", + "description": "Global Access Control List actions properties", + "properties": { + "enableCount": { + "type": "string", + "description": "Configuration to enable or disable ACL action count.", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "BooleanEnumProperty", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "EnumProperty-True" + }, + { + "name": "False", + "value": "False", + "description": "EnumProperty-False" + } + ] + } + } + } + }, + "GlobalNetworkTapRuleActionPatchProperties": { + "type": "object", + "description": "Global network tap rule actions patch properties", + "properties": { + "enableCount": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Configuration to enable network tap rule counter." + }, + "truncate": { + "type": "string", + "description": "Truncate. 0 indicates do not truncate.", + "minLength": 1 + } + } + }, + "GlobalNetworkTapRuleActionProperties": { + "type": "object", + "description": "Global network tap rule actions properties", + "properties": { + "enableCount": { + "type": "string", + "description": "Configuration to enable network tap rule counter.", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "BooleanEnumProperty", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "EnumProperty-True" + }, + { + "name": "False", + "value": "False", + "description": "EnumProperty-False" + } + ] + } + }, + "truncate": { + "type": "string", + "description": "Truncate. 0 indicates do not truncate.", + "minLength": 1 + } + } + }, + "HeaderAddressProperties": { + "type": "object", + "description": "Header name and source addresses associated with the header.", + "properties": { + "headerName": { + "type": "string", + "description": "Name of the header." + }, + "addressList": { + "type": "array", + "description": "List of source remote IP to be allowed or denied.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IPAddressType": { + "type": "string", + "description": "IP Address type.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 IP address" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 IP address" + } + ] + } + }, + "IcmpConfigurationPatchProperties": { + "type": "object", + "description": "Internet Control Message Protocol (ICMP) configuration patch properties", + "properties": { + "icmpTypes": { + "type": "array", + "description": "Internet Control Message Protocol (ICMP) types", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IcmpConfigurationProperties": { + "type": "object", + "description": "Internet Control Message Protocol (ICMP) configuration", + "properties": { + "icmpTypes": { + "type": "array", + "description": "Internet Control Message Protocol (ICMP) types", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IdentitySelector": { + "type": "object", + "description": "IdentitySelector represents the selection of a managed identity for use.", + "properties": { + "identityType": { + "$ref": "#/definitions/ManagedServiceIdentitySelectorType", + "description": "The type of managed identity that is being selected." + }, + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "identityType" + ] + }, + "IdentitySelectorPatch": { + "type": "object", + "description": "IdentitySelector represents the selection of a managed identity for use.", + "properties": { + "identityType": { + "$ref": "#/definitions/ManagedServiceIdentitySelectorType", + "description": "The type of managed identity that is being selected." + }, + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + } + }, + "ImportRoutePolicy": { + "type": "object", + "description": "Import Route Policy either IPv4 or IPv6.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ImportRoutePolicyInformation": { + "type": "object", + "description": "Import Route Policy Configuration.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ImportRoutePolicyInformationPatch": { + "type": "object", + "description": "Import Route Policy Configuration.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv4 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "Import IPv6 Route Policy Id.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "ImportRoutePolicyPatch": { + "type": "object", + "description": "Import Route Policy either IPv4 or IPv6.", + "properties": { + "importIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "importIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "InterfaceType": { + "type": "string", + "description": "The Interface Type. Example: Management/Data", + "enum": [ + "Management", + "Data" + ], + "x-ms-enum": { + "name": "InterfaceType", + "modelAsString": true, + "values": [ + { + "name": "Management", + "value": "Management", + "description": "InterfaceType-Management" + }, + { + "name": "Data", + "value": "Data", + "description": "InterfaceType-Data" + } + ] + } + }, + "InternalNetwork": { + "type": "object", + "description": "Defines the Internal Network resource.", + "properties": { + "properties": { + "$ref": "#/definitions/InternalNetworkProperties", + "description": "The Internal Network Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "InternalNetworkBfdAdministrativeStateRequest": { + "type": "object", + "description": "Internal Network BFD Administrative State request", + "properties": { + "routeType": { + "$ref": "#/definitions/InternalNetworkRouteType", + "description": "Route Type that helps to know which bfd we are updating." + }, + "neighborAddress": { + "type": "string", + "description": "NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address." + }, + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "BFD Administrative state." + } + } + }, + "InternalNetworkBfdAdministrativeStateResponse": { + "type": "object", + "description": "Internal Network BFD Administrative State response", + "properties": { + "neighborAddressAdministrativeStatus": { + "type": "array", + "description": "NeighborAddress administrative status", + "minItems": 1, + "items": { + "$ref": "#/definitions/NeighborAddressBfdAdministrativeStatus" + }, + "x-ms-identifiers": [] + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "InternalNetworkBgpAdministrativeStateRequest": { + "type": "object", + "description": "Internal Network Administrative State Request", + "properties": { + "neighborAddress": { + "type": "string", + "description": "NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address." + }, + "administrativeState": { + "$ref": "#/definitions/BgpAdministrativeState", + "description": "BGP Administrative state." + } + } + }, + "InternalNetworkBgpAdministrativeStateResponse": { + "type": "object", + "description": "Internal Network Administrative State Response", + "properties": { + "neighborAddressAdministrativeStatus": { + "type": "array", + "description": "NeighborAddress administrative status", + "minItems": 1, + "items": { + "$ref": "#/definitions/NeighborAddressBgpAdministrativeStatus" + }, + "x-ms-identifiers": [] + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "InternalNetworkBmpPatchProperties": { + "type": "object", + "description": "Internal Network BMP Configuration", + "properties": { + "neighborIpExclusions": { + "type": "array", + "description": "BMP Collector Address.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "bmpConfigurationState": { + "$ref": "#/definitions/BmpConfigurationState", + "description": "BMP Monitoring configuration state." + } + } + }, + "InternalNetworkBmpProperties": { + "type": "object", + "description": "Internal Network BMP Configuration", + "properties": { + "neighborIpExclusions": { + "type": "array", + "description": "BMP Collector Address.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "bmpConfigurationState": { + "$ref": "#/definitions/BmpConfigurationState", + "description": "BMP Monitoring configuration state." + } + } + }, + "InternalNetworkListResult": { + "type": "object", + "description": "The response of a InternalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InternalNetwork items on this page", + "items": { + "$ref": "#/definitions/InternalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "InternalNetworkPatch": { + "type": "object", + "description": "The InternalNetwork patch resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/InternalNetworkPatchProperties", + "description": "InternalNetwork Patch properties." + } + } + }, + "InternalNetworkPatchProperties": { + "type": "object", + "description": "InternalNetwork Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "minimum": 64, + "maximum": 9200 + }, + "connectedIPv4Subnets": { + "type": "array", + "description": "List of Connected IPv4 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnetPatch" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "connectedIPv6Subnets": { + "type": "array", + "description": "List of connected IPv6 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnetPatch" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicy", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicy", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "isMonitoringEnabled": { + "$ref": "#/definitions/IsMonitoringEnabled", + "description": "To check whether monitoring of internal network is enabled or not." + }, + "bgpConfiguration": { + "$ref": "#/definitions/BgpPatchConfiguration", + "description": "BGP configuration properties." + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/StaticRoutePatchConfiguration", + "description": "Static Route Configuration properties." + }, + "nativeIpv4PrefixLimit": { + "$ref": "#/definitions/NativeIpv4PrefixLimitPatchProperties", + "description": "Native IPv4 Prefix Limit Configuration properties." + }, + "nativeIpv6PrefixLimit": { + "$ref": "#/definitions/NativeIpv6PrefixLimitPatchProperties", + "description": "Native IPv6 Prefix Limit Configuration properties." + } + } + }, + "InternalNetworkProperties": { + "type": "object", + "description": "Internal Network Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "connectedIPv4Subnets": { + "type": "array", + "description": "List of Connected IPv4 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnet" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "connectedIPv6Subnets": { + "type": "array", + "description": "List of connected IPv6 Subnets.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ConnectedSubnet" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicy", + "description": "Import Route Policy either IPv4 or IPv6." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicy", + "description": "Export Route Policy either IPv4 or IPv6." + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "isMonitoringEnabled": { + "type": "string", + "description": "To check whether monitoring of internal network is enabled or not.", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsMonitoringEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsMonitoringEnabled-True" + }, + { + "name": "False", + "value": "False", + "description": "IsMonitoringEnabled-False" + } + ] + } + }, + "extension": { + "type": "string", + "description": "Extension. Example: NoExtension | NPB.", + "default": "NoExtension", + "enum": [ + "NoExtension", + "NPB" + ], + "x-ms-enum": { + "name": "Extension", + "modelAsString": true, + "values": [ + { + "name": "NoExtension", + "value": "NoExtension", + "description": "Extension-NoExtension" + }, + { + "name": "NPB", + "value": "NPB", + "description": "Extension-NPB" + } + ] + } + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan identifier. Example: 1001.", + "minimum": 100, + "maximum": 4094 + }, + "bgpConfiguration": { + "$ref": "#/definitions/BgpConfiguration", + "description": "BGP configuration properties." + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/StaticRouteConfiguration", + "description": "Static Route Configuration properties." + }, + "nativeIpv4PrefixLimit": { + "$ref": "#/definitions/NativeIpv4PrefixLimitProperties", + "description": "Native IPv4 Prefix Limit Configuration properties." + }, + "nativeIpv6PrefixLimit": { + "$ref": "#/definitions/NativeIpv6PrefixLimitProperties", + "description": "Native IPv6 Prefix Limit Configuration properties." + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "vlanId" + ] + }, + "InternalNetworkRouteType": { + "type": "string", + "description": "Internal Network RouteType.", + "enum": [ + "Static", + "Bgp" + ], + "x-ms-enum": { + "name": "InternalNetworkRouteType", + "modelAsString": true, + "values": [ + { + "name": "Static", + "value": "Static", + "description": "InternalNetwork Static." + }, + { + "name": "Bgp", + "value": "Bgp", + "description": "InternalNetwork Bgp." + } + ] + } + }, + "InternetGateway": { + "type": "object", + "description": "The Internet Gateway resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/InternetGatewayProperties", + "description": "The Internet Gateway Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InternetGatewayListResult": { + "type": "object", + "description": "The response of a InternetGateway list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InternetGateway items on this page", + "items": { + "$ref": "#/definitions/InternetGateway" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "InternetGatewayPatch": { + "type": "object", + "description": "The Internet Gateway patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/InternetGatewayPatchProperties", + "description": "Resource properties." + } + } + }, + "InternetGatewayPatchProperties": { + "type": "object", + "description": "PatchProperties for InternetGateway ", + "properties": { + "internetGatewayRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Internet Gateway Rule.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/internetGatewayRules" + } + ] + } + } + } + }, + "InternetGatewayProperties": { + "type": "object", + "description": "Internet Gateway Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "internetGatewayRuleId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Internet Gateway Rule.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/internetGatewayRules" + } + ] + } + }, + "ipv4Address": { + "type": "string", + "description": "IPv4 Address of Internet Gateway.", + "readOnly": true + }, + "port": { + "type": "integer", + "format": "int32", + "description": "Port number of Internet Gateway.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/GatewayType", + "description": "Gateway Type of the resource." + }, + "internetGatewayType": { + "$ref": "#/definitions/GatewayType", + "description": "Gateway Type of the resource." + }, + "networkFabricControllerId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric Controller.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabricControllers" + } + ] + } + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricControllerId" + ] + }, + "InternetGatewayRule": { + "type": "object", + "description": "The Internet Gateway Rule resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/InternetGatewayRuleProperties", + "description": "The Internet Gateway Rule properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InternetGatewayRuleListResult": { + "type": "object", + "description": "The response of a InternetGatewayRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InternetGatewayRule items on this page", + "items": { + "$ref": "#/definitions/InternetGatewayRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "InternetGatewayRulePatch": { + "type": "object", + "description": "The Internet Gateway Rules patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "InternetGatewayRuleProperties": { + "type": "object", + "description": "Internet Gateway Rule Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ruleProperties": { + "$ref": "#/definitions/RuleProperties", + "description": "Rules for the InternetGateways" + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "internetGatewayIds": { + "type": "array", + "description": "List of Internet Gateway resource Id.", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "required": [ + "ruleProperties" + ] + }, + "IpCommunity": { + "type": "object", + "description": "The IP Community resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/IpCommunityProperties", + "description": "The IP Community Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IpCommunityIdList": { + "type": "object", + "description": "IP Community ID list properties.", + "properties": { + "ipCommunityIds": { + "type": "array", + "description": "List of IP Community resource IDs.", + "items": { + "type": "string" + } + } + } + }, + "IpCommunityListResult": { + "type": "object", + "description": "The response of a IpCommunity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IpCommunity items on this page", + "items": { + "$ref": "#/definitions/IpCommunity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IpCommunityPatch": { + "type": "object", + "description": "The IP Community patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/IpCommunityPatchableProperties", + "description": "IP Community patchable properties." + } + } + }, + "IpCommunityPatchableProperties": { + "type": "object", + "description": "IP Community patchable properties.", + "properties": { + "ipCommunityRules": { + "type": "array", + "description": "List of IP Community Rules.", + "items": { + "$ref": "#/definitions/IpCommunityRule" + }, + "x-ms-identifiers": [] + } + } + }, + "IpCommunityProperties": { + "type": "object", + "description": "IP Community Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "ipCommunityRules": { + "type": "array", + "description": "List of IP Community Rules.", + "items": { + "$ref": "#/definitions/IpCommunityRule" + }, + "x-ms-identifiers": [] + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "ipCommunityRules" + ] + }, + "IpCommunityRule": { + "type": "object", + "description": "IP Community patchable properties.", + "properties": { + "action": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Action to be taken on the configuration. Example: Permit | Deny." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.", + "minimum": 1, + "maximum": 4294967295 + }, + "wellKnownCommunities": { + "type": "array", + "description": "Supported well known Community List.", + "items": { + "$ref": "#/definitions/WellKnownCommunities" + } + }, + "communityMembers": { + "type": "array", + "description": "List the community members of IP Community.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "action", + "sequenceNumber", + "communityMembers" + ] + }, + "IpExtendedCommunity": { + "type": "object", + "description": "The IP Extended Community resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/IpExtendedCommunityProperties", + "description": "The IpExtendedCommunity properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IpExtendedCommunityIdList": { + "type": "object", + "description": "IP Extended Community Id list properties.", + "properties": { + "ipExtendedCommunityIds": { + "type": "array", + "description": "List of IP Extended Community resource IDs.", + "items": { + "type": "string" + } + } + } + }, + "IpExtendedCommunityListResult": { + "type": "object", + "description": "The response of a IpExtendedCommunity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IpExtendedCommunity items on this page", + "items": { + "$ref": "#/definitions/IpExtendedCommunity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IpExtendedCommunityPatch": { + "type": "object", + "description": "The IP Extended Communities patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/IpExtendedCommunityPatchProperties", + "description": "IP Extended Community patchable properties." + } + } + }, + "IpExtendedCommunityPatchProperties": { + "type": "object", + "description": "IP Extended Community patchable properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipExtendedCommunityRules": { + "type": "array", + "description": "List of IP Extended Community Rules.", + "items": { + "$ref": "#/definitions/IpExtendedCommunityRule" + }, + "x-ms-identifiers": [] + } + } + }, + "IpExtendedCommunityProperties": { + "type": "object", + "description": "IP Extended Community Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "ipExtendedCommunityRules": { + "type": "array", + "description": "List of IP Extended Community Rules.", + "items": { + "$ref": "#/definitions/IpExtendedCommunityRule" + }, + "x-ms-identifiers": [] + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "ipExtendedCommunityRules" + ] + }, + "IpExtendedCommunityRule": { + "type": "object", + "description": "List of IP Extended Community Rules.", + "properties": { + "action": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Action to be taken on the configuration. Example: Permit | Deny." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.", + "minimum": 1, + "maximum": 4294967295 + }, + "routeTargets": { + "type": "array", + "description": "Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "action", + "sequenceNumber", + "routeTargets" + ] + }, + "IpGroupPatchProperties": { + "type": "object", + "description": "IP Group properties.", + "properties": { + "name": { + "type": "string", + "description": "IP Group name.", + "minLength": 1 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "IP Address type." + }, + "ipPrefixes": { + "type": "array", + "description": "List of IP Prefixes.", + "items": { + "type": "string" + } + } + } + }, + "IpGroupProperties": { + "type": "object", + "description": "IP Group properties.", + "properties": { + "name": { + "type": "string", + "description": "IP Group name.", + "minLength": 1 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "IP Address type." + }, + "ipPrefixes": { + "type": "array", + "description": "List of IP Prefixes.", + "items": { + "type": "string" + } + } + } + }, + "IpMatchCondition": { + "type": "object", + "description": "Defines the condition that can be filtered using the selected IPs.", + "properties": { + "type": { + "$ref": "#/definitions/SourceDestinationType", + "description": "IP Address type that needs to be matched." + }, + "prefixType": { + "$ref": "#/definitions/PrefixType", + "description": "IP Prefix Type that needs to be matched." + }, + "ipPrefixValues": { + "type": "array", + "description": "The list of IP Prefixes that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipGroupNames": { + "type": "array", + "description": "The List of IP Group Names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IpMatchConditionPatch": { + "type": "object", + "description": "Defines the condition that can be filtered using the selected IPs.", + "properties": { + "type": { + "$ref": "#/definitions/SourceDestinationType", + "description": "IP Address type that needs to be matched." + }, + "prefixType": { + "$ref": "#/definitions/PrefixType", + "description": "IP Prefix Type that needs to be matched." + }, + "ipPrefixValues": { + "type": "array", + "description": "The list of IP Prefixes that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "ipGroupNames": { + "type": "array", + "description": "The List of IP Group Names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "IpPrefix": { + "type": "object", + "description": "The IP Prefix resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/IpPrefixProperties", + "description": "The IP Prefix properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IpPrefixListResult": { + "type": "object", + "description": "The response of a IpPrefix list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IpPrefix items on this page", + "items": { + "$ref": "#/definitions/IpPrefix" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IpPrefixPatch": { + "type": "object", + "description": "The IP Prefix patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/IpPrefixPatchProperties", + "description": "IP Prefix patchable properties." + } + } + }, + "IpPrefixPatchProperties": { + "type": "object", + "description": "IP Prefix patchable properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "ipPrefixRules": { + "type": "array", + "description": "The list of IP Prefix Rules.", + "items": { + "$ref": "#/definitions/IpPrefixRule" + }, + "x-ms-identifiers": [] + } + } + }, + "IpPrefixProperties": { + "type": "object", + "description": "IP Prefix Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "ipPrefixRules": { + "type": "array", + "description": "The list of IP Prefix Rules.", + "items": { + "$ref": "#/definitions/IpPrefixRule" + }, + "x-ms-identifiers": [] + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "ipPrefixRules" + ] + }, + "IpPrefixRule": { + "type": "object", + "description": "IP Prefix Rule properties.", + "properties": { + "action": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Action to be taken on the configuration. Example: Permit | Deny." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored.", + "minimum": 1, + "maximum": 4294967295 + }, + "networkPrefix": { + "type": "string", + "description": "Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126" + }, + "condition": { + "$ref": "#/definitions/Condition", + "description": "Specify prefix-list bounds." + }, + "subnetMaskLength": { + "type": "string", + "description": "SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128." + } + }, + "required": [ + "action", + "sequenceNumber", + "networkPrefix" + ] + }, + "IsMonitoringEnabled": { + "type": "string", + "description": "To check whether monitoring of internal network is enabled or not.", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsMonitoringEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsMonitoringEnabled-True" + }, + { + "name": "False", + "value": "False", + "description": "IsMonitoringEnabled-False" + } + ] + } + }, + "IsolationDomainPatchProperties": { + "type": "object", + "description": "Isolation Domain Properties.", + "properties": { + "encapsulation": { + "$ref": "#/definitions/Encapsulation", + "description": "Type of encapsulation." + }, + "neighborGroupIds": { + "type": "array", + "description": "List of Neighbor Group IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + } + ] + } + } + } + } + }, + "IsolationDomainProperties": { + "type": "object", + "description": "Isolation Domain Properties.", + "properties": { + "encapsulation": { + "$ref": "#/definitions/Encapsulation", + "description": "Type of encapsulation." + }, + "neighborGroupIds": { + "type": "array", + "description": "List of Neighbor Group IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + } + ] + } + } + } + } + }, + "L2IsolationDomain": { + "type": "object", + "description": "The L2 Isolation Domain resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/L2IsolationDomainProperties", + "description": "The L2IsolationDomain properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "L2IsolationDomainListResult": { + "type": "object", + "description": "The response of a L2IsolationDomain list operation.", + "properties": { + "value": { + "type": "array", + "description": "The L2IsolationDomain items on this page", + "items": { + "$ref": "#/definitions/L2IsolationDomain" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "L2IsolationDomainPatch": { + "type": "object", + "description": "The L2 Isolation Domain patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/L2IsolationDomainPatchProperties", + "description": "Resource properties." + } + } + }, + "L2IsolationDomainPatchProperties": { + "type": "object", + "description": "L2 Isolation Domain Patch Properties defines the patchable properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "minimum": 64, + "maximum": 9200 + }, + "extendedVlan": { + "$ref": "#/definitions/ExtendedVlan", + "description": "Extended VLAN status." + }, + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + } + } + }, + "L2IsolationDomainProperties": { + "type": "object", + "description": "L2Isolation Domain Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan Identifier of the Network Fabric. Example: 501.", + "minimum": 100, + "maximum": 4094 + }, + "mtu": { + "type": "integer", + "format": "int32", + "description": "Maximum transmission unit. Default value is 1500.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "extendedVlan": { + "type": "string", + "description": "Extended VLAN status, default value is Disabled.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExtendedVlan", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Extended VLAN is enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Extended VLAN is disabled." + } + ] + } + }, + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the networkToNetworkInterconnectId of the L2 ISD resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId", + "vlanId" + ] + }, + "L3ExportRoutePolicy": { + "type": "object", + "description": "Array of ARM Resource ID of the RoutePolicies.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "L3ExportRoutePolicyPatch": { + "type": "object", + "description": "Array of ARM Resource ID of the RoutePolicies.", + "properties": { + "exportIpv4RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + }, + "exportIpv6RoutePolicyId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the RoutePolicy.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/routePolicies" + } + ] + } + } + } + }, + "L3IsolationDomain": { + "type": "object", + "description": "The L3 Isolation Domain resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/L3IsolationDomainProperties", + "description": "The L3 Isolation Domain Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "L3IsolationDomainListResult": { + "type": "object", + "description": "The response of a L3IsolationDomain list operation.", + "properties": { + "value": { + "type": "array", + "description": "The L3IsolationDomain items on this page", + "items": { + "$ref": "#/definitions/L3IsolationDomain" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "L3IsolationDomainPatch": { + "type": "object", + "description": "The L3 Isolation Domain patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/L3IsolationDomainPatchProperties", + "description": "Resource properties." + } + } + }, + "L3IsolationDomainPatchProperties": { + "type": "object", + "description": "Resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "redistributeConnectedSubnets": { + "$ref": "#/definitions/RedistributeConnectedSubnets", + "description": "Advertise Connected Subnets. Ex: \"True\" | \"False\"." + }, + "redistributeStaticRoutes": { + "$ref": "#/definitions/RedistributeStaticRoutes", + "description": "Advertise Static Routes. Ex: \"True\" | \"False\"." + }, + "aggregateRouteConfiguration": { + "$ref": "#/definitions/AggregateRoutePatchConfiguration", + "description": "Aggregate route configurations." + }, + "connectedSubnetRoutePolicy": { + "$ref": "#/definitions/ConnectedSubnetRoutePolicyPatch", + "description": "Connected Subnet RoutePolicy" + }, + "staticRouteRoutePolicy": { + "$ref": "#/definitions/StaticRouteRoutePolicyPatch", + "description": "Static Route - route policy." + }, + "routePrefixLimit": { + "$ref": "#/definitions/RoutePrefixLimitPatchProperties", + "description": "Virtual Routing and Forwarding (VRF) Limit configuration." + } + } + }, + "L3IsolationDomainProperties": { + "type": "object", + "description": "L3 Isolation Domain Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "redistributeConnectedSubnets": { + "type": "string", + "description": "Advertise Connected Subnets. Ex: \"True\" | \"False\".", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeConnectedSubnets", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeConnectedSubnets-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeConnectedSubnets-False" + } + ] + } + }, + "redistributeStaticRoutes": { + "type": "string", + "description": "Advertise Static Routes. Ex: \"True\" | \"False\".", + "default": "False", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeStaticRoutes", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeStaticRoutes-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeStaticRoutes-False" + } + ] + } + }, + "aggregateRouteConfiguration": { + "$ref": "#/definitions/AggregateRouteConfiguration", + "description": "Aggregate route configurations." + }, + "connectedSubnetRoutePolicy": { + "$ref": "#/definitions/ConnectedSubnetRoutePolicy", + "description": "Connected Subnet RoutePolicy" + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network Fabric.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "staticRouteRoutePolicy": { + "$ref": "#/definitions/StaticRouteRoutePolicy", + "description": "Static Route - route policy." + }, + "uniqueRdConfiguration": { + "$ref": "#/definitions/L3UniqueRouteDistinguisherProperties", + "description": "Unique Route Distinguisher configuration" + }, + "routePrefixLimit": { + "$ref": "#/definitions/RoutePrefixLimitProperties", + "description": "VRF Limit configuration." + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId" + ] + }, + "L3OptionBPatchProperties": { + "type": "object", + "description": "Option B configuration.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetPatchInformation", + "description": "RouteTargets to be applied." + } + } + }, + "L3OptionBProperties": { + "type": "object", + "description": "Option B configuration.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "RouteTargets to be applied. This is used for the backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetInformation", + "description": "RouteTargets to be applied." + } + } + }, + "L3UniqueRouteDistinguisherProperties": { + "type": "object", + "description": "Unique Route Distinguisher properties.", + "properties": { + "uniqueRds": { + "type": "array", + "description": "List of Unique Route Distinguisher addresses.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "LastOperationProperties": { + "type": "object", + "description": "Details of the last operations performed on the resource", + "properties": { + "details": { + "type": "string", + "description": "Details status of the last operation performed on the resource.", + "readOnly": true + } + } + }, + "Layer2Configuration": { + "type": "object", + "description": "Common properties for Layer2 Configuration.", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU of the packets between PE & CE.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "interfaces": { + "type": "array", + "description": "List of network device interfaces resource IDs.", + "minItems": 1, + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces" + } + ] + } + } + } + } + }, + "Layer2ConfigurationPatch": { + "type": "object", + "description": "Common properties for Layer2 Configuration.", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU of the packets between PE & CE.", + "minimum": 64, + "maximum": 9200 + }, + "interfaces": { + "type": "array", + "description": "List of network device interfaces resource IDs.", + "minItems": 1, + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces" + } + ] + } + } + } + } + }, + "Layer4Protocol": { + "type": "string", + "description": "Layer4 protocol type that needs to be matched.", + "enum": [ + "TCP", + "UDP", + "SCTP" + ], + "x-ms-enum": { + "name": "Layer4Protocol", + "modelAsString": true, + "values": [ + { + "name": "TCP", + "value": "TCP", + "description": "TCP(Transmission Control Protocol) Protocol" + }, + { + "name": "UDP", + "value": "UDP", + "description": "UDP(User Datagram Protocol) Protocol" + }, + { + "name": "SCTP", + "value": "SCTP", + "description": "SCTP(Streaming Control Transmission Protocol) Protocol" + } + ] + } + }, + "LockConfigurationState": { + "type": "string", + "description": "Lock Configuration State.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LockConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "LockConfigurationState Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "LockConfigurationState Disabled" + } + ] + } + }, + "ManagedResourceGroupConfiguration": { + "type": "object", + "description": "Managed Resource Group configuration properties.", + "properties": { + "name": { + "type": "string", + "description": "The NFC service will be hosted in a Managed resource group." + }, + "location": { + "type": "string", + "description": "Managed resource group location.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ManagedServiceIdentityPatch": { + "type": "object", + "description": "The managed service identities assigned to this resource.", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity", + "x-nullable": true + } + } + } + }, + "ManagedServiceIdentitySelectorType": { + "type": "string", + "description": "The type of managed identity.", + "enum": [ + "SystemAssignedIdentity", + "UserAssignedIdentity" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentitySelectorType", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedIdentity", + "value": "SystemAssignedIdentity", + "description": "System Assigned Identity." + }, + { + "name": "UserAssignedIdentity", + "value": "UserAssignedIdentity", + "description": "User Assigned Identity." + } + ] + } + }, + "ManagementNetworkConfigurationProperties": { + "type": "object", + "description": "Configuration to be used to setup the management network.", + "properties": { + "infrastructureVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationProperties", + "description": "VPN Configuration properties." + }, + "workloadVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationProperties", + "description": "VPN Configuration properties." + } + }, + "required": [ + "infrastructureVpnConfiguration", + "workloadVpnConfiguration" + ] + }, + "ManagementNetworkPatchConfiguration": { + "type": "object", + "description": "Configuration to be used to setup the management network.", + "properties": { + "infrastructureVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationPatchableProperties", + "description": "VPN Configuration properties." + }, + "workloadVpnConfiguration": { + "$ref": "#/definitions/VpnConfigurationPatchableProperties", + "description": "VPN Configuration properties." + } + } + }, + "MicroBfdState": { + "type": "string", + "description": "Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "MicroBfdState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "MicroBfdState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "MicroBfdState-Disabled" + } + ] + } + }, + "NNIDerivedUniqueRouteDistinguisherConfigurationState": { + "type": "string", + "description": "NNI Derived Unique Route Distinguisher Configuration State.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NNIDerivedUniqueRouteDistinguisherConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "NNI derived unique route distinguisher configuration state Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "NNI derived unique route distinguisher configuration state Disabled" + } + ] + } + }, + "NativeIpv4PrefixLimitPatchProperties": { + "type": "object", + "description": "External Network native IPv4 prefix limits patch properties", + "properties": { + "prefixLimits": { + "type": "array", + "description": "Prefix limits", + "minItems": 1, + "items": { + "$ref": "#/definitions/PrefixLimitPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "NativeIpv4PrefixLimitProperties": { + "type": "object", + "description": "External Network native IPv4 prefix limit properties", + "properties": { + "prefixLimits": { + "type": "array", + "description": "Prefix limits", + "minItems": 1, + "items": { + "$ref": "#/definitions/PrefixLimitProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "NativeIpv6PrefixLimitPatchProperties": { + "type": "object", + "description": "External Network native IPv6 prefix limits patch properties", + "properties": { + "prefixLimits": { + "type": "array", + "description": "Prefix limits", + "minItems": 1, + "items": { + "$ref": "#/definitions/PrefixLimitPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "NativeIpv6PrefixLimitProperties": { + "type": "object", + "description": "External Network native IPv6 prefix limit properties", + "properties": { + "prefixLimits": { + "type": "array", + "description": "Prefix limits", + "minItems": 1, + "items": { + "$ref": "#/definitions/PrefixLimitProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "NeighborAddress": { + "type": "object", + "description": "Neighbor Address properties.", + "properties": { + "address": { + "type": "string", + "description": "IP Address.", + "minLength": 1 + }, + "bfdAdministrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "BFD Administrative State for each Neighbor Address. Example: Enabled | Disabled.", + "readOnly": true + }, + "bgpAdministrativeState": { + "$ref": "#/definitions/BgpAdministrativeState", + "description": "BGP Administrative State for each Neighbor Address. Example: Enabled | Disabled.", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + } + } + }, + "NeighborAddressBfdAdministrativeStatus": { + "type": "object", + "description": "Neighbor Address Bidirectional Forwarding Detection (BFD) Administrative Status", + "properties": { + "neighborAddress": { + "type": "string", + "description": "NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address." + }, + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "BFD Administrative state." + }, + "error": { + "type": "string", + "description": "Error message." + } + } + }, + "NeighborAddressBgpAdministrativeStatus": { + "type": "object", + "description": "Neighbor Address BGP Administrative Status", + "properties": { + "neighborAddress": { + "type": "string", + "description": "NeighborAddress - Input should be either All or Specific Ipv4 Address or Specific Ipv6 Address." + }, + "administrativeState": { + "$ref": "#/definitions/BgpAdministrativeState", + "description": "BGP Administrative state." + }, + "error": { + "type": "string", + "description": "Error message." + } + } + }, + "NeighborAddressPatch": { + "type": "object", + "description": "Neighbor Address properties.", + "properties": { + "address": { + "type": "string", + "description": "IP Address.", + "minLength": 1 + }, + "bfdAdministrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "BFD Administrative State for each Neighbor Address. Example: Enabled | Disabled.", + "readOnly": true + }, + "bgpAdministrativeState": { + "$ref": "#/definitions/BgpAdministrativeState", + "description": "BGP Administrative State for each Neighbor Address. Example: Enabled | Disabled.", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + } + } + }, + "NeighborGroup": { + "type": "object", + "description": "Defines the Neighbor Group.", + "properties": { + "properties": { + "$ref": "#/definitions/NeighborGroupProperties", + "description": "The NeighborGroup Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NeighborGroupDestination": { + "type": "object", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses.", + "properties": { + "ipv4Addresses": { + "type": "array", + "description": "Array of IPv4 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + }, + "ipv6Addresses": { + "type": "array", + "description": "Array of IPv6 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + } + } + }, + "NeighborGroupDestinationPatch": { + "type": "object", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses.", + "properties": { + "ipv4Addresses": { + "type": "array", + "description": "Array of IPv4 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + }, + "ipv6Addresses": { + "type": "array", + "description": "Array of IPv6 Addresses.", + "maxItems": 16, + "items": { + "type": "string" + } + } + } + }, + "NeighborGroupListResult": { + "type": "object", + "description": "The response of a NeighborGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NeighborGroup items on this page", + "items": { + "$ref": "#/definitions/NeighborGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NeighborGroupPatch": { + "type": "object", + "description": "The Neighbor Group Patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NeighborGroupPatchProperties", + "description": "Neighbor Group Patch properties." + } + } + }, + "NeighborGroupPatchProperties": { + "type": "object", + "description": "Neighbor Group Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "destination": { + "$ref": "#/definitions/NeighborGroupDestinationPatch", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses." + } + } + }, + "NeighborGroupProperties": { + "type": "object", + "description": "Neighbor Group Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "destination": { + "$ref": "#/definitions/NeighborGroupDestination", + "description": "An array of destination IPv4 Addresses or IPv6 Addresses." + }, + "networkTapIds": { + "type": "array", + "description": "List of NetworkTap IDs where neighbor group is associated.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTaps" + } + ] + } + }, + "readOnly": true + }, + "networkTapRuleIds": { + "type": "array", + "description": "List of Network Tap Rule IDs where neighbor group is associated.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + }, + "readOnly": true + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "destination" + ] + }, + "NetworkDevice": { + "type": "object", + "description": "The Network Device resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkDeviceProperties", + "description": "The NetworkDevice properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkDeviceListResult": { + "type": "object", + "description": "The response of a NetworkDevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkDevice items on this page", + "items": { + "$ref": "#/definitions/NetworkDevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkDevicePatchParameters": { + "type": "object", + "description": "The Network Device Patch Parameters defines the patch parameters of the resource.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkDevicePatchParametersProperties", + "description": "Network Device Patch properties." + } + } + }, + "NetworkDevicePatchParametersProperties": { + "type": "object", + "description": "Network Device Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "hostName": { + "type": "string", + "description": "The host name of the device.", + "minLength": 1 + }, + "serialNumber": { + "type": "string", + "description": "Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.", + "minLength": 1 + } + } + }, + "NetworkDeviceProperties": { + "type": "object", + "description": "Network Device Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "hostName": { + "type": "string", + "description": "The host name of the device.", + "minLength": 1 + }, + "serialNumber": { + "type": "string", + "description": "Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber.", + "minLength": 1 + }, + "version": { + "type": "string", + "description": "Current version of the device as defined in SKU.", + "readOnly": true + }, + "networkDeviceSku": { + "type": "string", + "description": "Network Device SKU name.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkDeviceRole": { + "$ref": "#/definitions/NetworkDeviceRole", + "description": "NetworkDeviceRole is the device role: Example: CE | ToR.", + "readOnly": true + }, + "networkRackId": { + "type": "string", + "description": "Reference to network rack resource id.", + "readOnly": true + }, + "managementIpv4Address": { + "type": "string", + "description": "Management IPv4 Address.", + "readOnly": true + }, + "managementIpv6Address": { + "type": "string", + "description": "Management IPv6 Address.", + "readOnly": true + }, + "rwDeviceConfig": { + "type": "string", + "description": "User configured read-write configuration applied on the network devices.", + "readOnly": true + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "serialNumber" + ] + }, + "NetworkDeviceRole": { + "type": "string", + "description": "NetworkDeviceRole is the device role: Example: CE | ToR.", + "enum": [ + "CE", + "ToR", + "NPB", + "TS", + "Management" + ], + "x-ms-enum": { + "name": "NetworkDeviceRole", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "NetworkDeviceRole-CE(Customer Edge)" + }, + { + "name": "ToR", + "value": "ToR", + "description": "NetworkDeviceRole-ToR(top of rack)" + }, + { + "name": "NPB", + "value": "NPB", + "description": "NetworkDeviceRole-NPB(Network Packet Broker)" + }, + { + "name": "TS", + "value": "TS", + "description": "NetworkDeviceRole-TS(Terminal Server)" + }, + { + "name": "Management", + "value": "Management", + "description": "NetworkDeviceRole-Management" + } + ] + } + }, + "NetworkDeviceRoleName": { + "type": "string", + "description": "Available roles for the network device.", + "enum": [ + "CE", + "ToR", + "NPB", + "TS", + "Management" + ], + "x-ms-enum": { + "name": "NetworkDeviceRoleName", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "NetworkDeviceRoleName-CE(Customer Edge)" + }, + { + "name": "ToR", + "value": "ToR", + "description": "NetworkDeviceRoleName-ToR(top of rack)" + }, + { + "name": "NPB", + "value": "NPB", + "description": "NetworkDeviceRoleName-NPB(Network Packet Broker)" + }, + { + "name": "TS", + "value": "TS", + "description": "NetworkDeviceRoleName-TS(Terminal Server)" + }, + { + "name": "Management", + "value": "Management", + "description": "NetworkDeviceRoleName-Management" + } + ] + } + }, + "NetworkDeviceSku": { + "type": "object", + "description": "The NetworkDeviceSku resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkDeviceSkuProperties", + "description": "The NetworkDeviceSku properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkDeviceSkuListResult": { + "type": "object", + "description": "The response of a NetworkDeviceSku list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkDeviceSku items on this page", + "items": { + "$ref": "#/definitions/NetworkDeviceSku" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkDeviceSkuProperties": { + "type": "object", + "description": "Network Device SKU Properties defines the properties of the resource.", + "properties": { + "model": { + "type": "string", + "description": "Model of the network device." + }, + "manufacturer": { + "type": "string", + "description": "Manufacturer of the network device." + }, + "supportedVersions": { + "type": "array", + "description": "List of supported version details of network device.", + "items": { + "$ref": "#/definitions/SupportedVersionProperties" + }, + "x-ms-identifiers": [ + "version" + ] + }, + "supportedRoleTypes": { + "type": "array", + "description": "Available roles for the network device.", + "items": { + "$ref": "#/definitions/NetworkDeviceRoleName" + } + }, + "interfaces": { + "type": "array", + "description": "List of network device interfaces.", + "items": { + "$ref": "#/definitions/DeviceInterfaceProperties" + }, + "x-ms-identifiers": [ + "identifier" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "model" + ] + }, + "NetworkFabric": { + "type": "object", + "description": "The Network Fabric resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFabricProperties", + "description": "The NetworkFabric Properties" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFabricController": { + "type": "object", + "description": "The Network Fabric Controller resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFabricControllerProperties", + "description": "The NetworkFabricController Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFabricControllerListResult": { + "type": "object", + "description": "The response of a NetworkFabricController list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFabricController items on this page", + "items": { + "$ref": "#/definitions/NetworkFabricController" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFabricControllerPatch": { + "type": "object", + "description": "The Network Fabric Controller Patch payload definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkFabricControllerPatchProperties", + "description": "Network Fabric Controller patch properties." + } + } + }, + "NetworkFabricControllerPatchProperties": { + "type": "object", + "description": "Network Fabric Controller patch properties.", + "properties": { + "infrastructureExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute)", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + }, + "workloadExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + } + } + }, + "NetworkFabricControllerProperties": { + "type": "object", + "description": "NetworkFabricControllerProperties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "infrastructureExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute)", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + }, + "workloadExpressRouteConnections": { + "type": "array", + "description": "As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute).", + "items": { + "$ref": "#/definitions/ExpressRouteConnectionInformation" + }, + "x-ms-identifiers": [ + "expressRouteCircuitId" + ] + }, + "infrastructureServices": { + "$ref": "#/definitions/ControllerServices", + "description": "InfrastructureServices IP ranges.", + "readOnly": true + }, + "workloadServices": { + "$ref": "#/definitions/ControllerServices", + "description": "WorkloadServices IP ranges.", + "readOnly": true + }, + "managedResourceGroupConfiguration": { + "$ref": "#/definitions/ManagedResourceGroupConfiguration", + "description": "Managed Resource Group configuration properties." + }, + "networkFabricIds": { + "type": "array", + "description": "The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "readOnly": true + }, + "isWorkloadManagementNetworkEnabled": { + "type": "string", + "description": "A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints.", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsWorkloadManagementNetworkEnabled", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsWorkloadManagementNetworkEnabled-True" + }, + { + "name": "False", + "value": "False", + "description": "IsWorkloadManagementNetworkEnabled-False" + } + ] + } + }, + "tenantInternetGatewayIds": { + "type": "array", + "description": "List of tenant InternetGateway resource IDs", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/internetGateways" + } + ] + } + }, + "readOnly": true + }, + "ipv4AddressSpace": { + "type": "string", + "description": "IPv4 Network Fabric Controller Address Space.", + "default": "10.0.0.0/19", + "minLength": 1 + }, + "ipv6AddressSpace": { + "type": "string", + "description": "IPv6 Network Fabric Controller Address Space.", + "default": "FC00::/59", + "minLength": 1 + }, + "nfcSku": { + "type": "string", + "description": "Network Fabric Controller SKU.", + "default": "Standard", + "enum": [ + "Basic", + "Standard", + "HighPerformance" + ], + "x-ms-enum": { + "name": "NfcSku", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "NfcSku-Basic" + }, + { + "name": "Standard", + "value": "Standard", + "description": "NfcSku-Standard" + }, + { + "name": "HighPerformance", + "value": "HighPerformance", + "description": "NfcSku-HighPerformance" + } + ] + } + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning.", + "readOnly": true + } + } + }, + "NetworkFabricListResult": { + "type": "object", + "description": "The response of a NetworkFabric list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFabric items on this page", + "items": { + "$ref": "#/definitions/NetworkFabric" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFabricLockAction": { + "type": "string", + "description": "Network fabric lock action", + "enum": [ + "Lock", + "Unlock" + ], + "x-ms-enum": { + "name": "NetworkFabricLockAction", + "modelAsString": true, + "values": [ + { + "name": "Lock", + "value": "Lock", + "description": "Perform lock operation" + }, + { + "name": "Unlock", + "value": "Unlock", + "description": "Perform unlock operation" + } + ] + } + }, + "NetworkFabricLockRequest": { + "type": "object", + "description": "Network Fabric Lock Request.", + "properties": { + "lockType": { + "$ref": "#/definitions/NetworkFabricLockType", + "description": "Type of lock to be applied" + }, + "action": { + "$ref": "#/definitions/NetworkFabricLockAction", + "description": "Action to be performed on the lock" + } + } + }, + "NetworkFabricLockType": { + "type": "string", + "description": "Network fabric lock type", + "enum": [ + "Administrative", + "Configuration" + ], + "x-ms-enum": { + "name": "NetworkFabricLockType", + "modelAsString": true, + "values": [ + { + "name": "Administrative", + "value": "Administrative", + "description": "A administrative lock/unlock operation will be performed" + }, + { + "name": "Configuration", + "value": "Configuration", + "description": "A lock/unlock operation will be performed on the configuration" + } + ] + } + }, + "NetworkFabricPatch": { + "type": "object", + "description": "The Network Fabric resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkFabricPatchProperties", + "description": "Network Fabric Patch properties." + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentityPatch", + "description": "The managed service identities assigned to this resource." + } + } + }, + "NetworkFabricPatchProperties": { + "type": "object", + "description": "Network Fabric Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "rackCount": { + "type": "integer", + "format": "int32", + "description": "Number of compute racks associated to Network Fabric.", + "minimum": 1, + "maximum": 8 + }, + "serverCountPerRack": { + "type": "integer", + "format": "int32", + "description": "Number of servers.Possible values are from 1-16.", + "minimum": 1, + "maximum": 16 + }, + "ipv4Prefix": { + "type": "string", + "description": "IPv4Prefix for Management Network. Example: 10.1.0.0/19.", + "minLength": 1 + }, + "ipv6Prefix": { + "type": "string", + "description": "IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59.", + "minLength": 1 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "minimum": 1, + "maximum": 4294967295 + }, + "storageAccountConfiguration": { + "$ref": "#/definitions/StorageAccountPatchConfiguration", + "description": "Bring your own storage account configurations for Network Fabric." + }, + "terminalServerConfiguration": { + "$ref": "#/definitions/TerminalServerPatchConfiguration", + "description": "Network and credentials configuration already applied to terminal server." + }, + "managementNetworkConfiguration": { + "$ref": "#/definitions/ManagementNetworkPatchConfiguration", + "description": "Configuration to be used to setup the management network." + }, + "hardwareAlertThreshold": { + "type": "integer", + "format": "int32", + "description": "Hardware alert threshold percentage. Possible values are from 20 to 100.", + "minimum": 20, + "maximum": 100 + }, + "controlPlaneAcls": { + "type": "array", + "description": "Control Plane Access Control List ARM resource IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + } + }, + "trustedIpPrefixes": { + "type": "array", + "description": "Trusted IP Prefix ARM resource IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/ipPrefixes" + } + ] + } + } + }, + "uniqueRdConfiguration": { + "$ref": "#/definitions/UniqueRouteDistinguisherPatchProperties", + "description": "Unique Route Distinguisher configuration" + } + } + }, + "NetworkFabricProperties": { + "type": "object", + "description": "Network Fabric Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkFabricSku": { + "type": "string", + "description": "Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric.", + "minLength": 1, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "fabricVersion": { + "type": "string", + "description": "The version of Network Fabric.", + "minLength": 1 + }, + "routerIds": { + "type": "array", + "description": "Array of router IDs.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "storageAccountConfiguration": { + "$ref": "#/definitions/StorageAccountConfiguration", + "description": "Bring your own storage account configurations for Network Fabric." + }, + "fabricLocks": { + "type": "array", + "description": "Network Fabric Lock details", + "minItems": 1, + "items": { + "$ref": "#/definitions/FabricLockProperties" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "networkFabricControllerId": { + "type": "string", + "format": "arm-id", + "description": "Azure resource ID for the NetworkFabricController the NetworkFabric belongs.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabricControllers" + } + ] + } + }, + "rackCount": { + "type": "integer", + "format": "int32", + "description": "Number of compute racks associated to Network Fabric.", + "minimum": 1, + "maximum": 8 + }, + "serverCountPerRack": { + "type": "integer", + "format": "int32", + "description": "Number of servers.Possible values are from 1-16.", + "minimum": 1, + "maximum": 16 + }, + "ipv4Prefix": { + "type": "string", + "description": "IPv4Prefix for Management Network. Example: 10.1.0.0/19.", + "minLength": 1 + }, + "ipv6Prefix": { + "type": "string", + "description": "IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59", + "minLength": 1 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "minimum": 1, + "maximum": 4294967295 + }, + "terminalServerConfiguration": { + "$ref": "#/definitions/TerminalServerConfiguration", + "description": "Network and credentials configuration currently applied to terminal server." + }, + "managementNetworkConfiguration": { + "$ref": "#/definitions/ManagementNetworkConfigurationProperties", + "description": "Configuration to be used to setup the management network." + }, + "racks": { + "type": "array", + "description": "List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "l2IsolationDomains": { + "type": "array", + "description": "List of L2 Isolation Domain resource IDs under the Network Fabric.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "l3IsolationDomains": { + "type": "array", + "description": "List of L3 Isolation Domain resource IDs under the Network Fabric.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "hardwareAlertThreshold": { + "type": "integer", + "format": "int32", + "description": "Hardware alert threshold percentage. Possible values are from 20 to 100.", + "minimum": 20, + "maximum": 100 + }, + "controlPlaneAcls": { + "type": "array", + "description": "Control Plane Access Control List ARM resource IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + } + }, + "featureFlags": { + "type": "array", + "description": "Feature flag status information", + "items": { + "$ref": "#/definitions/FeatureFlagProperties" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "trustedIpPrefixes": { + "type": "array", + "description": "Trusted IP Prefixes ARM resource IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/ipPrefixes" + } + ] + } + } + }, + "uniqueRdConfiguration": { + "$ref": "#/definitions/UniqueRouteDistinguisherProperties", + "description": "Unique Route Distinguisher configuration" + }, + "storageArrayCount": { + "type": "integer", + "format": "int32", + "description": "Number of Storage arrays associated with the Network Fabric.", + "minimum": 1, + "maximum": 2 + }, + "activeCommitBatches": { + "type": "array", + "description": "Active commit batch identifiers", + "items": { + "type": "string" + }, + "readOnly": true + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricSku", + "networkFabricControllerId", + "serverCountPerRack", + "ipv4Prefix", + "fabricASN", + "terminalServerConfiguration", + "managementNetworkConfiguration" + ] + }, + "NetworkFabricSku": { + "type": "object", + "description": "The Network Fabric SKU resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFabricSkuProperties", + "description": "The Network Fabric Sku properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkFabricSkuListResult": { + "type": "object", + "description": "The response of a NetworkFabricSku list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFabricSku items on this page", + "items": { + "$ref": "#/definitions/NetworkFabricSku" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFabricSkuProperties": { + "type": "object", + "description": "Network Fabric SKU Properties define properties of the resource.", + "properties": { + "type": { + "$ref": "#/definitions/FabricSkuType", + "description": "Type of Network Fabric SKU.", + "readOnly": true + }, + "maxComputeRacks": { + "type": "integer", + "format": "int32", + "description": "Maximum number of compute racks available for this Network Fabric SKU. The value of max count racks is 4 for 4 rack SKU and 8 for 8 rack SKU." + }, + "maximumServerCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of servers available for this Network Fabric SKU." + }, + "supportedVersions": { + "type": "array", + "description": "List of supported Network Fabric SKU versions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "details": { + "type": "string", + "description": "URL providing detailed configuration of the fabric SKU.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + } + }, + "NetworkFabricUpgradeAction": { + "type": "string", + "description": "Action to be performed while upgrading the fabric.", + "enum": [ + "Start", + "Complete" + ], + "x-ms-enum": { + "name": "NetworkFabricUpgradeAction", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "UpgradeAction-Start" + }, + { + "name": "Complete", + "value": "Complete", + "description": "UpgradeAction -Complete" + } + ] + } + }, + "NetworkInterface": { + "type": "object", + "description": "Defines the NetworkInterface resource.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The NetworkInterface properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkInterfacePatch": { + "type": "object", + "description": "The NetworkInterfacePatch resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfacePatchProperties", + "description": "Network Interface Patch properties." + } + } + }, + "NetworkInterfacePatchProperties": { + "type": "object", + "description": "Network Interface Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "description": { + "type": "string", + "description": "Description of the interface." + }, + "additionalDescription": { + "type": "string", + "description": "Additional description of the interface." + } + } + }, + "NetworkInterfaceProperties": { + "type": "object", + "description": "Network Interface Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "physicalIdentifier": { + "type": "string", + "description": "Physical Identifier of the network interface.", + "readOnly": true + }, + "connectedTo": { + "type": "string", + "description": "The ARM resource id of the interface or compute server its connected to.", + "readOnly": true + }, + "interfaceType": { + "$ref": "#/definitions/InterfaceType", + "description": "The Interface Type. Example: Management/Data", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "IPv4Address of the interface.", + "readOnly": true + }, + "ipv6Address": { + "type": "string", + "description": "IPv6Address of the interface.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the interface." + }, + "additionalDescription": { + "type": "string", + "description": "Additional description of the interface." + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + } + }, + "NetworkMonitor": { + "type": "object", + "description": "The NetworkMonitor resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkMonitorProperties", + "description": "The NetworkFabric Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkMonitorListResult": { + "type": "object", + "description": "The response of a NetworkMonitor list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkMonitor items on this page", + "items": { + "$ref": "#/definitions/NetworkMonitor" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkMonitorPatch": { + "type": "object", + "description": "The Network Monitor Patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkMonitorPatchProperties", + "description": "Network Monitor Patch properties." + } + } + }, + "NetworkMonitorPatchProperties": { + "type": "object", + "description": "The Network Monitor Patch Properties.", + "properties": { + "bmpConfiguration": { + "$ref": "#/definitions/BmpConfigurationPatchProperties", + "description": "BGP Monitoring Protocol (BMP) Configurations for the Network Monitor." + } + } + }, + "NetworkMonitorProperties": { + "type": "object", + "description": "Network Monitor Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "bmpConfiguration": { + "$ref": "#/definitions/BmpConfigurationProperties", + "description": "BMP Configurations for the Network Fabric." + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NetworkMonitor resource", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + } + }, + "NetworkPacketBroker": { + "type": "object", + "description": "The NetworkPacketBroker resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkPacketBrokerProperties", + "description": "The NetworkPacketBroker properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkPacketBrokerListResult": { + "type": "object", + "description": "The response of a NetworkPacketBroker list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkPacketBroker items on this page", + "items": { + "$ref": "#/definitions/NetworkPacketBroker" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkPacketBrokerPatch": { + "type": "object", + "description": "The NetworkPacketBroker patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkPacketBrokerProperties": { + "type": "object", + "description": "Network Packet Broker Properties defines the properties of the resource.", + "properties": { + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of the Network Fabric.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "networkDeviceIds": { + "type": "array", + "description": "List of ARM resource IDs of Network Devices [NPB].", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices" + } + ] + } + }, + "readOnly": true + }, + "sourceInterfaceIds": { + "type": "array", + "description": "List of network interfaces across NPB devices that are used to mirror source traffic.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices/networkInterfaces" + } + ] + } + }, + "readOnly": true + }, + "networkTapIds": { + "type": "array", + "description": "List of network Tap IDs configured on NPB.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTaps" + } + ] + } + }, + "readOnly": true + }, + "neighborGroupIds": { + "type": "array", + "description": "List of neighbor group IDs configured on NPB.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTaps" + } + ] + } + }, + "readOnly": true + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId" + ] + }, + "NetworkRack": { + "type": "object", + "description": "The Network Rack resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkRackProperties", + "description": "The NetworkRack properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkRackListResult": { + "type": "object", + "description": "The response of a NetworkRack list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkRack items on this page", + "items": { + "$ref": "#/definitions/NetworkRack" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkRackPatch": { + "type": "object", + "description": "Network Rack patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkRackProperties": { + "type": "object", + "description": "Network Rack Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkRackType": { + "$ref": "#/definitions/NetworkRackType", + "description": "Network Rack SKU name." + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of the Network Fabric.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "networkDevices": { + "type": "array", + "description": "List of network device ARM resource IDs.", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkDevices" + } + ] + } + }, + "readOnly": true + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + } + }, + "required": [ + "networkFabricId" + ] + }, + "NetworkRackType": { + "type": "string", + "description": "Network Rack SKU name.", + "enum": [ + "Aggregate", + "Compute", + "Combined" + ], + "x-ms-enum": { + "name": "NetworkRackType", + "modelAsString": true, + "values": [ + { + "name": "Aggregate", + "value": "Aggregate", + "description": "NetworkRackType-Aggregate" + }, + { + "name": "Compute", + "value": "Compute", + "description": "NetworkRackType-Compute" + }, + { + "name": "Combined", + "value": "Combined", + "description": "NetworkRackType-Combined" + } + ] + } + }, + "NetworkTap": { + "type": "object", + "description": "The Network Tap resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkTapProperties", + "description": "The NetworkTap Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkTapListResult": { + "type": "object", + "description": "The response of a NetworkTap list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkTap items on this page", + "items": { + "$ref": "#/definitions/NetworkTap" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkTapPatch": { + "type": "object", + "description": "The NetworkFabric resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkTapPatchProperties", + "description": "Resource properties." + } + } + }, + "NetworkTapPatchProperties": { + "type": "object", + "description": "The Network Tap resource patch definition.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "pollingType": { + "$ref": "#/definitions/PollingType", + "description": "Polling type." + }, + "destinations": { + "type": "array", + "description": "List of destination properties to send the filter traffic.", + "items": { + "$ref": "#/definitions/DestinationPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapProperties": { + "type": "object", + "description": "Network Tap Properties defines the properties of the resource.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "networkPacketBrokerId": { + "type": "string", + "format": "arm-id", + "description": "ARM resource ID of the Network Packet Broker.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "sourceTapRuleId": { + "type": "string", + "format": "arm-id", + "description": "Source Tap Rule Id. ARM Resource ID of the Network Tap Rule.", + "readOnly": true, + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkTapRules" + } + ] + } + }, + "destinations": { + "type": "array", + "description": "List of destinations to send the filter traffic.", + "items": { + "$ref": "#/definitions/DestinationProperties" + }, + "x-ms-identifiers": [] + }, + "pollingType": { + "type": "string", + "description": "Polling type.", + "default": "Pull", + "enum": [ + "Pull", + "Push" + ], + "x-ms-enum": { + "name": "PollingType", + "modelAsString": true, + "values": [ + { + "name": "Pull", + "value": "Pull", + "description": "PollingType-Pull" + }, + { + "name": "Push", + "value": "Push", + "description": "PollingType-Push" + } + ] + } + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configurations state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource. Example -Enabled/Disabled", + "readOnly": true + } + }, + "required": [ + "networkPacketBrokerId", + "destinations" + ] + }, + "NetworkTapRule": { + "type": "object", + "description": "The NetworkTapRule resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkTapRuleProperties", + "description": "The NetworkTapRule Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkTapRuleAction": { + "type": "object", + "description": "Action that need to performed.", + "properties": { + "type": { + "$ref": "#/definitions/TapRuleActionType", + "description": "Type of actions that can be performed." + }, + "truncate": { + "type": "string", + "description": "Truncate. 0 indicates do not truncate.", + "minLength": 1 + }, + "isTimestampEnabled": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "The parameter to enable or disable the timestamp." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + }, + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration. This is used when Goto type is provided.", + "minLength": 1 + } + } + }, + "NetworkTapRuleActionPatch": { + "type": "object", + "description": "Action that need to performed.", + "properties": { + "type": { + "$ref": "#/definitions/TapRuleActionType", + "description": "Type of actions that can be performed." + }, + "truncate": { + "type": "string", + "description": "Truncate. 0 indicates do not truncate.", + "minLength": 1 + }, + "isTimestampEnabled": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "The parameter to enable or disable the timestamp." + }, + "destinationId": { + "type": "string", + "format": "arm-id", + "description": "Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/neighborGroups" + }, + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration. This is used when Goto type is provided.", + "minLength": 1 + } + } + }, + "NetworkTapRuleListResult": { + "type": "object", + "description": "The response of a NetworkTapRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkTapRule items on this page", + "items": { + "$ref": "#/definitions/NetworkTapRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkTapRuleMatchCondition": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchCondition", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchCondition", + "description": "IP condition that needs to be matched." + }, + "encapsulationType": { + "type": "string", + "description": "Encapsulation Type that needs to be matched.", + "default": "None", + "enum": [ + "None", + "GTPv1" + ], + "x-ms-enum": { + "name": "EncapsulationType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None EncapsulationType" + }, + { + "name": "GTPv1", + "value": "GTPv1", + "description": "GTPv1 EncapsulationType" + } + ] + } + }, + "portCondition": { + "$ref": "#/definitions/PortCondition", + "description": "Defines the port condition that needs to be matched." + } + } + }, + "NetworkTapRuleMatchConditionPatch": { + "type": "object", + "description": "Defines the match condition that is supported to filter the traffic.", + "properties": { + "protocolTypes": { + "type": "array", + "description": "List of the protocols that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanMatchCondition": { + "$ref": "#/definitions/VlanMatchConditionPatch", + "description": "Vlan match condition that needs to be matched." + }, + "ipCondition": { + "$ref": "#/definitions/IpMatchConditionPatch", + "description": "IP condition that needs to be matched." + }, + "encapsulationType": { + "$ref": "#/definitions/EncapsulationType", + "description": "Encapsulation Type that needs to be matched." + }, + "portCondition": { + "$ref": "#/definitions/PortConditionPatch", + "description": "Defines the port condition that needs to be matched." + } + } + }, + "NetworkTapRuleMatchConfiguration": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration..", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchCondition" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleAction" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapRuleMatchConfigurationPatch": { + "type": "object", + "description": "Defines the match configuration that are supported to filter the traffic.", + "properties": { + "matchConfigurationName": { + "type": "string", + "description": "The name of the match configuration.", + "minLength": 1 + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence Number of the match configuration..", + "minimum": 1, + "maximum": 4294967295 + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "Type of IP Address. IPv4 or IPv6" + }, + "matchConditions": { + "type": "array", + "description": "List of the match conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchConditionPatch" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions that need to be performed for the matched conditions.", + "items": { + "$ref": "#/definitions/NetworkTapRuleActionPatch" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapRulePatch": { + "type": "object", + "description": "The NetworkTapRule resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/NetworkTapRulePatchProperties", + "description": "Network Tap Rule Patch properties." + } + } + }, + "NetworkTapRulePatchProperties": { + "type": "object", + "description": "Network Tap Rule Patch properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Network Tap Rule." + }, + "tapRulesUrl": { + "type": "string", + "format": "uri", + "description": "Network Tap Rules file URL." + }, + "globalNetworkTapRuleActions": { + "$ref": "#/definitions/GlobalNetworkTapRuleActionPatchProperties", + "description": "Global network tap rule actions" + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfigurationPatch" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkTapRuleProperties": { + "type": "object", + "description": "Network Tap Rule Properties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "configurationType": { + "$ref": "#/definitions/ConfigurationType", + "description": "Input method to configure Network Tap Rule." + }, + "tapRulesUrl": { + "type": "string", + "format": "uri", + "description": "Network Tap Rules file URL." + }, + "matchConfigurations": { + "type": "array", + "description": "List of match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/NetworkTapRuleMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "dynamicMatchConfigurations": { + "type": "array", + "description": "List of dynamic match configurations.", + "minItems": 1, + "items": { + "$ref": "#/definitions/CommonDynamicMatchConfiguration" + }, + "x-ms-identifiers": [] + }, + "networkTapId": { + "type": "string", + "description": "The ARM resource Id of the NetworkTap.", + "readOnly": true + }, + "pollingIntervalInSeconds": { + "type": "number", + "description": "Polling interval in seconds.", + "default": 30, + "enum": [ + 30, + 60, + 90, + 120 + ], + "x-ms-enum": { + "name": "PollingIntervalInSeconds", + "modelAsString": true, + "values": [ + { + "name": "Thirty", + "value": 30, + "description": "30 PollingIntervalInSeconds" + }, + { + "name": "sixty", + "value": 60, + "description": "60 PollingIntervalInSeconds" + }, + { + "name": "Ninety", + "value": 90, + "description": "90 PollingIntervalInSeconds" + }, + { + "name": "OneTwenty", + "value": 120, + "description": "120 PollingIntervalInSeconds" + } + ] + } + }, + "lastSyncedTime": { + "type": "string", + "format": "date-time", + "description": "The last sync timestamp.", + "readOnly": true + }, + "globalNetworkTapRuleActions": { + "$ref": "#/definitions/GlobalNetworkTapRuleActionProperties", + "description": "Global network tap rule actions" + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "configurationType" + ] + }, + "NetworkToNetworkInterconnect": { + "type": "object", + "description": "The Network To Network Interconnect resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkToNetworkInterconnectProperties", + "description": "The NetworkToNetworkInterconnect Properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "NetworkToNetworkInterconnectListResult": { + "type": "object", + "description": "The response of a NetworkToNetworkInterconnect list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkToNetworkInterconnect items on this page", + "items": { + "$ref": "#/definitions/NetworkToNetworkInterconnect" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkToNetworkInterconnectPatch": { + "type": "object", + "description": "The Network To Network Interconnect resource patch definition.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified resource ID for the resource. E.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the resource. E.g. 'Microsoft.Compute/virtualMachines' or 'Microsoft.Storage/storageAccounts'", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/NetworkToNetworkInterconnectPatchProperties", + "description": "Resource properties." + } + } + }, + "NetworkToNetworkInterconnectPatchProperties": { + "type": "object", + "description": "Network Tap Rule Patch properties.", + "properties": { + "layer2Configuration": { + "$ref": "#/definitions/Layer2ConfigurationPatch", + "description": "Common properties for Layer2Configuration." + }, + "optionBLayer3Configuration": { + "$ref": "#/definitions/OptionBLayer3ConfigurationPatchProperties", + "description": "Common properties for Layer3Configuration." + }, + "npbStaticRouteConfiguration": { + "$ref": "#/definitions/NpbStaticRouteConfigurationPatch", + "description": "NPB Static Route Configuration properties." + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/NniStaticRoutePatchConfiguration", + "description": "Static Route Configuration." + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicyInformationPatch", + "description": "Import Route Policy information." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicyInformationPatch", + "description": "Export Route Policy information" + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "microBfdState": { + "$ref": "#/definitions/MicroBfdState", + "description": "Micro BFD enabled/disabled state." + } + } + }, + "NetworkToNetworkInterconnectProperties": { + "type": "object", + "description": "Configuration used to setup CE-PE connectivity.", + "properties": { + "nniType": { + "type": "string", + "description": "Type of NNI used. Example: CE | NPB", + "default": "CE", + "enum": [ + "CE", + "NPB" + ], + "x-ms-enum": { + "name": "NniType", + "modelAsString": true, + "values": [ + { + "name": "CE", + "value": "CE", + "description": "NniType-CE(Customer Edge)." + }, + { + "name": "NPB", + "value": "NPB", + "description": "NniType-NPB(Network Packet Broker)." + } + ] + } + }, + "isManagementType": { + "type": "string", + "description": "Configuration to use NNI for Infrastructure Management. Example: True/False.", + "default": "True", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "IsManagementType", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "IsManagementType-True" + }, + { + "name": "False", + "value": "False", + "description": "IsManagementType-False" + } + ] + } + }, + "useOptionB": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "Based on this option layer3 parameters are mandatory. Example: True/False" + }, + "layer2Configuration": { + "$ref": "#/definitions/Layer2Configuration", + "description": "Common properties for Layer2 Configuration." + }, + "optionBLayer3Configuration": { + "$ref": "#/definitions/OptionBLayer3Configuration", + "description": "Common properties for Layer3Configuration." + }, + "npbStaticRouteConfiguration": { + "$ref": "#/definitions/NpbStaticRouteConfiguration", + "description": "NPB Static Route Configuration properties." + }, + "staticRouteConfiguration": { + "$ref": "#/definitions/NniStaticRouteConfiguration", + "description": "Static Route Configuration." + }, + "importRoutePolicy": { + "$ref": "#/definitions/ImportRoutePolicyInformation", + "description": "Import Route Policy information." + }, + "exportRoutePolicy": { + "$ref": "#/definitions/ExportRoutePolicyInformation", + "description": "Export Route Policy information" + }, + "egressAclId": { + "type": "string", + "format": "arm-id", + "description": "Egress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "ingressAclId": { + "type": "string", + "format": "arm-id", + "description": "Ingress Acl. ARM resource ID of Access Control Lists.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/accessControlLists" + } + ] + } + }, + "microBfdState": { + "$ref": "#/definitions/MicroBfdState", + "description": "Micro Bidirectional Forwarding Detection (BFD) enabled/disabled state." + }, + "conditionalDefaultRouteConfiguration": { + "$ref": "#/definitions/ConditionalDefaultRouteProperties", + "description": "Conditional Default Route Configuration properties." + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "useOptionB" + ] + }, + "NniBfdAdministrativeStateRequest": { + "type": "object", + "description": "NNI Bidirectional Forwarding Detection (BFD) Administrative State request.", + "properties": { + "routeType": { + "$ref": "#/definitions/RouteType", + "description": "Route Type. Choose either Static or OptionA." + }, + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "State. Select either enable or disable." + } + } + }, + "NniBfdAdministrativeStateResponse": { + "type": "object", + "description": "NNI Bidirectional Forwarding Detection (BFD) Administrative State response.", + "properties": { + "routeType": { + "$ref": "#/definitions/RouteType", + "description": "Route Type. Choose either Static or OptionA." + }, + "administrativeState": { + "$ref": "#/definitions/BfdAdministrativeState", + "description": "State. Select either enable or disable." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "NniBmpPatchProperties": { + "type": "object", + "description": "BGP Monitoring Protocol (BMP) patch properties.", + "properties": { + "configurationState": { + "$ref": "#/definitions/BmpConfigurationState", + "description": "(BGP Monitoring Protocol (BMP) configuration state." + } + } + }, + "NniBmpProperties": { + "type": "object", + "description": "BGP Monitoring Protocol (BMP) properties.", + "properties": { + "configurationState": { + "type": "string", + "description": "BGP Monitoring Protocol (BMP) Configuration State.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "BmpConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "BGP Monitoring Protocol (BMP) ConfigurationState - Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "BGP Monitoring Protocol (BMP) ConfigurationState - Disabled" + } + ] + } + } + }, + "required": [ + "configurationState" + ] + }, + "NniStaticRouteConfiguration": { + "type": "object", + "description": "Static Route Configuration properties for NNI.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "NniStaticRoutePatchConfiguration": { + "type": "object", + "description": "Static Route Configuration properties for NNI.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "Bidirectional Forwarding Detection (BFD) configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "NpbStaticRouteConfiguration": { + "type": "object", + "description": "NPB Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD Configuration properties." + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "NpbStaticRouteConfigurationPatch": { + "type": "object", + "description": "NPB Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD Configuration properties." + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "OptionBLayer3Configuration": { + "type": "object", + "description": "OptionB Layer3 Configuration properties.", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "ASN of PE devices for CE/PE connectivity.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "VLAN for CE/PE Layer 3 connectivity.Example : 501", + "minimum": 100, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "readOnly": true + }, + "peLoopbackIpAddress": { + "type": "array", + "description": "Provider Edge (PE) Loopback IP Address.", + "items": { + "type": "string" + } + }, + "bmpConfiguration": { + "$ref": "#/definitions/NniBmpProperties", + "description": "BGP Monitoring Protocol (BMP) Configuration." + }, + "prefixLimits": { + "type": "array", + "description": "OptionB Layer3 prefix limit configuration.", + "minItems": 1, + "items": { + "$ref": "#/definitions/OptionBLayer3PrefixLimitProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "peerASN", + "vlanId" + ] + }, + "OptionBLayer3ConfigurationPatchProperties": { + "type": "object", + "description": "Common properties for Layer3Configuration.", + "properties": { + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "ASN of PE devices for CE/PE connectivity.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "VLAN for CE/PE Layer 3 connectivity.Example : 501", + "minimum": 100, + "maximum": 4094 + }, + "fabricASN": { + "type": "integer", + "format": "int64", + "description": "ASN of CE devices for CE/PE connectivity.", + "readOnly": true + }, + "peLoopbackIpAddress": { + "type": "array", + "description": "Provider Edge (PE) Loopback IP Address.", + "items": { + "type": "string" + } + }, + "bmpConfiguration": { + "$ref": "#/definitions/NniBmpPatchProperties", + "description": "BGP Monitoring Protocol (BMP) Configuration." + }, + "prefixLimits": { + "type": "array", + "description": "OptionB Layer3 prefix limit configuration.", + "minItems": 1, + "items": { + "$ref": "#/definitions/OptionBLayer3PrefixLimitPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "OptionBLayer3PrefixLimitPatchProperties": { + "type": "object", + "description": "OptionB Layer3 prefix limit patch properties.", + "properties": { + "maximumRoutes": { + "type": "integer", + "format": "int32", + "description": "Maximum number of routes allowed." + } + } + }, + "OptionBLayer3PrefixLimitProperties": { + "type": "object", + "description": "OptionB Layer3 prefix limit properties.", + "properties": { + "maximumRoutes": { + "type": "integer", + "format": "int32", + "description": "Maximum number of routes allowed." + } + } + }, + "PeeringOption": { + "type": "string", + "description": "Peering option list.", + "enum": [ + "OptionA", + "OptionB" + ], + "x-ms-enum": { + "name": "PeeringOption", + "modelAsString": true, + "values": [ + { + "name": "OptionA", + "value": "OptionA", + "description": "PeeringOption-OptionA" + }, + { + "name": "OptionB", + "value": "OptionB", + "description": "PeeringOption-OptionB" + } + ] + } + }, + "PoliceRateConfigurationProperties": { + "type": "object", + "description": "Police rate configuration properties", + "properties": { + "bitRate": { + "$ref": "#/definitions/BitRate", + "description": "Rate limit in bits per second." + }, + "burstSize": { + "$ref": "#/definitions/BurstSize", + "description": "Burst size in packets." + } + } + }, + "PollingType": { + "type": "string", + "description": "Polling type.", + "enum": [ + "Pull", + "Push" + ], + "x-ms-enum": { + "name": "PollingType", + "modelAsString": true, + "values": [ + { + "name": "Pull", + "value": "Pull", + "description": "PollingType-Pull" + }, + { + "name": "Push", + "value": "Push", + "description": "PollingType-Push" + } + ] + } + }, + "PortCondition": { + "type": "object", + "description": "Port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + } + }, + "required": [ + "layer4Protocol" + ] + }, + "PortConditionPatch": { + "type": "object", + "description": "Port condition that needs to be matched.", + "properties": { + "portType": { + "$ref": "#/definitions/PortType", + "description": "Port type that needs to be matched." + }, + "layer4Protocol": { + "$ref": "#/definitions/Layer4Protocol", + "description": "Layer4 protocol type that needs to be matched." + }, + "ports": { + "type": "array", + "description": "List of the Ports that need to be matched.", + "items": { + "type": "string" + } + }, + "portGroupNames": { + "type": "array", + "description": "List of the port Group Names that need to be matched.", + "items": { + "type": "string" + } + } + } + }, + "PortGroupPatchProperties": { + "type": "object", + "description": "Port Group Properties", + "properties": { + "name": { + "type": "string", + "description": "The name of the port group.", + "minLength": 1 + }, + "ports": { + "type": "array", + "description": "List of the ports that need to be matched.", + "items": { + "type": "string" + } + } + } + }, + "PortGroupProperties": { + "type": "object", + "description": "Port Group properties.", + "properties": { + "name": { + "type": "string", + "description": "The name of the port group.", + "minLength": 1 + }, + "ports": { + "type": "array", + "description": "List of the ports that need to be matched.", + "items": { + "type": "string" + } + } + } + }, + "PortType": { + "type": "string", + "description": "Port type that needs to be matched.", + "enum": [ + "SourcePort", + "DestinationPort", + "Bidirectional" + ], + "x-ms-enum": { + "name": "PortType", + "modelAsString": true, + "values": [ + { + "name": "SourcePort", + "value": "SourcePort", + "description": "PortType SourcePort" + }, + { + "name": "DestinationPort", + "value": "DestinationPort", + "description": "PortType DestinationPort" + }, + { + "name": "Bidirectional", + "value": "Bidirectional", + "description": "PortType Bidirectional" + } + ] + } + }, + "PrefixLimitPatchProperties": { + "type": "object", + "description": "Prefix Limit Patch properties.", + "properties": { + "maximumRoutes": { + "type": "integer", + "format": "int32", + "description": "Maximum routes allowed." + }, + "threshold": { + "type": "integer", + "format": "int32", + "description": "Limit at which route prefixes a warning is generate." + }, + "idleTimeExpiry": { + "type": "integer", + "format": "int32", + "description": "Idle time expiry in seconds." + } + } + }, + "PrefixLimitProperties": { + "type": "object", + "description": "Prefix Limit properties.", + "properties": { + "maximumRoutes": { + "type": "integer", + "format": "int32", + "description": "Maximum routes allowed." + }, + "threshold": { + "type": "integer", + "format": "int32", + "description": "Limit at which route prefixes a warning is generate." + }, + "idleTimeExpiry": { + "type": "integer", + "format": "int32", + "description": "Idle Time Expiry in seconds, default is 60.", + "default": 60 + } + } + }, + "PrefixType": { + "type": "string", + "description": "IP Prefix Type that needs to be matched.", + "enum": [ + "Prefix", + "LongestPrefix" + ], + "x-ms-enum": { + "name": "PrefixType", + "modelAsString": true, + "values": [ + { + "name": "Prefix", + "value": "Prefix", + "description": "PrefixType Prefix" + }, + { + "name": "LongestPrefix", + "value": "LongestPrefix", + "description": "PrefixType LongestPrefix" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The current provisioning state.", + "enum": [ + "Accepted", + "Succeeded", + "Updating", + "Deleting", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Accepted", + "value": "Accepted", + "description": "Accepted Provisioning State" + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Succeeded Provisioning State" + }, + { + "name": "Updating", + "value": "Updating", + "description": "Updating Provisioning State" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deleting Provisioning State" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Provisioning State" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Canceled Provisioning State" + } + ] + }, + "readOnly": true + }, + "RebootProperties": { + "type": "object", + "description": "Reboot properties.", + "properties": { + "rebootType": { + "$ref": "#/definitions/RebootType", + "description": "Type of reboot to be performed. Example: GracefulRebootWithZTP" + } + } + }, + "RebootType": { + "type": "string", + "description": "Type of reboot to be performed. Example: GracefulRebootWithZTP", + "enum": [ + "GracefulRebootWithZTP", + "GracefulRebootWithoutZTP", + "UngracefulRebootWithZTP", + "UngracefulRebootWithoutZTP" + ], + "x-ms-enum": { + "name": "RebootType", + "modelAsString": true, + "values": [ + { + "name": "GracefulRebootWithZTP", + "value": "GracefulRebootWithZTP", + "description": "RebootType GracefulRebootWithZTP" + }, + { + "name": "GracefulRebootWithoutZTP", + "value": "GracefulRebootWithoutZTP", + "description": "RebootType GracefulRebootWithoutZTP" + }, + { + "name": "UngracefulRebootWithZTP", + "value": "UngracefulRebootWithZTP", + "description": "RebootType UngracefulRebootWithZTP" + }, + { + "name": "UngracefulRebootWithoutZTP", + "value": "UngracefulRebootWithoutZTP", + "description": "RebootType UngracefulRebootWithoutZTP" + } + ] + } + }, + "RedistributeConnectedSubnets": { + "type": "string", + "description": "Advertise Connected Subnets. Ex: \"True\" | \"False\".", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeConnectedSubnets", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeConnectedSubnets-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeConnectedSubnets-False" + } + ] + } + }, + "RedistributeStaticRoutes": { + "type": "string", + "description": "Advertise Static Routes. Ex: \"True\" | \"False\".", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "RedistributeStaticRoutes", + "modelAsString": true, + "values": [ + { + "name": "True", + "value": "True", + "description": "RedistributeStaticRoutes-True" + }, + { + "name": "False", + "value": "False", + "description": "RedistributeStaticRoutes-False" + } + ] + } + }, + "RoutePolicy": { + "type": "object", + "description": "The RoutePolicy resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/RoutePolicyProperties", + "description": "The RoutePolicy properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RoutePolicyActionType": { + "type": "string", + "description": "Action type. Example: Permit | Deny | Continue.", + "enum": [ + "Permit", + "Deny", + "Continue" + ], + "x-ms-enum": { + "name": "RoutePolicyActionType", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "RoutePolicyActionType-Permit" + }, + { + "name": "Deny", + "value": "Deny", + "description": "RoutePolicyActionType-Deny" + }, + { + "name": "Continue", + "value": "Continue", + "description": "RoutePolicyActionType-Continue" + } + ] + } + }, + "RoutePolicyConditionType": { + "type": "string", + "description": "Type of the condition used.", + "enum": [ + "Or", + "And" + ], + "x-ms-enum": { + "name": "RoutePolicyConditionType", + "modelAsString": true, + "values": [ + { + "name": "Or", + "value": "Or", + "description": "RoutePolicyConditionType-Or" + }, + { + "name": "And", + "value": "And", + "description": "RoutePolicyConditionType-And" + } + ] + } + }, + "RoutePolicyListResult": { + "type": "object", + "description": "The response of a RoutePolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RoutePolicy items on this page", + "items": { + "$ref": "#/definitions/RoutePolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RoutePolicyPatch": { + "type": "object", + "description": "The Route Policy patch resource definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/RoutePolicyPatchableProperties", + "description": "The RoutePolicy patchable properties." + } + } + }, + "RoutePolicyPatchableProperties": { + "type": "object", + "description": "Route Policy patchable properties.", + "properties": { + "defaultAction": { + "$ref": "#/definitions/CommunityActionTypes", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny." + }, + "statements": { + "type": "array", + "description": "Route Policy statements.", + "items": { + "$ref": "#/definitions/RoutePolicyStatementPatchProperties" + }, + "x-ms-identifiers": [] + } + } + }, + "RoutePolicyProperties": { + "type": "object", + "description": "RoutePolicyProperties defines the resource properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "defaultAction": { + "type": "string", + "description": "Default action that needs to be applied when no condition is matched. Example: Permit | Deny.", + "default": "Deny", + "enum": [ + "Permit", + "Deny" + ], + "x-ms-enum": { + "name": "CommunityActionTypes", + "modelAsString": true, + "values": [ + { + "name": "Permit", + "value": "Permit", + "description": "Permit Community Action Types" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Deny Community Action Types" + } + ] + } + }, + "statements": { + "type": "array", + "description": "Route Policy statements.", + "items": { + "$ref": "#/definitions/RoutePolicyStatementProperties" + }, + "x-ms-identifiers": [ + "sequenceNumber" + ] + }, + "networkFabricId": { + "type": "string", + "format": "arm-id", + "description": "Arm Resource ID of Network Fabric.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics" + } + ] + } + }, + "addressFamilyType": { + "type": "string", + "description": "AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy.", + "default": "IPv4", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "AddressFamilyType", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "AddressType-IPv4" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "AddressType-IPv6" + } + ] + } + }, + "lastOperation": { + "$ref": "#/definitions/LastOperationProperties", + "description": "Details of the last operation performed on the resource", + "readOnly": true + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Configuration state of the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + } + }, + "required": [ + "statements", + "networkFabricId" + ] + }, + "RoutePolicyStatementPatchProperties": { + "type": "object", + "description": "Route Policy Statement properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route.", + "minimum": 1, + "maximum": 4294967295 + }, + "condition": { + "$ref": "#/definitions/StatementConditionPatchProperties", + "description": "Route policy condition properties." + }, + "action": { + "$ref": "#/definitions/StatementActionPatchProperties", + "description": "Route policy action properties." + } + }, + "required": [ + "sequenceNumber", + "condition", + "action" + ] + }, + "RoutePolicyStatementProperties": { + "type": "object", + "description": "Route Policy Statement properties.", + "properties": { + "annotation": { + "type": "string", + "description": "Switch configuration description." + }, + "sequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence to insert to/delete from existing route.", + "minimum": 1, + "maximum": 4294967295 + }, + "condition": { + "$ref": "#/definitions/StatementConditionProperties", + "description": "Route policy condition properties." + }, + "action": { + "$ref": "#/definitions/StatementActionProperties", + "description": "Route policy action properties." + } + }, + "required": [ + "sequenceNumber", + "condition", + "action" + ] + }, + "RoutePrefixLimitPatchProperties": { + "type": "object", + "description": "VRP Limit patch configuration.", + "properties": { + "hardLimit": { + "type": "integer", + "format": "int32", + "description": "Hard limit for the routes." + }, + "threshold": { + "type": "integer", + "format": "int32", + "description": "Threshold for the routes." + } + } + }, + "RoutePrefixLimitProperties": { + "type": "object", + "description": "Layer3 Route prefix limit configuration.", + "properties": { + "hardLimit": { + "type": "integer", + "format": "int32", + "description": "Hard limit for the routes." + }, + "threshold": { + "type": "integer", + "format": "int32", + "description": "Threshold for the routes." + } + } + }, + "RouteTargetInformation": { + "type": "object", + "description": "Route Target Configuration.", + "properties": { + "importIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE.", + "items": { + "type": "string" + } + }, + "importIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes from CE.", + "items": { + "type": "string" + } + }, + "exportIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes into CE.", + "items": { + "type": "string" + } + }, + "exportIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE.", + "items": { + "type": "string" + } + } + } + }, + "RouteTargetPatchInformation": { + "type": "object", + "description": "Route Target Configuration.", + "properties": { + "importIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE.", + "items": { + "type": "string" + } + }, + "importIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes from CE.", + "items": { + "type": "string" + } + }, + "exportIpv4RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes into CE.", + "items": { + "type": "string" + } + }, + "exportIpv6RouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE.", + "items": { + "type": "string" + } + } + } + }, + "RouteType": { + "type": "string", + "description": "Route type to be used.", + "enum": [ + "Static", + "OptionA" + ], + "x-ms-enum": { + "name": "RouteType", + "modelAsString": true, + "values": [ + { + "name": "Static", + "value": "Static", + "description": "RouteType-Static" + }, + { + "name": "OptionA", + "value": "OptionA", + "description": "RouteType-OptionA" + } + ] + } + }, + "RuleCondition": { + "type": "string", + "description": "Specify Rule condition.", + "enum": [ + "And", + "Or" + ], + "x-ms-enum": { + "name": "RuleCondition", + "modelAsString": true, + "values": [ + { + "name": "And", + "value": "And", + "description": "And Rule-Condition." + }, + { + "name": "Or", + "value": "Or", + "description": "Or Rule-Condition." + } + ] + } + }, + "RuleProperties": { + "type": "object", + "description": "Rules for the InternetGateways", + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Specify action." + }, + "addressList": { + "type": "array", + "description": "List of Addresses to be allowed or denied.", + "items": { + "type": "string" + } + }, + "condition": { + "$ref": "#/definitions/RuleCondition", + "description": "Specify rule condition." + }, + "destinationAddressList": { + "type": "array", + "description": "List of Addresses to be allowed or denied.", + "items": { + "type": "string" + } + }, + "sourceAddressList": { + "type": "array", + "description": "List of source IPv4 and IPv6 address to be allowed or denied.", + "items": { + "type": "string" + } + }, + "headerAddressList": { + "type": "array", + "description": "List of header Name and source addresses associated with the header.", + "items": { + "$ref": "#/definitions/HeaderAddressProperties" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "action" + ] + }, + "SourceDestinationType": { + "type": "string", + "description": "IP Address type that needs to be matched.", + "enum": [ + "SourceIP", + "DestinationIP", + "Bidirectional" + ], + "x-ms-enum": { + "name": "SourceDestinationType", + "modelAsString": true, + "values": [ + { + "name": "SourceIP", + "value": "SourceIP", + "description": "SourceDestinationType SourceIP" + }, + { + "name": "DestinationIP", + "value": "DestinationIP", + "description": "SourceDestinationType DestinationIP" + }, + { + "name": "Bidirectional", + "value": "Bidirectional", + "description": "SourceDestinationType Bidirectional" + } + ] + } + }, + "StatementActionPatchProperties": { + "type": "object", + "description": "Route policy action properties", + "properties": { + "localPreference": { + "type": "integer", + "format": "int64", + "description": "Local Preference of the route policy.", + "minimum": 0, + "maximum": 4294967295 + }, + "actionType": { + "$ref": "#/definitions/RoutePolicyActionType", + "description": "Action type. Example: Permit | Deny | Continue." + }, + "ipCommunityProperties": { + "$ref": "#/definitions/ActionIpCommunityPatchProperties", + "description": "IP Community Properties." + }, + "ipExtendedCommunityProperties": { + "$ref": "#/definitions/ActionIpExtendedCommunityPatchProperties", + "description": "IP Extended Community Properties." + } + }, + "required": [ + "actionType" + ] + }, + "StatementActionProperties": { + "type": "object", + "description": "Route policy action properties.", + "properties": { + "localPreference": { + "type": "integer", + "format": "int64", + "description": "Local Preference of the route policy.", + "minimum": 0, + "maximum": 4294967295 + }, + "actionType": { + "$ref": "#/definitions/RoutePolicyActionType", + "description": "Action type. Example: Permit | Deny | Continue." + }, + "ipCommunityProperties": { + "$ref": "#/definitions/ActionIpCommunityProperties", + "description": "IP Community Properties." + }, + "ipExtendedCommunityProperties": { + "$ref": "#/definitions/ActionIpExtendedCommunityProperties", + "description": "IP Extended Community Properties." + } + }, + "required": [ + "actionType" + ] + }, + "StatementConditionPatchProperties": { + "type": "object", + "description": "Route policy statement condition properties.", + "properties": { + "ipCommunityIds": { + "type": "array", + "description": "List of IP Community resource IDs.", + "items": { + "type": "string" + } + }, + "ipExtendedCommunityIds": { + "type": "array", + "description": "List of IP Extended Community resource IDs.", + "items": { + "type": "string" + } + }, + "type": { + "$ref": "#/definitions/RoutePolicyConditionType", + "description": "Type of the condition used." + }, + "ipPrefixId": { + "type": "string", + "description": "Arm Resource Id of IpPrefix." + } + } + }, + "StatementConditionProperties": { + "type": "object", + "description": "Route policy statement condition properties.", + "properties": { + "ipCommunityIds": { + "type": "array", + "description": "List of IP Community resource IDs.", + "items": { + "type": "string" + } + }, + "ipExtendedCommunityIds": { + "type": "array", + "description": "List of IP Extended Community resource IDs.", + "items": { + "type": "string" + } + }, + "type": { + "type": "string", + "description": "Type of the condition used.", + "default": "Or", + "enum": [ + "Or", + "And" + ], + "x-ms-enum": { + "name": "RoutePolicyConditionType", + "modelAsString": true, + "values": [ + { + "name": "Or", + "value": "Or", + "description": "RoutePolicyConditionType-Or" + }, + { + "name": "And", + "value": "And", + "description": "RoutePolicyConditionType-And" + } + ] + } + }, + "ipPrefixId": { + "type": "string", + "description": "Arm Resource Id of IpPrefix." + } + } + }, + "StaticRouteConfiguration": { + "type": "object", + "description": "Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRouteProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "extension": { + "type": "string", + "description": "Extension. Example: NoExtension | NPB.", + "default": "NoExtension", + "enum": [ + "NoExtension", + "NPB" + ], + "x-ms-enum": { + "name": "Extension", + "modelAsString": true, + "values": [ + { + "name": "NoExtension", + "value": "NoExtension", + "description": "Extension-NoExtension" + }, + { + "name": "NPB", + "value": "NPB", + "description": "Extension-NPB" + } + ] + } + } + } + }, + "StaticRoutePatchConfiguration": { + "type": "object", + "description": "Static Route Configuration properties.", + "properties": { + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD configuration properties" + }, + "ipv4Routes": { + "type": "array", + "description": "List of IPv4 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + }, + "ipv6Routes": { + "type": "array", + "description": "List of IPv6 Routes.", + "items": { + "$ref": "#/definitions/StaticRoutePatchProperties" + }, + "x-ms-identifiers": [ + "prefix" + ] + } + } + }, + "StaticRoutePatchProperties": { + "type": "object", + "description": "Route Properties.", + "properties": { + "prefix": { + "type": "string", + "description": "Prefix of the route.", + "minLength": 1 + }, + "nextHop": { + "type": "array", + "description": "List of next hop addresses.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "prefix", + "nextHop" + ] + }, + "StaticRouteProperties": { + "type": "object", + "description": "Route Properties.", + "properties": { + "prefix": { + "type": "string", + "description": "Prefix of the route.", + "minLength": 1 + }, + "nextHop": { + "type": "array", + "description": "List of next hop addresses.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "prefix", + "nextHop" + ] + }, + "StaticRouteRoutePolicy": { + "type": "object", + "description": "Static Route - route policy properties.", + "properties": { + "exportRoutePolicy": { + "$ref": "#/definitions/L3ExportRoutePolicy", + "description": "Array of ARM Resource ID of the RoutePolicies." + } + } + }, + "StaticRouteRoutePolicyPatch": { + "type": "object", + "description": "Static Route - route policy properties.", + "properties": { + "exportRoutePolicy": { + "$ref": "#/definitions/L3ExportRoutePolicyPatch", + "description": "Array of ARM Resource ID of the RoutePolicies." + } + } + }, + "StationConfigurationState": { + "type": "string", + "description": "Station Configuration State.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StationConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "StationConfigurationState Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "StationConfigurationState Disabled" + } + ] + } + }, + "StationConnectionMode": { + "type": "string", + "description": "Station Connection Mode.", + "enum": [ + "Active", + "Passive" + ], + "x-ms-enum": { + "name": "StationConnectionMode", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "StationConnectionMode Active" + }, + { + "name": "Passive", + "value": "Passive", + "description": "StationConnectionMode Passive" + } + ] + } + }, + "StationConnectionPatchProperties": { + "type": "object", + "description": "Station Connection PATCH Properties.", + "properties": { + "keepaliveIdleTime": { + "type": "integer", + "format": "int32", + "description": "Connection keepalive idle time in seconds", + "minimum": 1, + "maximum": 3600 + }, + "probeInterval": { + "type": "integer", + "format": "int32", + "description": "Probe interval in seconds, default value is 60", + "minimum": 1, + "maximum": 3600 + }, + "probeCount": { + "type": "integer", + "format": "int32", + "description": "Probe count, default value is 10", + "minimum": 1, + "maximum": 100 + } + } + }, + "StationConnectionProperties": { + "type": "object", + "description": "Station Connection Properties.", + "properties": { + "keepaliveIdleTime": { + "type": "integer", + "format": "int32", + "description": "Connection keepalive idle time in seconds", + "default": 180, + "minimum": 1, + "maximum": 3600 + }, + "probeInterval": { + "type": "integer", + "format": "int32", + "description": "Probe interval in seconds, default value is 60", + "default": 60, + "minimum": 1, + "maximum": 3600 + }, + "probeCount": { + "type": "integer", + "format": "int32", + "description": "Probe count, default value is 10", + "default": 10, + "minimum": 1, + "maximum": 100 + } + } + }, + "StorageAccountConfiguration": { + "type": "object", + "description": "Storage account configuration.", + "properties": { + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Network Fabric storage account resource identifier.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageAccountIdentity": { + "$ref": "#/definitions/IdentitySelector", + "description": "The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned." + } + } + }, + "StorageAccountPatchConfiguration": { + "type": "object", + "description": "Storage account configuration.", + "properties": { + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Network Fabric storage account resource identifier.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageAccountIdentity": { + "$ref": "#/definitions/IdentitySelectorPatch", + "description": "The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned." + } + } + }, + "SupportedConnectorProperties": { + "type": "object", + "description": "Supported connector properties.", + "properties": { + "connectorType": { + "type": "string", + "description": "Type of connector used. Example: Optical." + }, + "maxSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Maximum speed of the connector in Mbps." + } + } + }, + "SupportedVersionProperties": { + "type": "object", + "description": "Supported version details of the network device.", + "properties": { + "version": { + "type": "string", + "description": "Operating system and firmware combined versions." + }, + "vendorOsVersion": { + "type": "string", + "description": "Operating system version." + }, + "vendorFirmwareVersion": { + "type": "string", + "description": "Firmware version." + }, + "isDefault": { + "$ref": "#/definitions/BooleanEnumProperty", + "description": "If true newly provisioned Fabric will use this device version by default to bootstrap the network devices for the first time." + } + } + }, + "TapRuleActionType": { + "type": "string", + "description": "Type of actions that can be performed.", + "enum": [ + "Drop", + "Count", + "Log", + "Replicate", + "Goto", + "Redirect", + "Mirror" + ], + "x-ms-enum": { + "name": "TapRuleActionType", + "modelAsString": true, + "values": [ + { + "name": "Drop", + "value": "Drop", + "description": "TapRuleActionType-Drop" + }, + { + "name": "Count", + "value": "Count", + "description": "TapRuleActionType-Count" + }, + { + "name": "Log", + "value": "Log", + "description": "TapRuleActionType-Log" + }, + { + "name": "Replicate", + "value": "Replicate", + "description": "TapRuleActionType-Replicate" + }, + { + "name": "Goto", + "value": "Goto", + "description": "TapRuleActionType-Goto" + }, + { + "name": "Redirect", + "value": "Redirect", + "description": "TapRuleActionType-Redirect" + }, + { + "name": "Mirror", + "value": "Mirror", + "description": "TapRuleActionType-Mirror" + } + ] + } + }, + "TerminalServerConfiguration": { + "type": "object", + "description": "Network and credentials configuration currently applied to terminal server.", + "properties": { + "username": { + "type": "string", + "description": "Username for the terminal server connection.", + "minLength": 1 + }, + "password": { + "type": "string", + "format": "password", + "description": "Password for the terminal server connection.", + "minLength": 1, + "x-ms-secret": true + }, + "serialNumber": { + "type": "string", + "description": "Serial Number of Terminal server.", + "minLength": 1 + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + }, + "networkDeviceId": { + "type": "string", + "description": "ARM Resource ID used for the NetworkDevice.", + "readOnly": true + } + }, + "required": [ + "username", + "password", + "primaryIpv4Prefix", + "secondaryIpv4Prefix" + ] + }, + "TerminalServerPatchConfiguration": { + "type": "object", + "description": "Network and credentials configuration already applied to terminal server.", + "properties": { + "username": { + "type": "string", + "description": "Username for the terminal server connection.", + "minLength": 1 + }, + "password": { + "type": "string", + "format": "password", + "description": "Password for the terminal server connection.", + "minLength": 1, + "x-ms-secret": true + }, + "serialNumber": { + "type": "string", + "description": "Serial Number of Terminal server.", + "minLength": 1 + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + } + } + }, + "UniqueRouteDistinguisherConfigurationState": { + "type": "string", + "description": "Unique Route Distinguisher Configuration State.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "UniqueRouteDistinguisherConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "UniqueRouteDistinguisherConfigurationState Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UniqueRouteDistinguisherConfigurationState Disabled" + } + ] + } + }, + "UniqueRouteDistinguisherPatchProperties": { + "type": "object", + "description": "Unique Route Distinguisher configuration properties.", + "properties": { + "uniqueRdConfigurationState": { + "$ref": "#/definitions/UniqueRouteDistinguisherConfigurationState", + "description": "Unique Route Distinguisher configuration state. Default is Enabled." + }, + "nniDerivedUniqueRdConfigurationState": { + "$ref": "#/definitions/NNIDerivedUniqueRouteDistinguisherConfigurationState", + "description": "NNI derived unique Route Distinguisher state. Default is Disabled." + } + } + }, + "UniqueRouteDistinguisherProperties": { + "type": "object", + "description": "Unique Route Distinguisher properties.", + "properties": { + "uniqueRdConfigurationState": { + "type": "string", + "description": "Unique Route Distinguisher configuration state. Default is Enabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "UniqueRouteDistinguisherConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "UniqueRouteDistinguisherConfigurationState Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "UniqueRouteDistinguisherConfigurationState Disabled" + } + ] + } + }, + "uniqueRds": { + "type": "array", + "description": "List of Unique Route Distinguisher addresses.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "nniDerivedUniqueRdConfigurationState": { + "type": "string", + "description": "NNI derived unique Route Distinguisher state. Default is Disabled.", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "NNIDerivedUniqueRouteDistinguisherConfigurationState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "NNI derived unique route distinguisher configuration state Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "NNI derived unique route distinguisher configuration state Disabled" + } + ] + } + } + } + }, + "UpdateAdministrativeState": { + "type": "object", + "description": "Update administrative state on list of resources.", + "properties": { + "resourceIds": { + "type": "array", + "description": "Network Fabrics or Network Rack resource Id.", + "items": { + "type": "string" + } + }, + "state": { + "$ref": "#/definitions/EnableDisableState", + "description": "Administrative state." + } + } + }, + "UpdateDeviceAdministrativeState": { + "type": "object", + "description": "Update the administrative state on list of resources.", + "properties": { + "resourceIds": { + "type": "array", + "description": "Network Fabrics or Network Rack resource Id.", + "items": { + "type": "string" + } + }, + "state": { + "$ref": "#/definitions/DeviceAdministrativeState", + "description": "Administrative state." + } + } + }, + "UpdateVersion": { + "type": "object", + "description": "Update version properties.", + "properties": { + "version": { + "type": "string", + "description": "Specify the version." + } + } + }, + "UpgradeNetworkFabricProperties": { + "type": "object", + "description": "Model used for Upgrade Network Fabric Properties", + "properties": { + "version": { + "type": "string", + "description": "Specify the version." + }, + "action": { + "$ref": "#/definitions/NetworkFabricUpgradeAction", + "description": "Action to be performed while upgrading the fabric." + } + } + }, + "V4OverV6BgpSessionState": { + "type": "string", + "description": "V4 over V6 BGP session state", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "V4OverV6BgpSessionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "V4OverV6BgpSessionState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "V4OverV6BgpSessionState-Disabled" + } + ] + } + }, + "V6OverV4BgpSessionState": { + "type": "string", + "description": "V6 over V4 BGP session state", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "V6OverV4BgpSessionState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "V6OverV4BgpSessionState-Enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "V6OverV4BgpSessionState-Disabled" + } + ] + } + }, + "ValidateAction": { + "type": "string", + "description": "Validate action that to be performed", + "enum": [ + "Cabling", + "Configuration", + "Connectivity" + ], + "x-ms-enum": { + "name": "ValidateAction", + "modelAsString": true, + "values": [ + { + "name": "Cabling", + "value": "Cabling", + "description": "ValidateAction-Cabling" + }, + { + "name": "Configuration", + "value": "Configuration", + "description": "ValidateAction-Configuration" + }, + { + "name": "Connectivity", + "value": "Connectivity", + "description": "ValidateAction-Connectivity" + } + ] + } + }, + "ValidateConfigurationProperties": { + "type": "object", + "description": "Validation configuration properties.", + "properties": { + "validateAction": { + "$ref": "#/definitions/ValidateAction", + "description": "Validate action that to be performed" + } + } + }, + "ValidateConfigurationResponse": { + "type": "object", + "description": "The response of the action validate configuration.", + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + }, + "configurationState": { + "$ref": "#/definitions/ConfigurationState", + "description": "Gets the configuration state.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "URL for the details of the response." + } + } + }, + "ViewDeviceConfigurationResponse": { + "type": "object", + "description": "View Device Configuration Response.", + "properties": { + "deviceConfigurationUrl": { + "type": "string", + "description": "Storage URL to the device configuration file." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail", + "description": "The error object." + } + } + }, + "VlanGroupPatchProperties": { + "type": "object", + "description": "Vlan group properties.", + "properties": { + "name": { + "type": "string", + "description": "Vlan group name.", + "minLength": 1 + }, + "vlans": { + "type": "array", + "description": "List of vlans.", + "items": { + "type": "string" + } + } + } + }, + "VlanGroupProperties": { + "type": "object", + "description": "Vlan group properties.", + "properties": { + "name": { + "type": "string", + "description": "Vlan group name.", + "minLength": 1 + }, + "vlans": { + "type": "array", + "description": "List of vlans.", + "items": { + "type": "string" + } + } + } + }, + "VlanMatchCondition": { + "type": "object", + "description": "The vlan match conditions that need to be matched.", + "properties": { + "vlans": { + "type": "array", + "description": "List of vlans that need to be matched. Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "innerVlans": { + "type": "array", + "description": "List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanGroupNames": { + "type": "array", + "description": "List of vlan group names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "VlanMatchConditionPatch": { + "type": "object", + "description": "The vlan match conditions that need to be matched.", + "properties": { + "vlans": { + "type": "array", + "description": "List of vlans that need to be matched. Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "innerVlans": { + "type": "array", + "description": "List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "vlanGroupNames": { + "type": "array", + "description": "List of vlan group names that need to be matched.", + "minItems": 1, + "items": { + "type": "string" + } + } + } + }, + "VpnConfigurationPatchableProperties": { + "type": "object", + "description": "Network and credential configuration currently applied on terminal server.", + "properties": { + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network To Network Interconnect.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/VpnOptionBPatchProperties", + "description": "option B properties" + }, + "optionAProperties": { + "$ref": "#/definitions/VpnOptionAPatchProperties", + "description": "option A properties" + } + } + }, + "VpnConfigurationProperties": { + "type": "object", + "description": "Network and credential configuration currently applied on terminal server.", + "properties": { + "networkToNetworkInterconnectId": { + "type": "string", + "format": "arm-id", + "description": "ARM Resource ID of the Network To Network Interconnect.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedNetworkFabric/networkFabrics/networkToNetworkInterconnects" + } + ] + } + }, + "administrativeState": { + "$ref": "#/definitions/AdministrativeState", + "description": "Administrative state of the resource.", + "readOnly": true + }, + "peeringOption": { + "$ref": "#/definitions/PeeringOption", + "description": "Peering option list." + }, + "optionBProperties": { + "$ref": "#/definitions/VpnOptionBProperties", + "description": "option B properties" + }, + "optionAProperties": { + "$ref": "#/definitions/VpnOptionAProperties", + "description": "option A properties" + } + }, + "required": [ + "peeringOption" + ] + }, + "VpnOptionAPatchProperties": { + "type": "object", + "description": "Peering optionA properties", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan Id.Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdPatchConfiguration", + "description": "BFD Configuration properties." + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + } + } + }, + "VpnOptionAProperties": { + "type": "object", + "description": "option A properties", + "properties": { + "mtu": { + "type": "integer", + "format": "int32", + "description": "MTU to use for option A peering.", + "default": 1500, + "minimum": 64, + "maximum": 9200 + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "Vlan Id.Example : 501", + "minimum": 501, + "maximum": 4094 + }, + "peerASN": { + "type": "integer", + "format": "int64", + "description": "Peer ASN number.Example : 28", + "minimum": 1, + "maximum": 4294967295 + }, + "bfdConfiguration": { + "$ref": "#/definitions/BfdConfiguration", + "description": "BFD Configuration properties." + }, + "primaryIpv4Prefix": { + "type": "string", + "description": "IPv4 Address Prefix." + }, + "primaryIpv6Prefix": { + "type": "string", + "description": "IPv6 Address Prefix." + }, + "secondaryIpv4Prefix": { + "type": "string", + "description": "Secondary IPv4 Address Prefix." + }, + "secondaryIpv6Prefix": { + "type": "string", + "description": "Secondary IPv6 Address Prefix." + } + }, + "required": [ + "vlanId", + "peerASN" + ] + }, + "VpnOptionBPatchProperties": { + "type": "object", + "description": "Option B configuration to be used for Management VPN.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetPatchInformation", + "description": "Route Targets to be applied." + } + } + }, + "VpnOptionBProperties": { + "type": "object", + "description": "Option B configuration to be used for Management VPN.", + "properties": { + "importRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for incoming routes into CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "exportRouteTargets": { + "type": "array", + "description": "Route Targets to be applied for outgoing routes from CE. This is for backward compatibility.", + "items": { + "type": "string" + } + }, + "routeTargets": { + "$ref": "#/definitions/RouteTargetInformation", + "description": "Route Targets to be applied." + } + } + }, + "WellKnownCommunities": { + "type": "string", + "description": "`Internet` - Advertise routes to internet community.\n`LocalAS` - Advertise routes to only localAS peers.\n`NoAdvertise` - Don't advertise routes to any peer.\n`NoExport` - Don't export to next AS.\n`GShut` - Graceful Shutdown (GSHUT) withdraw routes before terminating BGP connection.", + "enum": [ + "Internet", + "LocalAS", + "NoAdvertise", + "NoExport", + "GShut" + ], + "x-ms-enum": { + "name": "WellKnownCommunities", + "modelAsString": true, + "values": [ + { + "name": "Internet", + "value": "Internet", + "description": "WellKnownCommunities-Internet" + }, + { + "name": "LocalAS", + "value": "LocalAS", + "description": "WellKnownCommunities-LocalAS" + }, + { + "name": "NoAdvertise", + "value": "NoAdvertise", + "description": "WellKnownCommunities-NoAdvertise" + }, + { + "name": "NoExport", + "value": "NoExport", + "description": "WellKnownCommunities-NoExport" + }, + { + "name": "GShut", + "value": "GShut", + "description": "WellKnownCommunities-GShut" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/managednetworkfabric/resource-manager/readme.md b/specification/managednetworkfabric/resource-manager/readme.md index 943077a83f16..6428e4fa61a6 100644 --- a/specification/managednetworkfabric/resource-manager/readme.md +++ b/specification/managednetworkfabric/resource-manager/readme.md @@ -24,12 +24,47 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the Managed Network Fabric. -``` yaml +```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2023-06-15 +tag: package-2024-06-15-preview ``` +### Tag: package-2024-06-15-preview + +These settings apply only when `--tag=package-2024-06-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-06-15-preview' +input-file: + - Microsoft.ManagedNetworkFabric/preview/2024-06-15-preview/managednetworkfabric.json +suppressions: + - code: ArmResourcePropertiesBag + reason: Suppressing errors to conform to the existing published API + from: managednetworkfabric.json + where: $.definitions["InternetGateway"] + - code: ArmResourcePropertiesBag + from: managednetworkfabric.json + reason: Suppressing errors to conform to the existing published API + where: $.definitions["NetworkFabricSku"] +``` + +### Tag: package-2024-02-15-preview + +These settings apply only when `--tag=package-2024-02-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-02-15-preview' +input-file: + - Microsoft.ManagedNetworkFabric/preview/2024-02-15-preview/managednetworkfabric.json +suppressions: + - code: ArmResourcePropertiesBag + reason: Suppressing errors to conform to the existing published API + from: managednetworkfabric.json + where: $.definitions["InternetGateway"] + - code: ArmResourcePropertiesBag + from: managednetworkfabric.json + reason: Suppressing errors to conform to the existing published API + where: $.definitions["NetworkFabricSku"] +``` ### Tag: package-2023-06-15 @@ -59,11 +94,12 @@ input-file: - Microsoft.ManagedNetworkFabric/stable/2023-06-15/RoutePolicies.json - Microsoft.ManagedNetworkFabric/stable/2023-06-15/common.json ``` + ### Tag: package-2023-02-01-preview These settings apply only when `--tag=package-2023-02-01-preview` is specified on the command line. -``` yaml $(tag) == 'package-2023-02-01-preview' +```yaml $(tag) == 'package-2023-02-01-preview' input-file: - Microsoft.ManagedNetworkFabric/preview/2023-02-01-preview/AccessControlLists.json - Microsoft.ManagedNetworkFabric/preview/2023-02-01-preview/IpCommunities.json @@ -92,7 +128,7 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -``` yaml $(swagger-to-sdk) +```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-java @@ -122,4 +158,4 @@ See configuration in [readme.csharp.md](./readme.csharp.md) ## Java -See configuration in [readme.java.md](./readme.java.md) \ No newline at end of file +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/managednetworkfabric/resource-manager/readme.python.md b/specification/managednetworkfabric/resource-manager/readme.python.md index 5ad89ffb3aa0..d522d3841768 100644 --- a/specification/managednetworkfabric/resource-manager/readme.python.md +++ b/specification/managednetworkfabric/resource-manager/readme.python.md @@ -3,7 +3,7 @@ These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(python) +```yaml $(python) title: ManagedNetworkFabricMgmtClient azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION @@ -13,7 +13,7 @@ package-version: 1.0.0b1 clear-output-folder: true ``` -``` yaml $(python) +```yaml $(python) no-namespace-folders: true output-folder: $(python-sdks-folder)/managednetworkfabric/azure-mgmt-managednetworkfabric/azure/mgmt/managednetworkfabric ``` diff --git a/specification/managednetworkfabric/resource-manager/readme.typescript.md b/specification/managednetworkfabric/resource-manager/readme.typescript.md index d641d50741fb..4fa3b0e21989 100644 --- a/specification/managednetworkfabric/resource-manager/readme.typescript.md +++ b/specification/managednetworkfabric/resource-manager/readme.typescript.md @@ -3,7 +3,7 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. -``` yaml $(typescript) +```yaml $(typescript) typescript: azure-arm: true package-name: "@azure/arm-managednetworkfabric" diff --git a/specification/maps/data-plane/Search/stable/1.0/search.json b/specification/maps/data-plane/Search/stable/1.0/search.json index 05a7648a5c2d..def886770211 100644 --- a/specification/maps/data-plane/Search/stable/1.0/search.json +++ b/specification/maps/data-plane/Search/stable/1.0/search.json @@ -2490,7 +2490,8 @@ "readOnly": true }, "boundingBox": { - "$ref": "#/definitions/BoundingBoxCompassNotation" + "$ref": "#/definitions/BoundingBoxCompassNotation", + "description": "Defines the bounding box for the location. This property is only returned by the Search Address Reverse APIs. All other Search APIs return the `viewport` property of the `SearchAddressResultItem` object." } } }, diff --git a/specification/marketplacecatalog/Products/models.tsp b/specification/marketplacecatalog/Products/models.tsp index 57e1b4bf6d72..4f0694a99d3b 100644 --- a/specification/marketplacecatalog/Products/models.tsp +++ b/specification/marketplacecatalog/Products/models.tsp @@ -190,7 +190,7 @@ model ProductBase { @doc("Unique product identifier") uniqueProductId: string; - @doc("Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels") + @doc("Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels") productType: string; @doc("Product sub type") @@ -874,7 +874,7 @@ model ListingSkusMarketParameter { @doc("Parameters for language selection") model LanguageParameter { @query - @doc("Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. Default is \"en\"") + @doc("Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Default is \"en\"") language?: string = "en"; } diff --git a/specification/marketplacecatalog/Search/models.tsp b/specification/marketplacecatalog/Search/models.tsp index 47421c527f1d..2e0bcf8ad970 100644 --- a/specification/marketplacecatalog/Search/models.tsp +++ b/specification/marketplacecatalog/Search/models.tsp @@ -30,7 +30,7 @@ model ProductSummary { @doc("Unique product identifier") uniqueProductId: string; - @doc("Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels") + @doc("Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels") productType: string; @doc("Product sub type") @@ -534,7 +534,7 @@ union SuggestionsFieldName { @doc("Parameters for language selection") model LanguageParameter { @query - @doc("Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'") + @doc("Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'") language: string; } @@ -611,7 +611,7 @@ model PricingTypesParameter { @doc("Parameters for Product Types filter") model ProductTypesParameter { @query - @doc("Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored.\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.") + @doc("Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. Possible values include, but are not limited to:\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.") productTypes?: ProductType[]; } diff --git a/specification/marketplacecatalog/data-plane/Products/stable/2025-05-01/openapi.json b/specification/marketplacecatalog/data-plane/Products/stable/2025-05-01/openapi.json index 710bf9ba8917..3e22f5e24b16 100644 --- a/specification/marketplacecatalog/data-plane/Products/stable/2025-05-01/openapi.json +++ b/specification/marketplacecatalog/data-plane/Products/stable/2025-05-01/openapi.json @@ -1071,7 +1071,7 @@ }, "productType": { "type": "string", - "description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels" + "description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels" }, "productSubType": { "type": "string", @@ -1412,7 +1412,7 @@ }, "productType": { "type": "string", - "description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels" + "description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels" }, "productSubType": { "type": "string", @@ -1958,7 +1958,7 @@ "LanguageParameter": { "name": "language", "in": "query", - "description": "Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'. Default is \"en\"", + "description": "Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Default is \"en\"", "required": false, "type": "string", "default": "en", diff --git a/specification/marketplacecatalog/data-plane/Search/stable/2025-05-01/openapi.json b/specification/marketplacecatalog/data-plane/Search/stable/2025-05-01/openapi.json index 2e9605e07775..77e7145ea642 100644 --- a/specification/marketplacecatalog/data-plane/Search/stable/2025-05-01/openapi.json +++ b/specification/marketplacecatalog/data-plane/Search/stable/2025-05-01/openapi.json @@ -614,7 +614,7 @@ }, "productType": { "type": "string", - "description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog.\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels" + "description": "Specifies the primary deployment model and hosting architecture for the marketplace product stored in the Marketplace Catalog. Possible values include, but are not limited to:\n- `None` - Unspecified product type, typically used for products without a defined deployment model\n- `ManagedApplication` - Azure Managed Applications that deploy and manage resources in customer subscriptions\n- `VirtualMachine` - Pre-configured virtual machine images deployable to Azure compute infrastructure\n- `AzureApplication` - Native Azure applications leveraging platform services and APIs\n- `Container` - Containerized applications deployed through Azure Container Instances or similar services\n- `SaaS` - Software as a Service solutions hosted and managed by the publisher\n- `SolutionTemplate` - Azure Resource Manager templates that provision multiple Azure resources\n- `IotEdgeModules` - Modules designed for deployment to Azure IoT Edge runtime environments\n- `ManagedServices` - Fully managed services where the publisher handles infrastructure and operations\n- `ContainerApps` - Applications built for Azure Container Apps serverless container platform\n- `DynamicsOps` - Microsoft Dynamics 365 Finance and Operations applications and extensions\n- `DynamicsCE` - Microsoft Dynamics 365 Customer Engagement applications and customizations\n- `DynamicsBC` - Microsoft Dynamics 365 Business Central applications and add-ons\n- `PowerBI` - Microsoft Power BI reports, dashboards, and data visualization components\n- `ConsultingServices` - Professional services offerings including implementation and advisory services\n- `CosellOnly` - Products available exclusively through Microsoft co-sell partner programs\n- `CoreVirtualMachine` - Core virtual machine offerings with baseline Azure compute capabilities\n- `PowerBIVisuals` - Custom visualizations for Microsoft Power BI reporting platform\n- `Office365` - Microsoft 365 and Office 365 applications, add-ins, and integrations\n- `AADApps` - Azure Active Directory integrated applications supporting organizational identity\n- `AzureServices` - Native Azure platform services and resource providers\n- `AppService` - Web applications hosted on Azure App Service platform\n- `LogAnalytics` - Azure Monitor Log Analytics solutions and workspace configurations\n- `MicrosoftProduct` - First-party Microsoft products available through marketplace channels" }, "productSubType": { "type": "string", @@ -1342,7 +1342,7 @@ "LanguageParameter": { "name": "language", "in": "query", - "description": "Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,id,zh-hans,zh-hant'", + "description": "Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'", "required": true, "type": "string", "x-ms-parameter-location": "method" @@ -1427,7 +1427,7 @@ "ProductTypesParameter": { "name": "productTypes", "in": "query", - "description": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored.\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.", + "description": "Products that contains any of the given product types, Such as 'VirtualMachine'. If no value provided, this filter is ignored. Possible values include, but are not limited to:\n- `AADApps`: Azure Active Directory Apps.\n- `AzureApplication`: Azure Application.\n- `AzureServices`: Azure Services.\n- `ConsultingServices`: Consulting Services.\n- `Container`: Container.\n- `ContainerApps`: Container Apps.\n- `CoreVirtualMachine`: Core Virtual Machine.\n- `CosellOnly`: Cosell Only.\n- `DevService`: Dev Service.\n- `DynamicsBC`: Dynamics BC.\n- `DynamicsCE`: Dynamics CE.\n- `DynamicsOps`: Dynamics Ops.\n- `IotEdgeModules`: Iot Edge Modules.\n- `ManagedApplication`: Managed Application.\n- `ManagedServices`: Managed Services.\n- `Office365`: Office365.\n- `PowerBI`: PowerBI.\n- `PowerBIVisuals`: PowerBI Visuals.\n- `SaaS`: SaaS.\n- `SolutionTemplate`: Solution Template.\n- `VirtualMachine`: Virtual Machine.\n- `VisualStudioExtension`: Visual Studio Extension.\n- `AppService`: App Service.\n- `LogAnalytics`: Log Analytics.", "required": false, "type": "array", "items": { diff --git a/specification/migrate/Waves.Management/ApiVersions.tsp b/specification/migrate/Waves.Management/ApiVersions.tsp new file mode 100644 index 000000000000..4e323bd1e746 --- /dev/null +++ b/specification/migrate/Waves.Management/ApiVersions.tsp @@ -0,0 +1,13 @@ +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Versioning; +using Azure.ResourceManager; + +namespace Microsoft.Migrate; + +@doc("Common API Versions for Migrate Project Tracked Resource.") +enum ApiVersions { + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v6) + @doc("2025-03-30-preview API Version.") + v2025_03_30_preview: "2025-03-30-preview", +} diff --git a/specification/migrate/Waves.Management/Common/ArmModels/AzureResourceProperties.tsp b/specification/migrate/Waves.Management/Common/ArmModels/AzureResourceProperties.tsp new file mode 100644 index 000000000000..9692bc77a4fd --- /dev/null +++ b/specification/migrate/Waves.Management/Common/ArmModels/AzureResourceProperties.tsp @@ -0,0 +1,10 @@ +import "../Enums/Enums.tsp"; + +namespace Microsoft.Migrate; + +@doc("Common properties for all azure tracked and proxy resources.") +model AzureResourceProperties { + @doc("The status of the last operation.") + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} diff --git a/specification/migrate/Waves.Management/Common/ArmModels/MigrateProject.tsp b/specification/migrate/Waves.Management/Common/ArmModels/MigrateProject.tsp new file mode 100644 index 000000000000..b69ed7648122 --- /dev/null +++ b/specification/migrate/Waves.Management/Common/ArmModels/MigrateProject.tsp @@ -0,0 +1,181 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace Microsoft.Migrate; + +@doc("A Migrate project Resource.") +model MigrateProject is TrackedResource { + @doc("Migrate Project Name") + @segment("migrateProjects") + @key("projectName") + @path + @pattern("^[^<>&:\\?/#]{1,260}$") + name: string; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "Migrate Project is already GA and does not have provisioning state" +@doc("Properties of a migrate project.") +model MigrateProjectProperties { + @doc("Register tools inside project.") + @visibility(Lifecycle.Read) + registeredTools?: Items[]; + + @doc("Service endpoint.") + serviceEndpoint?: string; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Migrate Project is already GA and has these properties as record" + @doc("Project summary.") + @visibility(Lifecycle.Read) + summary?: Record; + + @doc("Last summary refresh time.") + @visibility(Lifecycle.Read) + lastSummaryRefreshedTime?: utcDateTime; + + @doc("Refresh summary state.") + @visibility(Lifecycle.Read) + refreshSummaryState?: RefreshSummaryState; + + @doc("Utility storage account id.") + utilityStorageAccountId?: string; + + @doc("Gets or sets the state of public network access.") + publicNetworkAccess?: PublicNetworkAccess; + + @doc("Gets the private endpoint connections.") + @visibility(Lifecycle.Read) + privateEndpointConnections?: PrivateEndpointConnection[]; +} + +@doc("Project summary.") +model ProjectSummary { + @doc("Instance type.") + @visibility(Lifecycle.Read) + instanceType?: string; + + @doc("Refresh summary state.") + refreshSummaryState?: RefreshSummaryState; + + @doc("Last summary refresh time.") + lastSummaryRefreshedTime?: utcDateTime; + + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Migrate Project is already GA and has these properties as record" + @doc("Extended summary.") + extendedSummary?: Record; +} + +@doc("Refresh summary state.") +union RefreshSummaryState { + string, + + @doc("Started State") + Started: "Started", + + @doc("InProgress State") + InProgress: "InProgress", + + @doc("Completed State") + Completed: "Completed", + + @doc("Failed State") + Failed: "Failed", +} + +@doc("Items Enum") +union Items { + string, + + @doc("Server Discovery Item") + ServerDiscovery: "ServerDiscovery", + + @doc("Server Assessment Item") + ServerAssessment: "ServerAssessment", + + @doc("Server Migration Item") + ServerMigration: "ServerMigration", + + @doc("Cloudamize Item") + Cloudamize: "Cloudamize", + + @doc("Turbonomic Item") + Turbonomic: "Turbonomic", + + @doc("Zerto Item") + Zerto: "Zerto", + + @doc("CorentTech Item") + CorentTech: "CorentTech", + + @doc("ServerAssessmentV1") + ServerAssessmentV1: "ServerAssessmentV1", + + @doc("ServerMigration_Replication") + ServerMigration_Replication: "ServerMigration_Replication", + + @doc("Carbonite Item") + Carbonite: "Carbonite", + + @doc("DataMigrationAssistant Item") + DataMigrationAssistant: "DataMigrationAssistant", + + @doc("DatabaseMigrationService Item") + DatabaseMigrationService: "DatabaseMigrationService", + + @doc("Device42 Item") + Device42: "Device42", + + @doc("JetStream Item") + JetStream: "JetStream", + + @doc("RackWare Item") + RackWare: "RackWare", + + @doc("UnifyCloud Item") + UnifyCloud: "UnifyCloud", + + @doc("Flexera Item") + Flexera: "Flexera", + + @doc("ServerDiscovery_Import Item.") + ServerDiscovery_Import: "ServerDiscovery_Import", + + @doc("Lakeside Item") + Lakeside: "Lakeside", + + @doc("AppServiceMigrationAssistant Item") + AppServiceMigrationAssistant: "AppServiceMigrationAssistant", + + @doc("Movere Item") + Movere: "Movere", + + @doc("CloudSphere Item") + CloudSphere: "CloudSphere", + + @doc("Modernization Item") + Modernization: "Modernization", + + @doc("ServerMigration_DataReplication Item") + ServerMigration_DataReplication: "ServerMigration_DataReplication", + + @doc("Unknown Item") + Unknown: "Unknown", +} + +@doc("Gets or sets the state of public network access.") +union PublicNetworkAccess { + string, + + @doc("NotSpecified Network Access") + NotSpecified: "NotSpecified", + + @doc("Enabled Network Access") + Enabled: "Enabled", + + @doc("Disabled Network Access") + Disabled: "Disabled", +} diff --git a/specification/migrate/Waves.Management/Common/Enums/Enums.tsp b/specification/migrate/Waves.Management/Common/Enums/Enums.tsp new file mode 100644 index 000000000000..098776163a5d --- /dev/null +++ b/specification/migrate/Waves.Management/Common/Enums/Enums.tsp @@ -0,0 +1,30 @@ +using Azure.ResourceManager; +using TypeSpec.Versioning; + +namespace Microsoft.Migrate; + +@doc("The status of the current operation.") +union ProvisioningState { + @doc("Resource provisioning Successful.") + Succeeded: "Succeeded", + + @doc("Resource provisioning Failed.") + Failed: "Failed", + + @doc("Resource provisioning Canceled.") + Canceled: "Canceled", + + @doc("Resource is being Provisioned.") + Provisioning: "Provisioning", + + @doc("Resource is being Updated.") + Updating: "Updating", + + @doc("Resource is being Deleted.") + Deleting: "Deleting", + + @doc("Resource is being Accepted.") + Accepted: "Accepted", + + string, +} diff --git a/specification/migrate/Waves.Management/WebModels/Enums/Enums.tsp b/specification/migrate/Waves.Management/WebModels/Enums/Enums.tsp new file mode 100644 index 000000000000..57250fef3573 --- /dev/null +++ b/specification/migrate/Waves.Management/WebModels/Enums/Enums.tsp @@ -0,0 +1,64 @@ +using Azure.ResourceManager; + +@doc("Strategy for migration to Azure") +union Strategy { + @doc("No specific strategy defined.") + None: "None", + + @doc("Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification.") + Rehost: "Rehost", + + @doc("Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities.") + Refactor: "Refactor", + + @doc("Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure.") + Rearchitect: "Rearchitect", + + @doc("Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services.") + Rebuild: "Rebuild", + + @doc("Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform.") + Replace: "Replace", + + @doc("Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform.") + Retire: "Retire", + + @doc("Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right.") + Retain: "Retain", + + @doc("Replatform: This strategy involves making more substantial changes to the application.") + Replatform: "Replatform", + + string, +} + +@doc("TaskScope can be either 'Wave' or 'MigrationEntity' or 'MigrationEntityGroup'") +union TaskScope { + @doc("Wave task - typically related to a specific wave of migration") + Wave: "Wave", + + @doc("Migration Entity task - typically related to a specific migration entity") + MigrationEntity: "MigrationEntity", + + @doc("Migration Entity Group task - typically related to a specific migration entity group") + MigrationEntityGroup: "MigrationEntityGroup", + + string, +} + +@doc("TaskType can be either 'User' or 'System'") +union TaskType { + @doc("UserDefined task - typically initiated by a user") + UserDefined: "UserDefined", + + @doc("SystemDefined task - typically initiated by the system") + SystemDefined: "SystemDefined", + + string, +} + +@doc("Migration Specific Properties Instance Types.") +union MigrationSpecificPropertiesInstanceType { + ServerMigration: "ServerMigration", + string, +} diff --git a/specification/migrate/Waves.Management/WebModels/MigrationEntity/MigrationEntity.tsp b/specification/migrate/Waves.Management/WebModels/MigrationEntity/MigrationEntity.tsp new file mode 100644 index 000000000000..d44b6a20bfe8 --- /dev/null +++ b/specification/migrate/Waves.Management/WebModels/MigrationEntity/MigrationEntity.tsp @@ -0,0 +1,129 @@ +import "../../Common/ArmModels/AzureResourceProperties.tsp"; +import "../Enums/Enums.tsp"; +import "../../Common/ArmModels/MigrateProject.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Microsoft.Migrate; + +@added(ApiVersions.v2025_03_30_preview) +@doc("Migration Entity resource.") +@parentResource(MigrateProject) +model MigrationEntity is ProxyResource { + @doc("Migration Entity ARM name") + @key("migrationEntityName") + @segment("migrationEntities") + @path + // "^[^<>&:\\?\/#\x00-\x1F\x7F]{1,260}$" + @pattern("^[^<>&:\\?/#]{1,260}$") + name: string; + + ...EntityTagProperty; +} + +@doc("Migration Entity Properties class.") +model MigrationEntityProperties is AzureResourceProperties { + @doc("ARM Resource Identifier for the partner resource.") + partnerResourceArmId?: string; + + @doc("target Azure Resource ARM Id.") + targetAzureResourceArmId?: string; + + @doc("inventory resource id ") + associatedInventoryResourceId: string; + + @doc("Display Name of the Workload.") + inventoryDisplayName: string; + + @doc("Associated Assessment Id") + associatedAssessmentId?: armResourceIdentifier<[ + { + type: "Microsoft.Migrate/assessmentProjects/assessments"; + } + ]>; + + @doc("associated Wave Id") + associatedWaveId?: armResourceIdentifier<[ + { + type: "Microsoft.Migrate/migrateProjects/waves"; + } + ]>; + + @doc("associated Migration Entity Group Id") + associatedMigrationEntityGroupIds?: Array>; + + @doc("Execution start date for Migration Entity.") + @visibility(Lifecycle.Read) + executionStartDate?: utcDateTime; + + @doc("Target of the Migration Entity.") + target?: string; + + @doc("Strategy of Migration Entity.") + @visibility(Lifecycle.Read) + migrationStrategy?: Strategy; + + @doc("Execution Stage of Migration Entity.") + @visibility(Lifecycle.Read) + executionStage?: string; + + @doc("Execution Status of Migration Entity.") + @visibility(Lifecycle.Read) + executionStatus?: string; + + @doc("Execution Readiness of Migration Entity.") + @visibility(Lifecycle.Read) + executionReadiness?: string; + + @doc("Migration specific properties for the entity.") + migrationSpecificProperties?: MigrationSpecificPropertiesBase; + + @doc("Migration Tool of the Migration Entity.") + migrationTool?: string; + + @doc("Migration path") + migrationPath?: string; + + @doc("Assessed Entity ARM Id") + assessedEntityArmId?: string; +} + +@doc("The base Migration Specific Properties model.") +@discriminator("instanceType") +model MigrationSpecificPropertiesBase { + @doc("Discriminator for migration specific properties.") + instanceType: MigrationSpecificPropertiesInstanceType; +} + +@doc("Represents a Server Migration Specific properties base model.") +model ServerMigrationSpecificProperties + extends MigrationSpecificPropertiesBase { + @doc("Discriminator for migration specific properties.") + instanceType: MigrationSpecificPropertiesInstanceType.ServerMigration; + + drApplianceInventoryId?: armResourceIdentifier<[ + { + type: "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems"; + }, + { + type: "Microsoft.OffAzure/VMwareSites/machines"; + }, + { + type: "Microsoft.OffAzure/ServerSites/machines"; + } + ]>; + currentJobId?: armResourceIdentifier<[ + { + type: "Microsoft.RecoveryServices/vaults/replicationJobs"; + } + ]>; +} diff --git a/specification/migrate/Waves.Management/WebModels/MigrationEntityGroup/MigrationEntityGroups.tsp b/specification/migrate/Waves.Management/WebModels/MigrationEntityGroup/MigrationEntityGroups.tsp new file mode 100644 index 000000000000..cbb07d445581 --- /dev/null +++ b/specification/migrate/Waves.Management/WebModels/MigrationEntityGroup/MigrationEntityGroups.tsp @@ -0,0 +1,61 @@ +import "../../Common/ArmModels/AzureResourceProperties.tsp"; +import "../Enums/Enums.tsp"; +import "../../Common/ArmModels/MigrateProject.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Microsoft.Migrate; + +@added(ApiVersions.v2025_03_30_preview) +@doc("Migration Entity Group resource.") +@parentResource(MigrateProject) +model MigrationEntityGroup is ProxyResource { + @doc("Migration Entity Group ARM name") + @key("migrationEntityGroupName") + @segment("migrationEntityGroups") + @path + // "^[^<>&:\\?\/#\x00-\x1F\x7F]{1,260}$" + @pattern("^[^<>&:\\?/#]{1,260}$") + name: string; + + ...EntityTagProperty; +} + +@doc("Migration Entity Group Properties class.") +model MigrationEntityGroupProperties is AzureResourceProperties { + @doc("Application id ") + applicationId: string; + + @doc("Display Name of the Workload.") + applicationDisplayName: string; + + @doc("Associated Assessment Id") + associatedAssessmentId?: armResourceIdentifier<[ + { + type: "Microsoft.Migrate/assessmentProjects/assessments"; + } + ]>; + + @doc("associated Wave Id") + associatedWaveIds?: Array>; + + @doc("Migration Entity Group Status") + @visibility(Lifecycle.Read) + executionStatus?: string; + + @doc("Execution Start Date") + @visibility(Lifecycle.Read) + executionStartDate?: utcDateTime; + + @doc("Migration path") + migrationPath?: string; +} diff --git a/specification/migrate/Waves.Management/WebModels/Tasks/TaskSummary.tsp b/specification/migrate/Waves.Management/WebModels/Tasks/TaskSummary.tsp new file mode 100644 index 000000000000..556fdfba5376 --- /dev/null +++ b/specification/migrate/Waves.Management/WebModels/Tasks/TaskSummary.tsp @@ -0,0 +1,73 @@ +import "../../Common/ArmModels/AzureResourceProperties.tsp"; +import "../Enums/Enums.tsp"; +import "../../Common/ArmModels/MigrateProject.tsp"; +import "./Tasks.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.OpenAPI; + +namespace Microsoft.Migrate; + +@added(ApiVersions.v2025_03_30_preview) +@doc("Task Summary Request model.") +model TaskSummaryRequest { + @doc("Task Scope ARM Id") + scopeId: armResourceIdentifier<[ + { + type: "Microsoft.Migrate/MigrateProjects/waves"; + }, + { + type: "Microsoft.Migrate/MigrationProjects/migrationEntityGroups"; + }, + { + type: "Microsoft.Migrate/MigrateProjects/migrationEntities"; + } + ]>; +} + +@added(ApiVersions.v2025_03_30_preview) +@doc("Task Summary Response model.") +model TaskSummaryResponse { + @doc("List of Task Summary Items") + @OpenAPI.extension("x-ms-identifiers", #[]) + items: Array; +} + +@added(ApiVersions.v2025_03_30_preview) +@doc("Task Summary Item model.") +model TaskSummaryItem { + @doc("Task Stage") + stage: string; + + @doc("Aggregated status of tasks in this stage.") + aggregatedStatus: string; + + @doc("Counts of tasks in this stage by status.") + statusCounts: TaskStatusCounts; + + @doc("List of tasks in this stage.") + @OpenAPI.extension("x-ms-identifiers", #[]) + tasks: Array; +} + +@added(ApiVersions.v2025_03_30_preview) +@doc("Task Status Counts model.") +model TaskStatusCounts { + @doc("Status counts dictionary mapping TaskStatus to the count of tasks with that status.") + @OpenAPI.extension("x-ms-identifiers", #["status"]) + statusCounts: TaskStatusCountMap[]; +} + +@added(ApiVersions.v2025_03_30_preview) +@doc("Task status count mapping.") +model TaskStatusCountMap { + @doc("The task status.") + status: string; + + @doc("The count of tasks with this status.") + count: int32; +} diff --git a/specification/migrate/Waves.Management/WebModels/Tasks/Tasks.tsp b/specification/migrate/Waves.Management/WebModels/Tasks/Tasks.tsp new file mode 100644 index 000000000000..33c975c0d173 --- /dev/null +++ b/specification/migrate/Waves.Management/WebModels/Tasks/Tasks.tsp @@ -0,0 +1,69 @@ +import "../../Common/ArmModels/AzureResourceProperties.tsp"; +import "../Enums/Enums.tsp"; +import "../../Common/ArmModels/MigrateProject.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +namespace Microsoft.Migrate; + +@added(ApiVersions.v2025_03_30_preview) +@doc("Tasks resource.") +@parentResource(MigrateProject) +model Task is ProxyResource { + @doc("Task ARM name") + @key("taskName") + @segment("tasks") + @path + // "^[^<>&:\\?\/#\x00-\x1F\x7F]{1,260}$" + @pattern("^[^<>&:\\?/#]{1,260}$") + name: string; + + ...EntityTagProperty; +} + +@doc("Task Properties class.") +model TaskProperties is AzureResourceProperties { + @doc("associated Wave Id") + scopeId: armResourceIdentifier<[ + { + type: "Microsoft.Migrate/migrateProjects/waves"; + }, + { + type: "Microsoft.Migrate/migrateProjects/migrationEntities"; + }, + { + type: "Microsoft.Migrate/migrateProjects/migrationEntityGroups"; + } + ]>; + + @doc("Task Stage") + stage?: string; + + @doc("Task Type") + @visibility(Lifecycle.Read) + taskType: TaskType; + + @doc("Task Dislay Name ") + displayName: string; + + @doc("Indicates whether the task is editable.") + @visibility(Lifecycle.Read) + isEditable: boolean; + + @doc("Task Status") + status: string; + + @doc("Task Scope") + scope: TaskScope; + + @doc("Task Description") + description?: string; + + @doc("Task completion Date") + @visibility(Lifecycle.Read) + completionDate?: utcDateTime; +} diff --git a/specification/migrate/Waves.Management/WebModels/Waves/MigrationWaves.tsp b/specification/migrate/Waves.Management/WebModels/Waves/MigrationWaves.tsp new file mode 100644 index 000000000000..240335a49460 --- /dev/null +++ b/specification/migrate/Waves.Management/WebModels/Waves/MigrationWaves.tsp @@ -0,0 +1,62 @@ +import "../../Common/ArmModels/AzureResourceProperties.tsp"; +import "../Enums/Enums.tsp"; +import "../../Common/ArmModels/MigrateProject.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; + +namespace Microsoft.Migrate; + +@added(ApiVersions.v2025_03_30_preview) +@doc("Migration Wave resource.") +@parentResource(MigrateProject) +model Wave is ProxyResource { + @doc("Migration Wave Resource") + @key("waveName") + @segment("waves") + @path + // "^[^<>&:\\?\/#\x00-\x1F\x7F]{1,260}$" + @pattern("^[^<>&:\\?/#]{1,260}$") + name: string; + + ...EntityTagProperty; +} + +@doc("Migration Wave Properties class.") +model WaveProperties is AzureResourceProperties { + @doc("Description of the wave.") + description?: string; + + @doc("Display Name of the wave.") + displayName: string; + + @doc("ARG query and other details to create workloads within a wave") + arg: Arg; + + @doc("The status of the wave.") + @visibility(Lifecycle.Read) + status?: string; + + @doc("Planned start date of the wave.") + plannedStartDate: utcDateTime; + + @doc("Planned completion date of the wave.") + plannedCompletionDate?: utcDateTime; + + @doc("Actual start date of the wave.") + @visibility(Lifecycle.Read) + actualStartDate?: utcDateTime; + + @doc("The current stage of the wave.") + @visibility(Lifecycle.Read) + stage?: string; +} + +@doc("ARG query and other details to create workloads within a wave.") +model Arg { + @doc("The query to create workloads within the wave.") + query: string; +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Create_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..981d654f3474 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Create_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "MigrationEntities_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityName": "myMigrationEntityName", + "resource": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc", + "provisioningState": "Succeeded", + "executionStartDate": "2025-09-15T12:28:36.729Z", + "executionStage": "Preparation", + "executionStatus": "NotStarted" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc", + "provisioningState": "Succeeded", + "executionStartDate": "2025-09-15T12:28:36.729Z", + "executionStage": "Preparation", + "executionStatus": "NotStarted" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Delete_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5be827bdf308 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "MigrationEntities_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityName": "myMigrationEntityName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Get_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..95e5ae0ef61b --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "MigrationEntities_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityName": "myMigrationEntityName" + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc", + "provisioningState": "Succeeded", + "executionStartDate": "2025-09-15T12:28:36.729Z", + "executionStage": "Preparation", + "executionStatus": "NotStarted" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_ListByParent_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..f1268a9bffe9 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntities_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "MigrationEntities_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionStage": "Preparation", + "executionStatus": "NotStarted", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroups" + ], + "executionStartDate": "2025-09-15T12:28:36.729Z", + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "nzelvzhtkqgijjenvgeclnvelcbcjz" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/aacbr" + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Create_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..32ef153f398d --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Create_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "MigrationEntityGroups_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityGroupName": "myMigrationEntityGroupName", + "resource": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred", + "provisioningState": "Succeeded", + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred", + "provisioningState": "Succeeded", + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Delete_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..4b84aa582d1f --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "MigrationEntityGroups_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityGroupName": "myMigrationEntityGroupName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Get_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..441b84f9b2f8 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "MigrationEntityGroups_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityGroupName": "myMigrationEntityGroupName" + }, + "responses": { + "200": { + "body": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred", + "provisioningState": "Succeeded", + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..2d31f0c22762 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "MigrationEntityGroups_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Operations_List_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e01f9e47990 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rlezeskov", + "isDataAction": true, + "display": { + "provider": "qdeardpcthwxjqcuihuo", + "resource": "hefqtoglbfaywueat", + "operation": "scaljshazk", + "description": "ohqulwkjsvztlffsszaonlcbhoap" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Operations_List_MinimumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..c7c0e650fd21 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-03-30-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Create_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..3c8c4222000e --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Create_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "Tasks_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "taskName": "myTaskName", + "resource": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "description": "lzhl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "provisioningState": "Succeeded", + "isEditable": true, + "description": "lzhl", + "completionDate": "2025-09-15T12:28:36.735Z" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "provisioningState": "Succeeded", + "isEditable": true, + "description": "lzhl", + "completionDate": "2025-09-15T12:28:36.735Z" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Delete_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..b1d75c10bd87 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Tasks_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "taskName": "myTaskName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_GetSummary_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_GetSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..079fa8ca1d2c --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_GetSummary_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Tasks_GetSummary_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_GetSummary", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "body": { + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + } + }, + "responses": { + "200": { + "body": { + "items": [ + { + "stage": "qzhwejsmvecptmvzlbtlne", + "aggregatedStatus": "Pending", + "statusCounts": { + "statusCounts": [ + { + "status": "Pending", + "count": 2 + } + ] + }, + "tasks": [ + { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "provisioningState": "Succeeded", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "isEditable": true, + "completionDate": "2025-09-15T12:28:36.735Z", + "description": "rfmyjnrmujpagajhqds" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ] + } + ] + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Get_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..42f550d78098 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "Tasks_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "taskName": "myTaskName" + }, + "responses": { + "200": { + "body": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "provisioningState": "Succeeded", + "isEditable": true, + "description": "lzhl", + "completionDate": "2025-09-15T12:28:36.735Z" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_ListByParent_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..a31b81de0beb --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Tasks_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "Tasks_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "isEditable": true, + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/Waves/myWave", + "displayName": "ldmgemoa", + "completionDate": "2025-09-15T12:28:36.734Z", + "description": "xykmtdhbimovojas" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Create_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..35694d01cff7 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "Waves_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName", + "resource": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "description": "ukktsjlknnsvbrt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Delete_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0051a9ad02e --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Waves_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Get_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2374b6f60518 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "Waves_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_ListByParent_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..d26bdbf7a387 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "Waves_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "status": "NotStarted", + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation", + "description": "pbsuvxcspfeviom" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/aqvbud" + } + } + } +} diff --git a/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Refresh_MaximumSet_Gen.json b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Refresh_MaximumSet_Gen.json new file mode 100644 index 000000000000..836e62ab5239 --- /dev/null +++ b/specification/migrate/Waves.Management/examples/2025-03-30-preview/Waves_Refresh_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Waves_Refresh_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Refresh", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName" + }, + "responses": { + "200": { + "body": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + } + } + } +} diff --git a/specification/migrate/Waves.Management/main.tsp b/specification/migrate/Waves.Management/main.tsp new file mode 100644 index 000000000000..a4b07aa4b727 --- /dev/null +++ b/specification/migrate/Waves.Management/main.tsp @@ -0,0 +1,28 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@azure-tools/typespec-azure-core"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; + +// Common list of supported API versions. +import "./ApiVersions.tsp"; + +// Add all service routes here. +import "./routes.tsp"; + +// using Autorest; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +@armProviderNamespace +@service(#{ title: "Azure Migrate Migration Service" }) +@versioned(ApiVersions) +@doc("Azure Migrate Resource Provider management API.") +namespace Microsoft.Migrate; + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/migrate/Waves.Management/routes.tsp b/specification/migrate/Waves.Management/routes.tsp new file mode 100644 index 000000000000..3a38b68ee772 --- /dev/null +++ b/specification/migrate/Waves.Management/routes.tsp @@ -0,0 +1,93 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "@azure-tools/typespec-client-generator-core"; +import "./ApiVersions.tsp"; +import "./WebModels/Waves/MigrationWaves.tsp"; +import "./WebModels/MigrationEntity/MigrationEntity.tsp"; +import "./WebModels/MigrationEntityGroup/MigrationEntityGroups.tsp"; +import "./WebModels/Tasks/Tasks.tsp"; +import "./WebModels/Tasks/TaskSummary.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.ResourceManager; +using OpenAPI; + +namespace Microsoft.Migrate; + +@armResourceOperations +interface Waves { + @added(ApiVersions.v2025_03_30_preview) + create is ArmResourceCreateOrUpdateAsync; + + @added(ApiVersions.v2025_03_30_preview) + get is ArmResourceRead; + + @added(ApiVersions.v2025_03_30_preview) + listByParent is ArmResourceListByParent; + + @added(ApiVersions.v2025_03_30_preview) + delete is ArmResourceDeleteWithoutOkAsync; + + @added(ApiVersions.v2025_03_30_preview) + @doc("Refresh operation to update wave") + @Azure.ClientGenerator.Core.clientName("triggerRefresh", "java") + @Azure.ClientGenerator.Core.clientName("triggerRefresh", "csharp") + refresh is ArmResourceActionSync; +} + +@armResourceOperations +interface MigrationEntities { + @added(ApiVersions.v2025_03_30_preview) + create is ArmResourceCreateOrUpdateAsync; + + @added(ApiVersions.v2025_03_30_preview) + get is ArmResourceRead; + + @added(ApiVersions.v2025_03_30_preview) + listByParent is ArmResourceListByParent; + + @added(ApiVersions.v2025_03_30_preview) + delete is ArmResourceDeleteWithoutOkAsync; +} + +@armResourceOperations +interface MigrationEntityGroups { + @added(ApiVersions.v2025_03_30_preview) + create is ArmResourceCreateOrUpdateAsync; + + @added(ApiVersions.v2025_03_30_preview) + get is ArmResourceRead; + + @added(ApiVersions.v2025_03_30_preview) + listByParent is ArmResourceListByParent; + + @added(ApiVersions.v2025_03_30_preview) + delete is ArmResourceDeleteWithoutOkAsync; +} + +@armResourceOperations +interface Tasks { + @added(ApiVersions.v2025_03_30_preview) + create is ArmResourceCreateOrUpdateAsync; + + @added(ApiVersions.v2025_03_30_preview) + get is ArmResourceRead; + + @added(ApiVersions.v2025_03_30_preview) + listByParent is ArmResourceListByParent; + + @added(ApiVersions.v2025_03_30_preview) + delete is ArmResourceDeleteWithoutOkAsync; + + @added(ApiVersions.v2025_03_30_preview) + @doc("Retrieves task summary across all tasks in the project.") + @action("taskSummary") + getSummary is ArmResourceActionSync< + MigrateProject, + TaskSummaryRequest, + TaskSummaryResponse + >; +} diff --git a/specification/migrate/Waves.Management/suppressions.yaml b/specification/migrate/Waves.Management/suppressions.yaml new file mode 100644 index 000000000000..102cc42bcb16 --- /dev/null +++ b/specification/migrate/Waves.Management/suppressions.yaml @@ -0,0 +1,6 @@ +- tool: TypeSpecValidation + paths: + - ./tspconfig.yaml + rules: + - SdkTspConfigValidation + reason: Azure Migrate does not support any SDK Generation yet. More changes are needed for supporting SDK Generation which will come in the future changes. diff --git a/specification/migrate/Waves.Management/tspconfig.yaml b/specification/migrate/Waves.Management/tspconfig.yaml new file mode 100644 index 000000000000..d2f99903db00 --- /dev/null +++ b/specification/migrate/Waves.Management/tspconfig.yaml @@ -0,0 +1,43 @@ +parameters: + "service-dir": + default: "sdk/migrate" +emit: + - "@azure-tools/typespec-autorest" +output-dir: "{project-root}/../" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +options: + "@azure-tools/typespec-autorest": + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/Waves/{version-status}/{version}/waves.json" + azure-resource-provider-folder: ./resource-manager + use-read-only-status-schema: true + arm-types-dir: "{project-root}/../../common-types/resource-management" + examples-dir: "{project-root}/examples" + "@azure-tools/typespec-csharp": + flavor: azure + package-dir: "Azure.ResourceManager.Migrate" + clear-output-folder: true + model-namespace: true + namespace: "{package-dir}" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-migrate" + package-name: "{package-dir}" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-migrate" + namespace: "com.azure.resourcemanager.migrate" + service-name: "migrate" + flavor: azure + "@azure-tools/typespec-ts": + package-dir: "arm-migrate" + flavor: azure + experimental-extensible-enums: true + package-details: + name: "@azure/arm-migrate" + "@azure-tools/typespec-client-generator-cli": + "additionalDirectories": + - "specification/migrate/Waves.Management/Common" diff --git a/specification/migrate/cspell.yaml b/specification/migrate/cspell.yaml index 2a9e154fb554..a9829fc2cdd7 100644 --- a/specification/migrate/cspell.yaml +++ b/specification/migrate/cspell.yaml @@ -97,5 +97,10 @@ overrides: - sqlasmroutes - waasmroutes - wacasmroutes + - filename: '**/specification/migrate/Waves.Management/**/*.tsp' + words: + - SQLVM + - Rearchitect + - Rehost diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..981d654f3474 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Create_MaximumSet_Gen.json @@ -0,0 +1,117 @@ +{ + "title": "MigrationEntities_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityName": "myMigrationEntityName", + "resource": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc", + "provisioningState": "Succeeded", + "executionStartDate": "2025-09-15T12:28:36.729Z", + "executionStage": "Preparation", + "executionStatus": "NotStarted" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc", + "provisioningState": "Succeeded", + "executionStartDate": "2025-09-15T12:28:36.729Z", + "executionStage": "Preparation", + "executionStatus": "NotStarted" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..5be827bdf308 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "MigrationEntities_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityName": "myMigrationEntityName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..95e5ae0ef61b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "title": "MigrationEntities_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityName": "myMigrationEntityName" + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMygrationEntityGroup" + ], + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "dihnjnc", + "provisioningState": "Succeeded", + "executionStartDate": "2025-09-15T12:28:36.729Z", + "executionStage": "Preparation", + "executionStatus": "NotStarted" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_ListByParent_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..f1268a9bffe9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntities_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "title": "MigrationEntities_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntities_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "partnerResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.RecoveryServices/vaults/MyRecoveryVault/replicationFabrics/HyperVSite/replicationProtectionContainers/HyperVContainer/replicationProtectedItems/MyVM", + "targetAzureResourceArmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "associatedInventoryResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.OffAzure/VMwareSites/myVMwareSite/vmwareMachines/myDiscoveredVM", + "inventoryDisplayName": "ywdewqxixfxzgzkkv", + "target": "AzureVM", + "migrationStrategy": "Rehost", + "executionStage": "Preparation", + "executionStatus": "NotStarted", + "executionReadiness": "NotAvailable", + "migrationSpecificProperties": { + "instanceType": "MigrationSpecificPropertiesBase" + }, + "migrationTool": "Server Migration Agentless", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "associatedWaveId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "associatedMigrationEntityGroupIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroups" + ], + "executionStartDate": "2025-09-15T12:28:36.729Z", + "migrationPath": "PaaSPreferred", + "assessedEntityArmId": "nzelvzhtkqgijjenvgeclnvelcbcjz" + }, + "eTag": "obuzvbpvtdmykxfhyn", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntities/myMygrationEntity", + "name": "txhtkdqewu", + "type": "dlgonfzavcmahobqxrswpu", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/aacbr" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..32ef153f398d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Create_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "MigrationEntityGroups_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityGroupName": "myMigrationEntityGroupName", + "resource": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred", + "provisioningState": "Succeeded", + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred", + "provisioningState": "Succeeded", + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..4b84aa582d1f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "MigrationEntityGroups_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityGroupName": "myMigrationEntityGroupName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..441b84f9b2f8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "MigrationEntityGroups_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "migrationEntityGroupName": "myMigrationEntityGroupName" + }, + "responses": { + "200": { + "body": { + "properties": { + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred", + "provisioningState": "Succeeded", + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..2d31f0c22762 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "MigrationEntityGroups_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "MigrationEntityGroups_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "applicationId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.ApplicationMigration/discoveryHubs/MyDiscoveryHub/applications/MyAppe", + "applicationDisplayName": "ricbxbn", + "associatedWaveIds": [ + "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + ], + "executionStatus": "NotStarted", + "executionStartDate": "2025-10-07T05:56:47.736Z", + "associatedAssessmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/assessmentprojects/myAssessmentproject/assessments/myAssessment", + "migrationPath": "PaaSPreferred" + }, + "eTag": "ghl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/migrationEntityGroups/myMigrationEntityGroup", + "name": "kw", + "type": "eoojxsfngyaptqvlmsmjgcufqbel", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e01f9e47990 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-03-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rlezeskov", + "isDataAction": true, + "display": { + "provider": "qdeardpcthwxjqcuihuo", + "resource": "hefqtoglbfaywueat", + "operation": "scaljshazk", + "description": "ohqulwkjsvztlffsszaonlcbhoap" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..c7c0e650fd21 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MinimumSet] rule", + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-03-30-preview" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..3c8c4222000e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Create_MaximumSet_Gen.json @@ -0,0 +1,83 @@ +{ + "title": "Tasks_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "taskName": "myTaskName", + "resource": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "description": "lzhl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "provisioningState": "Succeeded", + "isEditable": true, + "description": "lzhl", + "completionDate": "2025-09-15T12:28:36.735Z" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "provisioningState": "Succeeded", + "isEditable": true, + "description": "lzhl", + "completionDate": "2025-09-15T12:28:36.735Z" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..b1d75c10bd87 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Tasks_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "taskName": "myTaskName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_GetSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_GetSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..079fa8ca1d2c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_GetSummary_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "Tasks_GetSummary_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_GetSummary", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "body": { + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave" + } + }, + "responses": { + "200": { + "body": { + "items": [ + { + "stage": "qzhwejsmvecptmvzlbtlne", + "aggregatedStatus": "Pending", + "statusCounts": { + "statusCounts": [ + { + "status": "Pending", + "count": 2 + } + ] + }, + "tasks": [ + { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "provisioningState": "Succeeded", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "isEditable": true, + "completionDate": "2025-09-15T12:28:36.735Z", + "description": "rfmyjnrmujpagajhqds" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ] + } + ] + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..42f550d78098 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "Tasks_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "taskName": "myTaskName" + }, + "responses": { + "200": { + "body": { + "properties": { + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "displayName": "hhbrpibobilcoypvyiofvr", + "provisioningState": "Succeeded", + "isEditable": true, + "description": "lzhl", + "completionDate": "2025-09-15T12:28:36.735Z" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_ListByParent_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..a31b81de0beb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Tasks_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "Tasks_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Tasks_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "stage": "klaemxmckhvyoooxyauqglexjna", + "taskType": "User", + "isEditable": true, + "status": "Pending", + "scope": "Wave", + "scopeId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/Waves/myWave", + "displayName": "ldmgemoa", + "completionDate": "2025-09-15T12:28:36.734Z", + "description": "xykmtdhbimovojas" + }, + "eTag": "qwvistijljbsmdmjwiouvxp", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/tasks/myTask", + "name": "ejdnhrqdoevhryqij", + "type": "roa", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..35694d01cff7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "Waves_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Create", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName", + "resource": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "description": "ukktsjlknnsvbrt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0051a9ad02e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Waves_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Delete", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2374b6f60518 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "Waves_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Get", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName" + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_ListByParent_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_ListByParent_MaximumSet_Gen.json new file mode 100644 index 000000000000..d26bdbf7a387 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_ListByParent_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "Waves_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_ListByParent", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "status": "NotStarted", + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation", + "description": "pbsuvxcspfeviom" + }, + "eTag": "ckfmxpaxabl", + "id": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/migrateProjects/MyMigrateProject/waves/myWave", + "name": "tgmjblyar", + "type": "hwzunkyk", + "systemData": { + "createdBy": "yytbgo", + "createdByType": "User", + "createdAt": "2025-07-07T05:56:47.736Z", + "lastModifiedBy": "xihcsro", + "lastModifiedByType": "User", + "lastModifiedAt": "2025-07-07T05:56:47.736Z" + } + } + ], + "nextLink": "https://microsoft.com/aqvbud" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Refresh_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Refresh_MaximumSet_Gen.json new file mode 100644 index 000000000000..836e62ab5239 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/examples/Waves_Refresh_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Waves_Refresh_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule", + "operationId": "Waves_Refresh", + "parameters": { + "api-version": "2025-03-30-preview", + "subscriptionId": "78388498-BFD0-4CFE-A2E2-B1AFE99EFEFF", + "resourceGroupName": "rgwaves", + "projectName": "myProjectName", + "waveName": "myWaveName" + }, + "responses": { + "200": { + "body": { + "displayName": "bhypoxylsythumuxqozo", + "arg": { + "query": "shcijfglntriaccyqiwjipqneiqlm" + }, + "plannedStartDate": "2025-07-07T05:56:49.292Z", + "plannedCompletionDate": "2025-07-07T05:56:49.292Z", + "provisioningState": "Succeeded", + "description": "ukktsjlknnsvbrt", + "status": "NotStarted", + "actualStartDate": "2025-07-07T05:56:49.292Z", + "stage": "Creation" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/waves.json b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/waves.json new file mode 100644 index 000000000000..5b5ef3a15bd7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/preview/2025-03-30-preview/waves.json @@ -0,0 +1,2420 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Migration Service", + "version": "2025-03-30-preview", + "description": "Azure Migrate Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Waves" + }, + { + "name": "MigrationEntities" + }, + { + "name": "MigrationEntityGroups" + }, + { + "name": "Tasks" + } + ], + "paths": { + "/providers/Microsoft.Migrate/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MinimumSet] rule": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntities": { + "get": { + "operationId": "MigrationEntities_ListByParent", + "tags": [ + "MigrationEntities" + ], + "description": "List MigrationEntity resources by MigrateProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MigrationEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntities_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntities_ListByParent_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntities/{migrationEntityName}": { + "get": { + "operationId": "MigrationEntities_Get", + "tags": [ + "MigrationEntities" + ], + "description": "Get a MigrationEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "migrationEntityName", + "in": "path", + "description": "Migration Entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MigrationEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntities_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntities_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "MigrationEntities_Create", + "tags": [ + "MigrationEntities" + ], + "description": "Create a MigrationEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "migrationEntityName", + "in": "path", + "description": "Migration Entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationEntity" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MigrationEntity' update operation succeeded", + "schema": { + "$ref": "#/definitions/MigrationEntity" + } + }, + "201": { + "description": "Resource 'MigrationEntity' create operation succeeded", + "schema": { + "$ref": "#/definitions/MigrationEntity" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntities_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntities_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MigrationEntities_Delete", + "tags": [ + "MigrationEntities" + ], + "description": "Delete a MigrationEntity", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "migrationEntityName", + "in": "path", + "description": "Migration Entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntities_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntities_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntityGroups": { + "get": { + "operationId": "MigrationEntityGroups_ListByParent", + "tags": [ + "MigrationEntityGroups" + ], + "description": "List MigrationEntityGroup resources by MigrateProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MigrationEntityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntityGroups_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntityGroups_ListByParent_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntityGroups/{migrationEntityGroupName}": { + "get": { + "operationId": "MigrationEntityGroups_Get", + "tags": [ + "MigrationEntityGroups" + ], + "description": "Get a MigrationEntityGroup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "migrationEntityGroupName", + "in": "path", + "description": "Migration Entity Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MigrationEntityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntityGroups_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntityGroups_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "MigrationEntityGroups_Create", + "tags": [ + "MigrationEntityGroups" + ], + "description": "Create a MigrationEntityGroup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "migrationEntityGroupName", + "in": "path", + "description": "Migration Entity Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationEntityGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MigrationEntityGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/MigrationEntityGroup" + } + }, + "201": { + "description": "Resource 'MigrationEntityGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/MigrationEntityGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntityGroups_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntityGroups_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MigrationEntityGroups_Delete", + "tags": [ + "MigrationEntityGroups" + ], + "description": "Delete a MigrationEntityGroup", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "migrationEntityGroupName", + "in": "path", + "description": "Migration Entity Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MigrationEntityGroups_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/MigrationEntityGroups_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/taskSummary": { + "post": { + "operationId": "Tasks_GetSummary", + "tags": [ + "Tasks" + ], + "description": "Retrieves task summary across all tasks in the project.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/TaskSummaryRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TaskSummaryResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Tasks_GetSummary_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Tasks_GetSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/tasks": { + "get": { + "operationId": "Tasks_ListByParent", + "tags": [ + "Tasks" + ], + "description": "List Task resources by MigrateProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TaskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Tasks_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Tasks_ListByParent_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/tasks/{taskName}": { + "get": { + "operationId": "Tasks_Get", + "tags": [ + "Tasks" + ], + "description": "Get a Task", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "taskName", + "in": "path", + "description": "Task ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Tasks_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Tasks_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Tasks_Create", + "tags": [ + "Tasks" + ], + "description": "Create a Task", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "taskName", + "in": "path", + "description": "Task ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Task" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Task' update operation succeeded", + "schema": { + "$ref": "#/definitions/Task" + } + }, + "201": { + "description": "Resource 'Task' create operation succeeded", + "schema": { + "$ref": "#/definitions/Task" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Tasks_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Tasks_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Tasks_Delete", + "tags": [ + "Tasks" + ], + "description": "Delete a Task", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "taskName", + "in": "path", + "description": "Task ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Tasks_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Tasks_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves": { + "get": { + "operationId": "Waves_ListByParent", + "tags": [ + "Waves" + ], + "description": "List Wave resources by MigrateProject", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WaveListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Waves_ListByParent_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Waves_ListByParent_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves/{waveName}": { + "get": { + "operationId": "Waves_Get", + "tags": [ + "Waves" + ], + "description": "Get a Wave", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "waveName", + "in": "path", + "description": "Migration Wave Resource", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Wave" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Waves_Get_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Waves_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Waves_Create", + "tags": [ + "Waves" + ], + "description": "Create a Wave", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "waveName", + "in": "path", + "description": "Migration Wave Resource", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Wave" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Wave' update operation succeeded", + "schema": { + "$ref": "#/definitions/Wave" + } + }, + "201": { + "description": "Resource 'Wave' create operation succeeded", + "schema": { + "$ref": "#/definitions/Wave" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Waves_Create_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Waves_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Waves_Delete", + "tags": [ + "Waves" + ], + "description": "Delete a Wave", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "waveName", + "in": "path", + "description": "Migration Wave Resource", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Waves_Delete_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Waves_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves/{waveName}/refresh": { + "post": { + "operationId": "Waves_Refresh", + "tags": [ + "Waves" + ], + "description": "Refresh operation to update wave", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Migrate Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "waveName", + "in": "path", + "description": "Migration Wave Resource", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WaveProperties" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Waves_Refresh_MaximumSet - generated by [MaximumSet] rule - generated by [MaximumSet] rule - generated by [MaximumSet] rule": { + "$ref": "./examples/Waves_Refresh_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "Arg": { + "type": "object", + "description": "ARG query and other details to create workloads within a wave.", + "properties": { + "query": { + "type": "string", + "description": "The query to create workloads within the wave." + } + }, + "required": [ + "query" + ] + }, + "AzureResourceProperties": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Items": { + "type": "string", + "description": "Items Enum", + "enum": [ + "ServerDiscovery", + "ServerAssessment", + "ServerMigration", + "Cloudamize", + "Turbonomic", + "Zerto", + "CorentTech", + "ServerAssessmentV1", + "ServerMigration_Replication", + "Carbonite", + "DataMigrationAssistant", + "DatabaseMigrationService", + "Device42", + "JetStream", + "RackWare", + "UnifyCloud", + "Flexera", + "ServerDiscovery_Import", + "Lakeside", + "AppServiceMigrationAssistant", + "Movere", + "CloudSphere", + "Modernization", + "ServerMigration_DataReplication", + "Unknown" + ], + "x-ms-enum": { + "name": "Items", + "modelAsString": true, + "values": [ + { + "name": "ServerDiscovery", + "value": "ServerDiscovery", + "description": "Server Discovery Item" + }, + { + "name": "ServerAssessment", + "value": "ServerAssessment", + "description": "Server Assessment Item" + }, + { + "name": "ServerMigration", + "value": "ServerMigration", + "description": "Server Migration Item" + }, + { + "name": "Cloudamize", + "value": "Cloudamize", + "description": "Cloudamize Item" + }, + { + "name": "Turbonomic", + "value": "Turbonomic", + "description": "Turbonomic Item" + }, + { + "name": "Zerto", + "value": "Zerto", + "description": "Zerto Item" + }, + { + "name": "CorentTech", + "value": "CorentTech", + "description": "CorentTech Item" + }, + { + "name": "ServerAssessmentV1", + "value": "ServerAssessmentV1", + "description": "ServerAssessmentV1" + }, + { + "name": "ServerMigration_Replication", + "value": "ServerMigration_Replication", + "description": "ServerMigration_Replication" + }, + { + "name": "Carbonite", + "value": "Carbonite", + "description": "Carbonite Item" + }, + { + "name": "DataMigrationAssistant", + "value": "DataMigrationAssistant", + "description": "DataMigrationAssistant Item" + }, + { + "name": "DatabaseMigrationService", + "value": "DatabaseMigrationService", + "description": "DatabaseMigrationService Item" + }, + { + "name": "Device42", + "value": "Device42", + "description": "Device42 Item" + }, + { + "name": "JetStream", + "value": "JetStream", + "description": "JetStream Item" + }, + { + "name": "RackWare", + "value": "RackWare", + "description": "RackWare Item" + }, + { + "name": "UnifyCloud", + "value": "UnifyCloud", + "description": "UnifyCloud Item" + }, + { + "name": "Flexera", + "value": "Flexera", + "description": "Flexera Item" + }, + { + "name": "ServerDiscovery_Import", + "value": "ServerDiscovery_Import", + "description": "ServerDiscovery_Import Item." + }, + { + "name": "Lakeside", + "value": "Lakeside", + "description": "Lakeside Item" + }, + { + "name": "AppServiceMigrationAssistant", + "value": "AppServiceMigrationAssistant", + "description": "AppServiceMigrationAssistant Item" + }, + { + "name": "Movere", + "value": "Movere", + "description": "Movere Item" + }, + { + "name": "CloudSphere", + "value": "CloudSphere", + "description": "CloudSphere Item" + }, + { + "name": "Modernization", + "value": "Modernization", + "description": "Modernization Item" + }, + { + "name": "ServerMigration_DataReplication", + "value": "ServerMigration_DataReplication", + "description": "ServerMigration_DataReplication Item" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Item" + } + ] + } + }, + "MigrateProject": { + "type": "object", + "description": "A Migrate project Resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MigrateProjectProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ] + }, + "MigrateProjectProperties": { + "type": "object", + "description": "Properties of a migrate project.", + "properties": { + "registeredTools": { + "type": "array", + "description": "Register tools inside project.", + "items": { + "$ref": "#/definitions/Items" + }, + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Service endpoint." + }, + "summary": { + "type": "object", + "description": "Project summary.", + "additionalProperties": { + "$ref": "#/definitions/ProjectSummary" + }, + "readOnly": true + }, + "lastSummaryRefreshedTime": { + "type": "string", + "format": "date-time", + "description": "Last summary refresh time.", + "readOnly": true + }, + "refreshSummaryState": { + "$ref": "#/definitions/RefreshSummaryState", + "description": "Refresh summary state.", + "readOnly": true + }, + "utilityStorageAccountId": { + "type": "string", + "description": "Utility storage account id." + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Gets or sets the state of public network access." + }, + "privateEndpointConnections": { + "type": "array", + "description": "Gets the private endpoint connections.", + "items": { + "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + } + } + }, + "MigrationEntity": { + "type": "object", + "description": "Migration Entity resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationEntityProperties", + "description": "The resource-specific properties for this resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "MigrationEntityGroup": { + "type": "object", + "description": "Migration Entity Group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationEntityGroupProperties", + "description": "The resource-specific properties for this resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "MigrationEntityGroupListResult": { + "type": "object", + "description": "The response of a MigrationEntityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MigrationEntityGroup items on this page", + "items": { + "$ref": "#/definitions/MigrationEntityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MigrationEntityGroupProperties": { + "type": "object", + "description": "Migration Entity Group Properties class.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "applicationId": { + "type": "string", + "description": "Application id " + }, + "applicationDisplayName": { + "type": "string", + "description": "Display Name of the Workload." + }, + "associatedAssessmentId": { + "type": "string", + "format": "arm-id", + "description": "Associated Assessment Id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/assessmentProjects/assessments" + } + ] + } + }, + "associatedWaveIds": { + "type": "array", + "description": "associated Wave Id", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/migrateProjects/waves" + } + ] + } + } + }, + "executionStatus": { + "type": "string", + "description": "Migration Entity Group Status", + "readOnly": true + }, + "executionStartDate": { + "type": "string", + "format": "date-time", + "description": "Execution Start Date", + "readOnly": true + }, + "migrationPath": { + "type": "string", + "description": "Migration path" + } + }, + "required": [ + "applicationId", + "applicationDisplayName" + ] + }, + "MigrationEntityListResult": { + "type": "object", + "description": "The response of a MigrationEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MigrationEntity items on this page", + "items": { + "$ref": "#/definitions/MigrationEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MigrationEntityProperties": { + "type": "object", + "description": "Migration Entity Properties class.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "partnerResourceArmId": { + "type": "string", + "description": "ARM Resource Identifier for the partner resource." + }, + "targetAzureResourceArmId": { + "type": "string", + "description": "target Azure Resource ARM Id." + }, + "associatedInventoryResourceId": { + "type": "string", + "description": "inventory resource id " + }, + "inventoryDisplayName": { + "type": "string", + "description": "Display Name of the Workload." + }, + "associatedAssessmentId": { + "type": "string", + "format": "arm-id", + "description": "Associated Assessment Id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/assessmentProjects/assessments" + } + ] + } + }, + "associatedWaveId": { + "type": "string", + "format": "arm-id", + "description": "associated Wave Id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/migrateProjects/waves" + } + ] + } + }, + "associatedMigrationEntityGroupIds": { + "type": "array", + "description": "associated Migration Entity Group Id", + "items": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/migrateProjects/migrationEntityGroups" + } + ] + } + } + }, + "executionStartDate": { + "type": "string", + "format": "date-time", + "description": "Execution start date for Migration Entity.", + "readOnly": true + }, + "target": { + "type": "string", + "description": "Target of the Migration Entity." + }, + "migrationStrategy": { + "$ref": "#/definitions/Strategy", + "description": "Strategy of Migration Entity.", + "readOnly": true + }, + "executionStage": { + "type": "string", + "description": "Execution Stage of Migration Entity.", + "readOnly": true + }, + "executionStatus": { + "type": "string", + "description": "Execution Status of Migration Entity.", + "readOnly": true + }, + "executionReadiness": { + "type": "string", + "description": "Execution Readiness of Migration Entity.", + "readOnly": true + }, + "migrationSpecificProperties": { + "$ref": "#/definitions/MigrationSpecificPropertiesBase", + "description": "Migration specific properties for the entity." + }, + "migrationTool": { + "type": "string", + "description": "Migration Tool of the Migration Entity." + }, + "migrationPath": { + "type": "string", + "description": "Migration path" + }, + "assessedEntityArmId": { + "type": "string", + "description": "Assessed Entity ARM Id" + } + }, + "required": [ + "associatedInventoryResourceId", + "inventoryDisplayName" + ] + }, + "MigrationSpecificPropertiesBase": { + "type": "object", + "description": "The base Migration Specific Properties model.", + "properties": { + "instanceType": { + "$ref": "#/definitions/MigrationSpecificPropertiesInstanceType", + "description": "Discriminator for migration specific properties." + } + }, + "discriminator": "instanceType", + "required": [ + "instanceType" + ] + }, + "MigrationSpecificPropertiesInstanceType": { + "type": "string", + "description": "Migration Specific Properties Instance Types.", + "enum": [ + "ServerMigration" + ], + "x-ms-enum": { + "name": "MigrationSpecificPropertiesInstanceType", + "modelAsString": true, + "values": [ + { + "name": "ServerMigration", + "value": "ServerMigration" + } + ] + } + }, + "ProjectSummary": { + "type": "object", + "description": "Project summary.", + "properties": { + "instanceType": { + "type": "string", + "description": "Instance type.", + "readOnly": true + }, + "refreshSummaryState": { + "$ref": "#/definitions/RefreshSummaryState", + "description": "Refresh summary state." + }, + "lastSummaryRefreshedTime": { + "type": "string", + "format": "date-time", + "description": "Last summary refresh time." + }, + "extendedSummary": { + "type": "object", + "description": "Extended summary.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource provisioning Successful." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource provisioning Failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource provisioning Canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Resource is being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "Gets or sets the state of public network access.", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "NotSpecified Network Access" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled Network Access" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled Network Access" + } + ] + } + }, + "RefreshSummaryState": { + "type": "string", + "description": "Refresh summary state.", + "enum": [ + "Started", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "RefreshSummaryState", + "modelAsString": true, + "values": [ + { + "name": "Started", + "value": "Started", + "description": "Started State" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress State" + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed State" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed State" + } + ] + } + }, + "ServerMigrationSpecificProperties": { + "type": "object", + "description": "Represents a Server Migration Specific properties base model.", + "properties": { + "drApplianceInventoryId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectableItems" + }, + { + "type": "Microsoft.OffAzure/VMwareSites/machines" + }, + { + "type": "Microsoft.OffAzure/ServerSites/machines" + } + ] + } + }, + "currentJobId": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.RecoveryServices/vaults/replicationJobs" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrationSpecificPropertiesBase" + } + ], + "x-ms-discriminator-value": "ServerMigration" + }, + "Strategy": { + "type": "string", + "description": "Strategy for migration to Azure", + "enum": [ + "None", + "Rehost", + "Refactor", + "Rearchitect", + "Rebuild", + "Replace", + "Retire", + "Retain", + "Replatform" + ], + "x-ms-enum": { + "name": "Strategy", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No specific strategy defined." + }, + { + "name": "Rehost", + "value": "Rehost", + "description": "Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification." + }, + { + "name": "Refactor", + "value": "Refactor", + "description": "Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities." + }, + { + "name": "Rearchitect", + "value": "Rearchitect", + "description": "Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure." + }, + { + "name": "Rebuild", + "value": "Rebuild", + "description": "Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services." + }, + { + "name": "Replace", + "value": "Replace", + "description": "Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform." + }, + { + "name": "Retire", + "value": "Retire", + "description": "Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform." + }, + { + "name": "Retain", + "value": "Retain", + "description": "Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right." + }, + { + "name": "Replatform", + "value": "Replatform", + "description": "Replatform: This strategy involves making more substantial changes to the application." + } + ] + } + }, + "Task": { + "type": "object", + "description": "Tasks resource.", + "properties": { + "properties": { + "$ref": "#/definitions/TaskProperties", + "description": "The resource-specific properties for this resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "TaskListResult": { + "type": "object", + "description": "The response of a Task list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Task items on this page", + "items": { + "$ref": "#/definitions/Task" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "TaskProperties": { + "type": "object", + "description": "Task Properties class.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "scopeId": { + "type": "string", + "format": "arm-id", + "description": "associated Wave Id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/migrateProjects/waves" + }, + { + "type": "Microsoft.Migrate/migrateProjects/migrationEntities" + }, + { + "type": "Microsoft.Migrate/migrateProjects/migrationEntityGroups" + } + ] + } + }, + "stage": { + "type": "string", + "description": "Task Stage" + }, + "taskType": { + "$ref": "#/definitions/TaskType", + "description": "Task Type", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Task Dislay Name " + }, + "isEditable": { + "type": "boolean", + "description": "Indicates whether the task is editable.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Task Status" + }, + "scope": { + "$ref": "#/definitions/TaskScope", + "description": "Task Scope" + }, + "description": { + "type": "string", + "description": "Task Description" + }, + "completionDate": { + "type": "string", + "format": "date-time", + "description": "Task completion Date", + "readOnly": true + } + }, + "required": [ + "scopeId", + "taskType", + "displayName", + "isEditable", + "status", + "scope" + ] + }, + "TaskScope": { + "type": "string", + "description": "TaskScope can be either 'Wave' or 'MigrationEntity' or 'MigrationEntityGroup'", + "enum": [ + "Wave", + "MigrationEntity", + "MigrationEntityGroup" + ], + "x-ms-enum": { + "name": "TaskScope", + "modelAsString": true, + "values": [ + { + "name": "Wave", + "value": "Wave", + "description": "Wave task - typically related to a specific wave of migration" + }, + { + "name": "MigrationEntity", + "value": "MigrationEntity", + "description": "Migration Entity task - typically related to a specific migration entity" + }, + { + "name": "MigrationEntityGroup", + "value": "MigrationEntityGroup", + "description": "Migration Entity Group task - typically related to a specific migration entity group" + } + ] + } + }, + "TaskStatusCountMap": { + "type": "object", + "description": "Task status count mapping.", + "properties": { + "status": { + "type": "string", + "description": "The task status." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The count of tasks with this status." + } + }, + "required": [ + "status", + "count" + ] + }, + "TaskStatusCounts": { + "type": "object", + "description": "Task Status Counts model.", + "properties": { + "statusCounts": { + "type": "array", + "description": "Status counts dictionary mapping TaskStatus to the count of tasks with that status.", + "items": { + "$ref": "#/definitions/TaskStatusCountMap" + }, + "x-ms-identifiers": [ + "status" + ] + } + }, + "required": [ + "statusCounts" + ] + }, + "TaskSummaryItem": { + "type": "object", + "description": "Task Summary Item model.", + "properties": { + "stage": { + "type": "string", + "description": "Task Stage" + }, + "aggregatedStatus": { + "type": "string", + "description": "Aggregated status of tasks in this stage." + }, + "statusCounts": { + "$ref": "#/definitions/TaskStatusCounts", + "description": "Counts of tasks in this stage by status." + }, + "tasks": { + "type": "array", + "description": "List of tasks in this stage.", + "items": { + "$ref": "#/definitions/Task" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "stage", + "aggregatedStatus", + "statusCounts", + "tasks" + ] + }, + "TaskSummaryRequest": { + "type": "object", + "description": "Task Summary Request model.", + "properties": { + "scopeId": { + "type": "string", + "format": "arm-id", + "description": "Task Scope ARM Id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Migrate/MigrateProjects/waves" + }, + { + "type": "Microsoft.Migrate/MigrationProjects/migrationEntityGroups" + }, + { + "type": "Microsoft.Migrate/MigrateProjects/migrationEntities" + } + ] + } + } + }, + "required": [ + "scopeId" + ] + }, + "TaskSummaryResponse": { + "type": "object", + "description": "Task Summary Response model.", + "properties": { + "items": { + "type": "array", + "description": "List of Task Summary Items", + "items": { + "$ref": "#/definitions/TaskSummaryItem" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "items" + ] + }, + "TaskType": { + "type": "string", + "description": "TaskType can be either 'User' or 'System'", + "enum": [ + "UserDefined", + "SystemDefined" + ], + "x-ms-enum": { + "name": "TaskType", + "modelAsString": true, + "values": [ + { + "name": "UserDefined", + "value": "UserDefined", + "description": "UserDefined task - typically initiated by a user" + }, + { + "name": "SystemDefined", + "value": "SystemDefined", + "description": "SystemDefined task - typically initiated by the system" + } + ] + } + }, + "Wave": { + "type": "object", + "description": "Migration Wave resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WaveProperties", + "description": "The resource-specific properties for this resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "WaveListResult": { + "type": "object", + "description": "The response of a Wave list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Wave items on this page", + "items": { + "$ref": "#/definitions/Wave" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WaveProperties": { + "type": "object", + "description": "Migration Wave Properties class.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the wave." + }, + "displayName": { + "type": "string", + "description": "Display Name of the wave." + }, + "arg": { + "$ref": "#/definitions/Arg", + "description": "ARG query and other details to create workloads within a wave" + }, + "status": { + "type": "string", + "description": "The status of the wave.", + "readOnly": true + }, + "plannedStartDate": { + "type": "string", + "format": "date-time", + "description": "Planned start date of the wave." + }, + "plannedCompletionDate": { + "type": "string", + "format": "date-time", + "description": "Planned completion date of the wave." + }, + "actualStartDate": { + "type": "string", + "format": "date-time", + "description": "Actual start date of the wave.", + "readOnly": true + }, + "stage": { + "type": "string", + "description": "The current stage of the wave.", + "readOnly": true + } + }, + "required": [ + "displayName", + "arg", + "plannedStartDate" + ] + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.go.md b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.go.md new file mode 100644 index 000000000000..1a78f5b1abab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.go.md @@ -0,0 +1,20 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) && $(track2) +license-header: MICROSOFT_MIT_NO_VERSION +module-name: sdk/resourcemanager/migrationwaves/armmigrationwaves +module: github.com/Azure/azure-sdk-for-go/$(module-name) +output-folder: $(go-sdk-folder)/$(module-name) +azure-arm: true +modelerfour: + lenient-model-deduplication: true +``` +### Tag: package-preview-2025-03 and go +These settings apply only when `--tag=package-preview-2025-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-preview-2025-03' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2025-03-30/$(namespace) +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.jsva.md b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.jsva.md new file mode 100644 index 000000000000..47ca379afd7c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.jsva.md @@ -0,0 +1,10 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +client-flattened-annotation-target: disabled +uuid-as-string: true +service-name: Migration Waves +title: MigrationWavesManagementClient +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.md b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.md new file mode 100644 index 000000000000..29eec9170714 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.md @@ -0,0 +1,39 @@ +# Azure Migrate + +> see https://aka.ms/autorest +This is the AutoRest configuration file for Azure Migrate - Waves. + +--- + +## Getting Started + +To build the SDK for Migrate, 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 API. + +``` yaml +openapi-type: arm +tag: package-preview-2025-03 +``` +### Tag: package-preview-2025-03 +These settings apply only when `--tag=package-preview-2025-03` is specified on the command line. + +```yaml $(tag) == 'package-preview-2025-03' +input-file: + - preview/2025-03-30-preview/waves.json +suppressions: + - code: AvoidAdditionalProperties + reason: AMH feature is widely adopted and requires additionalProperties for these swagger properties. + - code: DescriptionMustNotBeNodeName + reason: Migrate Project swagger is not in typespec. +``` diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.python.md b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.python.md new file mode 100644 index 000000000000..47d9a7f359ec --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.python.md @@ -0,0 +1,23 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +title: MigrationWaveMgmtClient +azure-arm: true +license-header: MICROSOFT_MIT_NO_VERSION +package-name: azure-mgmt-migrationwave +namespace: azure.mgmt.migrationwave +package-version: 1.0.0b1 +clear-output-folder: true +``` +``` yaml $(python) +no-namespace-folders: true +output-folder: $(python-sdks-folder)/migrate/azure-mgmt-migrationwave/azure/mgmt/migrationwave +``` +``` yaml $(python) +modelerfour: + flatten-models: false + lenient-model-deduplication: true +``` \ No newline at end of file diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.typescript.md b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.typescript.md new file mode 100644 index 000000000000..9a0bbf862256 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/Waves/readme.typescript.md @@ -0,0 +1,12 @@ +## 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-migrationwave" + output-folder: "$(typescript-sdks-folder)/sdk/migrate/arm-migrationwave" + generate-metadata: true +``` \ No newline at end of file diff --git a/specification/mission/Mission.Management/back-compatible.tsp b/specification/mission/Mission.Management/back-compatible.tsp new file mode 100644 index 000000000000..9c9b1e03dda1 --- /dev/null +++ b/specification/mission/Mission.Management/back-compatible.tsp @@ -0,0 +1,33 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./routes.tsp"; + +using Microsoft.Mission; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ApprovalResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CommunityEndpointResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CommunityResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EnclaveConnectionResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EnclaveEndpointResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(EnclaveResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TransitHubResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/mission/Mission.Management/main.tsp b/specification/mission/Mission.Management/main.tsp index 27d5aa86dee8..02e38b2cdef9 100644 --- a/specification/mission/Mission.Management/main.tsp +++ b/specification/mission/Mission.Management/main.tsp @@ -8,6 +8,7 @@ import "@azure-tools/typespec-azure-resource-manager"; import "./version.tsp"; import "./routes.tsp"; +import "./back-compatible.tsp"; using Azure.ResourceManager; using TypeSpec.Versioning; diff --git a/specification/mission/Mission.Management/tspconfig.yaml b/specification/mission/Mission.Management/tspconfig.yaml index 40c16633de49..08745729c2dc 100644 --- a/specification/mission/Mission.Management/tspconfig.yaml +++ b/specification/mission/Mission.Management/tspconfig.yaml @@ -3,8 +3,6 @@ emit: options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "./resource-manager" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/../" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" arm-types-dir: "{project-root}/../../common-types/resource-management" diff --git a/specification/monitor/Microsoft.Monitor.Management/back-compatible.tsp b/specification/monitor/Microsoft.Monitor.Management/back-compatible.tsp new file mode 100644 index 000000000000..c3e1578ec049 --- /dev/null +++ b/specification/monitor/Microsoft.Monitor.Management/back-compatible.tsp @@ -0,0 +1,16 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./typespec/azureMonitorWorkspace.tsp"; +import "./typespec/pipelineGroup.tsp"; + +using Microsoft.Monitor; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AzureMonitorWorkspace.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PipelineGroup.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/monitor/Microsoft.Monitor.Management/main.tsp b/specification/monitor/Microsoft.Monitor.Management/main.tsp index 4eed154f7fe1..f12f515d5c87 100644 --- a/specification/monitor/Microsoft.Monitor.Management/main.tsp +++ b/specification/monitor/Microsoft.Monitor.Management/main.tsp @@ -1,3 +1,4 @@ import "./typespec/service.tsp"; import "./typespec/azureMonitorWorkspace.tsp"; import "./typespec/pipelineGroup.tsp"; +import "./back-compatible.tsp"; diff --git a/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml b/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml index e342c030488c..077403c329bc 100644 --- a/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml +++ b/specification/monitor/Microsoft.Monitor.Management/tspconfig.yaml @@ -11,8 +11,6 @@ options: use-read-only-status-schema: true azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azuremonitor.json" new-line: lf diff --git a/specification/monitor/resource-manager/readme.java.md b/specification/monitor/resource-manager/readme.java.md index 3d017ee2ec5d..707ea24893d2 100644 --- a/specification/monitor/resource-manager/readme.java.md +++ b/specification/monitor/resource-manager/readme.java.md @@ -19,4 +19,40 @@ directive: where: '$.definitions.DiagnosticSettingsCategory.properties.categoryType' transform: > $["x-ms-enum"].modelAsString = false -``` \ No newline at end of file + - from: azuremonitorworkspace.json + where: '$.definitions.AlertSeverity' + transform: > + $["x-ms-enum"].name = "MonitorWorkspaceAlertSeverity" +``` + +### Tag: package-composite-v1-java + +``` yaml $(java) && $(tag) == 'package-composite-v1-java' +input-file: + - Microsoft.Insights/stable/2022-10-01/autoscale_API.json + - Microsoft.Insights/stable/2015-04-01/operations_API.json + - Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json + - https://github.com/Azure/azure-rest-api-specs/blob/c0f92082a788895368a738a9200e24971157d7ca/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRules_API.json + - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json + - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json + - Microsoft.Insights/stable/2022-06-01/actionGroups_API.json + - Microsoft.Insights/stable/2015-04-01/activityLogs_API.json + - Microsoft.Insights/stable/2015-04-01/eventCategories_API.json + - Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json + - Microsoft.Insights/stable/2021-05-01/metricDefinitions_API.json + - Microsoft.Insights/stable/2021-05-01/metrics_API.json + - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json + - Microsoft.Insights/preview/2024-03-01-preview/metricAlert_API.json + - Microsoft.Insights/stable/2023-12-01/scheduledQueryRule_API.json + - Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json + - Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json + - Microsoft.Insights/preview/2021-07-01-preview/privateLinkScopes_API.json + - Microsoft.Insights/stable/2020-10-01/activityLogAlerts_API.json + - Microsoft.Insights/stable/2024-03-11/dataCollectionEndpoints_API.json + - Microsoft.Insights/stable/2024-03-11/dataCollectionRuleAssociations_API.json + - Microsoft.Insights/stable/2024-03-11/dataCollectionRules_API.json + +# note that SDK repository has its own configure of "rename-model" +rename-model: MetricUnit:Unit,IdentityAutoGenerated:Identity,UserIdentityPropertiesAutoGenerated:UserIdentityProperties +``` diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index e1776eff90d3..2859143d83f3 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -227,7 +227,7 @@ input-file: - Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json - Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json - Microsoft.Insights/stable/2016-03-01/logProfiles_API.json - - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json + - Microsoft.Insights/preview/2024-03-01-preview/metricAlert_API.json - Microsoft.Insights/stable/2024-02-01/metricDefinitions_API.json - Microsoft.Insights/stable/2024-02-01/metricNamespaces_API.json - Microsoft.Insights/stable/2024-02-01/metrics_API.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/back-compatible.tsp b/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/back-compatible.tsp index 5c8130261c76..3022f65c7c50 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/back-compatible.tsp +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/back-compatible.tsp @@ -3,6 +3,15 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; using Microsoft.ManagedIdentity; +// Flatten properties for backward compatibility +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: added in TypeSpec migration, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SystemAssignedIdentity.properties, + "autorest" +); +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: added in TypeSpec migration, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Identity.properties, + "autorest" +); #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: added in TypeSpec migration, follow aka.ms/tsp/conversion-fix for details" @@Azure.ClientGenerator.Core.Legacy.flattenProperty(IdentityUpdate.properties); diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/tspconfig.yaml b/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/tspconfig.yaml index bdecf02f7aad..16d78a31e035 100644 --- a/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/tspconfig.yaml +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/ManagedIdentity/tspconfig.yaml @@ -12,7 +12,7 @@ options: output-file: "{version-status}/{version}/ManagedIdentity.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-msi" namespace: "azure.mgmt.msi" diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/models.tsp b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/models.tsp index 38c0cc6dc664..58aa58bf5915 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/models.tsp +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/models.tsp @@ -630,8 +630,8 @@ model ValidateBackupResponse { /** * The response properties of a pre backup operation. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ValidateBackupResponseProperties; } @@ -772,8 +772,8 @@ model ConfigurationForBatchUpdate { /** * The properties can be updated for a configuration. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ConfigurationForBatchUpdateProperties; } @@ -1249,8 +1249,8 @@ model ServerForUpdate { /** * The properties that can be updated for a server. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ServerPropertiesForUpdate; /** @@ -1404,8 +1404,8 @@ model AdvancedThreatProtectionForUpdate { /** * Resource update properties. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AdvancedThreatProtectionUpdateProperties; } @@ -1427,8 +1427,8 @@ model LogFile extends Azure.ResourceManager.CommonTypes.ProxyResource { /** * The properties of a logFile. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: LogFileProperties; } @@ -1906,8 +1906,6 @@ model OperationProgressResult /** * The response properties specific to the operation */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten properties?: OperationProgressResponseType; } @@ -2015,8 +2013,8 @@ model MaintenanceUpdate { /** * The properties of a maintenance update parameter */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: MaintenancePropertiesForUpdate; } @@ -2065,8 +2063,8 @@ model Provisioning extends Azure.ResourceManager.CommonTypes.ProxyResource { /** * The properties of provisioning. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: ProvisioningStateProperties; } diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-12-01-preview/openapi.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-12-01-preview/openapi.json index 3f95b4c12022..b53270271562 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-12-01-preview/openapi.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2024-12-01-preview/openapi.json @@ -6013,8 +6013,7 @@ "properties": { "properties": { "$ref": "#/definitions/OperationProgressResponseType", - "description": "The response properties specific to the operation", - "x-ms-client-flatten": true + "description": "The response properties specific to the operation" } }, "allOf": [ diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2025-06-01-preview/openapi.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2025-06-01-preview/openapi.json index 57e8c3a8b1ba..7009ab375c09 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2025-06-01-preview/openapi.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2025-06-01-preview/openapi.json @@ -6090,8 +6090,7 @@ "properties": { "properties": { "$ref": "#/definitions/OperationProgressResponseType", - "description": "The response properties specific to the operation", - "x-ms-client-flatten": true + "description": "The response properties specific to the operation" } }, "allOf": [ diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/openapi.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/openapi.json index 3b1b182f9623..afd427908924 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/openapi.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/openapi.json @@ -6013,8 +6013,7 @@ "properties": { "properties": { "$ref": "#/definitions/OperationProgressResponseType", - "description": "The response properties specific to the operation", - "x-ms-client-flatten": true + "description": "The response properties specific to the operation" } }, "allOf": [ diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/tspconfig.yaml b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/tspconfig.yaml index 990ce7617b1c..577f73c9946e 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/tspconfig.yaml +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/tspconfig.yaml @@ -10,16 +10,16 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{version-status}/{version}/openapi.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" emit-lro-options: "all" "@azure-tools/typespec-csharp": flavor: azure - package-dir: "Azure.ResourceManager.MySql" - package-name: "{package-dir}" + package-name: "Azure.ResourceManager.MySql" + namespace: "{package-name}.FlexibleServers" + emitter-output-dir: "{output-dir}/{service-dir}/{package-name}" clear-output-folder: true model-namespace: true - namespace: "{package-dir}.FlexibleServers" api-version: "2024-12-30" "@azure-tools/typespec-python": service-dir: "sdk/mysqlflexibleservers" diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/NetApp/tspconfig.yaml b/specification/netapp/resource-manager/Microsoft.NetApp/NetApp/tspconfig.yaml index 5de24f8eddfc..a0da69478e5e 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/NetApp/tspconfig.yaml +++ b/specification/netapp/resource-manager/Microsoft.NetApp/NetApp/tspconfig.yaml @@ -14,7 +14,7 @@ options: output-file: "{version-status}/{version}/netapp.json" emit-lro-options: "all" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" "@azure-tools/typespec-csharp": flavor: azure diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationGateway.json new file mode 100644 index 000000000000..ff3795821754 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationGateway.json @@ -0,0 +1,4187 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/applicationGateways/{applicationGatewayName}": { + "delete": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Delete", + "x-ms-examples": { + "Delete ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayDelete.json" + } + }, + "description": "Deletes the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Get", + "x-ms-examples": { + "Get ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayGet.json" + } + }, + "description": "Gets the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_CreateOrUpdate", + "description": "Creates or updates the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "Parameters supplied to the create or update application gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Application Gateway": { + "$ref": "./examples/ApplicationGatewayCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_UpdateTags", + "x-ms-examples": { + "Update Application Gateway tags": { + "$ref": "./examples/ApplicationGatewayUpdateTags.json" + } + }, + "description": "Updates the specified application gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_List", + "x-ms-examples": { + "Lists all application gateways in a resource group": { + "$ref": "./examples/ApplicationGatewayList.json" + } + }, + "description": "Lists all application gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAll", + "x-ms-examples": { + "Lists all application gateways in a subscription": { + "$ref": "./examples/ApplicationGatewayListAll.json" + } + }, + "description": "Gets all the application gateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Start", + "x-ms-examples": { + "Start Application Gateway": { + "$ref": "./examples/ApplicationGatewayStart.json" + } + }, + "description": "Starts the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Stop", + "x-ms-examples": { + "Stop Application Gateway": { + "$ref": "./examples/ApplicationGatewayStop.json" + } + }, + "description": "Stops the specified application gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealth", + "description": "Gets the backend health of the specified application gateway in a resource group.", + "x-ms-examples": { + "Get Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealthOnDemand", + "description": "Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.", + "x-ms-examples": { + "Test Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthTest.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + }, + { + "name": "probeRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGatewayOnDemandProbe" + }, + "description": "Request body for on-demand test probe operation." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthOnDemand" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources": { + "get": { + "tags": [ + "ApplicationGatewayPrivateLinkResources" + ], + "operationId": "ApplicationGatewayPrivateLinkResources_List", + "x-ms-examples": { + "Lists all private link resources on application gateway": { + "$ref": "./examples/ApplicationGatewayPrivateLinkResourceList.json" + } + }, + "description": "Lists all private link resources on an application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of private link resources on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}": { + "delete": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Delete", + "x-ms-examples": { + "Delete Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionDelete.json" + } + }, + "description": "Deletes the specified private endpoint connection on application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Update", + "description": "Updates the specified private endpoint connection on application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "Parameters supplied to update application gateway private endpoint connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting private endpoint connection on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection on application gateway.", + "x-ms-examples": { + "Get Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an application gateway private endpoint connection.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections": { + "get": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_List", + "x-ms-examples": { + "Lists all private endpoint connections on application gateway": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionList.json" + } + }, + "description": "Lists all private endpoint connections on an application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of private endpoint connections on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableServerVariables", + "x-ms-examples": { + "Get Available Server Variables": { + "$ref": "./examples/ApplicationGatewayAvailableServerVariablesGet.json" + } + }, + "description": "Lists all available server variables.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available server variables.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableServerVariablesResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableRequestHeaders", + "x-ms-examples": { + "Get Available Request Headers": { + "$ref": "./examples/ApplicationGatewayAvailableRequestHeadersGet.json" + } + }, + "description": "Lists all available request headers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available request headers.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableRequestHeadersResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableResponseHeaders", + "x-ms-examples": { + "Get Available Response Headers": { + "$ref": "./examples/ApplicationGatewayAvailableResponseHeadersGet.json" + } + }, + "description": "Lists all available response headers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available response headers.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableResponseHeadersResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableWafRuleSets", + "x-ms-examples": { + "Get Available Waf Rule Sets": { + "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" + } + }, + "description": "Lists all available web application firewall rule sets.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall rule sets.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslOptions", + "x-ms-examples": { + "Get Available Ssl Options": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" + } + }, + "description": "Lists available Ssl options for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", + "x-ms-examples": { + "Get Available Ssl Predefined Policies": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all SSL predefined policies for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_GetSslPredefinedPolicy", + "x-ms-examples": { + "Get Available Ssl Predefined Policy by name": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" + } + }, + "description": "Gets Ssl predefined policy with the specified policy name.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "predefinedPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of Ssl predefined policy." + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.", + "schema": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ApplicationGatewayOnDemandProbe": { + "properties": { + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used for the probe." + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "enableProbeProxyProtocolHeader": { + "type": "boolean", + "description": "Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to backend pool of application gateway to which probe request will be sent." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to backend http setting of application gateway to be used for test probe." + } + }, + "description": "Details of on demand test probe request." + }, + "ApplicationGatewayBackendHealthOnDemand": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference to an ApplicationGatewayBackendAddressPool resource." + }, + "backendHealthHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings", + "description": "Application gateway BackendHealthHttp settings." + } + }, + "description": "Result of on demand test probe." + }, + "ApplicationGatewayBackendHealth": { + "properties": { + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" + }, + "description": "A list of ApplicationGatewayBackendHealthPool resources." + } + }, + "description": "Response for ApplicationGatewayBackendHealth API service call." + }, + "ApplicationGatewayBackendHealthPool": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference to an ApplicationGatewayBackendAddressPool resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" + }, + "description": "List of ApplicationGatewayBackendHealthHttpSettings resources." + } + }, + "description": "Application gateway BackendHealth pool." + }, + "ApplicationGatewayBackendHealthHttpSettings": { + "properties": { + "backendHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", + "description": "Reference to an ApplicationGatewayBackendHttpSettings resource." + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" + }, + "description": "List of ApplicationGatewayBackendHealthServer resources." + } + }, + "description": "Application gateway BackendHealthHttp settings." + }, + "ApplicationGatewayBackendHealthServer": { + "properties": { + "address": { + "type": "string", + "description": "IP address or FQDN of backend server." + }, + "ipConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "Reference to IP configuration of backend server." + }, + "health": { + "type": "string", + "description": "Health of backend server.", + "enum": [ + "Unknown", + "Up", + "Down", + "Partial", + "Draining" + ], + "x-ms-enum": { + "name": "ApplicationGatewayBackendHealthServerHealth", + "modelAsString": true + } + }, + "healthProbeLog": { + "type": "string", + "description": "Health Probe Log." + } + }, + "description": "Application gateway backendhealth http settings." + }, + "ApplicationGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an application gateway SKU.", + "enum": [ + "Standard_Small", + "Standard_Medium", + "Standard_Large", + "WAF_Medium", + "WAF_Large", + "Standard_v2", + "WAF_v2", + "Basic" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an application gateway.", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2", + "Basic" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity (instance count) of an application gateway." + }, + "family": { + "type": "string", + "description": "Family of an application gateway SKU.", + "enum": [ + "Generation_1", + "Generation_2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuFamily", + "modelAsString": true + } + } + }, + "description": "SKU of an application gateway." + }, + "ApplicationGatewaySslPolicy": { + "properties": { + "disabledSslProtocols": { + "type": "array", + "description": "Ssl protocols to be disabled on application gateway.", + "items": { + "type": "string", + "$ref": "#/definitions/ProtocolsEnum" + } + }, + "policyType": { + "type": "string", + "description": "Type of Ssl Policy.", + "enum": [ + "Predefined", + "Custom", + "CustomV2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyType", + "modelAsString": true + } + }, + "policyName": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of Ssl predefined policy." + }, + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order to application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Application Gateway Ssl policy." + }, + "ApplicationGatewayClientAuthConfiguration": { + "properties": { + "verifyClientCertIssuerDN": { + "type": "boolean", + "description": "Verify client certificate issuer name on the application gateway." + }, + "verifyClientRevocation": { + "type": "string", + "description": "Verify client certificate revocation status.", + "enum": [ + "None", + "OCSP" + ], + "x-ms-enum": { + "name": "ApplicationGatewayClientRevocationOptions", + "modelAsString": true + } + }, + "verifyClientAuthMode": { + "type": "string", + "description": "Verify client Authentication mode.", + "enum": [ + "Strict", + "Passthrough" + ], + "x-ms-enum": { + "name": "ApplicationGatewayClientAuthVerificationModes", + "modelAsString": true + } + } + }, + "description": "Application gateway client authentication configuration." + }, + "ApplicationGatewayIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway IP configuration resource." + } + }, + "description": "Properties of IP configuration of an application gateway." + }, + "ApplicationGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the IP configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." + }, + "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authentication certificate resource." + } + }, + "description": "Authentication certificates properties of an application gateway." + }, + "ApplicationGatewayAuthenticationCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat", + "description": "Properties of the application gateway authentication certificate." + }, + "name": { + "type": "string", + "description": "Name of the authentication certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authentication certificates of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the trusted root certificate resource." + } + }, + "description": "Trusted Root certificates properties of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat", + "description": "Properties of the application gateway trusted root certificate." + }, + "name": { + "type": "string", + "description": "Name of the trusted root certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Trusted Root certificates of an application gateway." + }, + "ApplicationGatewayTrustedClientCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "validatedCertData": { + "readOnly": true, + "type": "string", + "description": "Validated certificate data." + }, + "clientCertIssuerDN": { + "readOnly": true, + "type": "string", + "description": "Distinguished name of client certificate issuer." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the trusted client certificate resource." + } + }, + "description": "Trusted client certificates properties of an application gateway." + }, + "ApplicationGatewayTrustedClientCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayTrustedClientCertificatePropertiesFormat", + "description": "Properties of the application gateway trusted client certificate." + }, + "name": { + "type": "string", + "description": "Name of the trusted client certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Trusted client certificates of an application gateway." + }, + "ApplicationGatewaySslCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." + }, + "password": { + "type": "string", + "description": "Password for the pfx file specified in data. Only applicable in PUT request." + }, + "publicCertData": { + "readOnly": true, + "type": "string", + "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the SSL certificate resource." + } + }, + "description": "Properties of SSL certificates of an application gateway." + }, + "ApplicationGatewaySslCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat", + "description": "Properties of the application gateway SSL certificate." + }, + "name": { + "type": "string", + "description": "Name of the SSL certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL certificates of an application gateway." + }, + "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress of the network interface IP Configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the PublicIP resource." + }, + "privateLinkConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the application gateway private link configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend IP configuration resource." + } + }, + "description": "Properties of Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway frontend IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the frontend IP configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendPortPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "Frontend port." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend port resource." + } + }, + "description": "Properties of Frontend port of an application gateway." + }, + "ApplicationGatewayFrontendPort": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat", + "description": "Properties of the application gateway frontend port." + }, + "name": { + "type": "string", + "description": "Name of the frontend port that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend port of an application gateway." + }, + "ApplicationGatewayBackendAddress": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fully qualified domain name (FQDN)." + }, + "ipAddress": { + "type": "string", + "description": "IP address." + } + }, + "description": "Backend address of an application gateway." + }, + "ApplicationGatewayBackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Collection of references to IPs defined in network interfaces." + }, + "backendAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddress" + }, + "description": "Backend addresses." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend address pool resource." + } + }, + "description": "Properties of Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat", + "description": "Properties of the application gateway backend address pool." + }, + "name": { + "type": "string", + "description": "Name of the backend address pool that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used to communicate with the backend." + }, + "cookieBasedAffinity": { + "type": "string", + "description": "Cookie based affinity.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCookieBasedAffinity", + "modelAsString": true + } + }, + "requestTimeout": { + "type": "integer", + "format": "int32", + "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway authentication certificates." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted root certificates." + }, + "connectionDraining": { + "$ref": "#/definitions/ApplicationGatewayConnectionDraining", + "description": "Connection draining of the backend http settings resource." + }, + "hostName": { + "type": "string", + "description": "Host header to be sent to the backend servers." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." + }, + "affinityCookieName": { + "type": "string", + "description": "Cookie name to use for the affinity cookie." + }, + "probeEnabled": { + "type": "boolean", + "description": "Whether the probe is enabled. Default value is false." + }, + "path": { + "type": "string", + "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." + }, + "dedicatedBackendConnection": { + "type": "boolean", + "description": "Enable or disable dedicated connection per backend server. Default is set to false." + }, + "validateCertChainAndExpiry": { + "type": "boolean", + "default": true, + "description": "Verify or skip both chain and expiry validations of the certificate on the backend server. Default is set to true." + }, + "validateSNI": { + "type": "boolean", + "default": true, + "description": "When enabled, verifies if the Common Name of the certificate provided by the backend server matches the Server Name Indication (SNI) value. Default value is true." + }, + "sniName": { + "type": "string", + "description": "Specify an SNI value to match the common name of the certificate on the backend. By default, the application gateway uses the incoming request’s host header as the SNI. Default value is null." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend HTTP settings resource." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendHttpSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat", + "description": "Properties of the application gateway backend HTTP settings." + }, + "name": { + "type": "string", + "description": "Name of the backend http settings that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendSettingsPropertiesFormat": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used to communicate with the backend." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted root certificates." + }, + "hostName": { + "type": "string", + "description": "Server name indication to be sent to the backend servers for Tls protocol." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false." + }, + "enableL4ClientIpPreservation": { + "type": "boolean", + "description": "Whether to send Proxy Protocol header to backend servers over TCP or TLS protocols. Default value is false." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend HTTP settings resource." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendSettings": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendSettingsPropertiesFormat", + "description": "Properties of the application gateway backend settings." + }, + "name": { + "type": "string", + "description": "Name of the backend settings that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewaySslProfilePropertiesFormat": { + "properties": { + "trustedClientCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted client certificates." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "clientAuthConfiguration": { + "$ref": "#/definitions/ApplicationGatewayClientAuthConfiguration", + "description": "Client authentication configuration of the application gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the HTTP listener resource." + } + }, + "description": "Properties of SSL profile of an application gateway." + }, + "ApplicationGatewaySslProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslProfilePropertiesFormat", + "description": "Properties of the application gateway SSL profile." + }, + "name": { + "type": "string", + "description": "Name of the SSL profile that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL profile of an application gateway." + }, + "ApplicationGatewayHttpListenerPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "Protocol of the HTTP listener." + }, + "hostName": { + "type": "string", + "description": "Host name of HTTP listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "sslProfile": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL profile resource of the application gateway." + }, + "requireServerNameIndication": { + "type": "boolean", + "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the HTTP listener resource." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the HTTP listener." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + }, + "hostNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Host names for HTTP Listener that allows special wildcard characters as well." + } + }, + "description": "Properties of HTTP listener of an application gateway." + }, + "ApplicationGatewayHttpListener": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat", + "description": "Properties of the application gateway HTTP listener." + }, + "name": { + "type": "string", + "description": "Name of the HTTP listener that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Http listener of an application gateway." + }, + "ApplicationGatewayListenerPropertiesFormat": { + "type": "object", + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "Protocol of the listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "sslProfile": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL profile resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the listener resource." + }, + "hostNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well." + } + }, + "description": "Properties of listener of an application gateway." + }, + "ApplicationGatewayListener": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayListenerPropertiesFormat", + "description": "Properties of the application gateway listener." + }, + "name": { + "type": "string", + "description": "Name of the listener that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Listener of an application gateway." + }, + "ApplicationGatewayPathRulePropertiesFormat": { + "properties": { + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Path rules of URL path map." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of URL path map path rule." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of URL path map path rule." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of URL path map path rule." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite rule set resource of URL path map path rule." + }, + "loadDistributionPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Load Distribution Policy resource of URL path map path rule." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the path rule resource." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + } + }, + "description": "Properties of path rule of an application gateway." + }, + "ApplicationGatewayPathRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat", + "description": "Properties of the application gateway path rule." + }, + "name": { + "type": "string", + "description": "Name of the path rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Path rule of URL path map of an application gateway." + }, + "ApplicationGatewayProbePropertiesFormat": { + "properties": { + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used for the probe." + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "unhealthyThreshold": { + "type": "integer", + "format": "int32", + "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "pickHostNameFromBackendSettings": { + "type": "boolean", + "description": "Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false." + }, + "minServers": { + "type": "integer", + "format": "int32", + "description": "Minimum number of servers that are always marked healthy. Default value is 0." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "enableProbeProxyProtocolHeader": { + "type": "boolean", + "description": "Whether to send Proxy Protocol header along with the Health Probe over TCP or TLS protocol. Default value is false." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the probe resource." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Basic, Standard_v2 and WAF_v2 only.", + "minimum": 1, + "maximum": 65535 + } + }, + "description": "Properties of probe of an application gateway." + }, + "ApplicationGatewayProbeHealthResponseMatch": { + "properties": { + "body": { + "type": "string", + "description": "Body that must be contained in the health response. Default value is empty." + }, + "statusCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." + } + }, + "description": "Application gateway probe health response match." + }, + "ApplicationGatewayProbe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat", + "description": "Properties of the application gateway probe." + }, + "name": { + "type": "string", + "description": "Name of the probe that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Probe of the application gateway." + }, + "ApplicationGatewayRequestRoutingRulePropertiesFormat": { + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false, + "maximum": 20000, + "exclusiveMaximum": false, + "description": "Priority of the request routing rule." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of the application gateway." + }, + "httpListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Http listener resource of the application gateway." + }, + "urlPathMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "URL path map resource of the application gateway." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite Rule Set resource in Basic rule of the application gateway." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of the application gateway." + }, + "loadDistributionPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Load Distribution Policy resource of the application gateway." + }, + "entraJWTValidationConfig": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Entra JWT validation configuration resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the request routing rule resource." + } + }, + "description": "Properties of request routing rule of the application gateway." + }, + "ApplicationGatewayRequestRoutingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat", + "description": "Properties of the application gateway request routing rule." + }, + "name": { + "type": "string", + "description": "Name of the request routing rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Request routing rule of an application gateway." + }, + "ApplicationGatewayRoutingRulePropertiesFormat": { + "type": "object", + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false, + "maximum": 20000, + "exclusiveMaximum": false, + "description": "Priority of the routing rule." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + }, + "backendSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend settings resource of the application gateway." + }, + "listener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Listener resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the request routing rule resource." + } + }, + "required": [ + "priority" + ], + "description": "Properties of routing rule of the application gateway." + }, + "ApplicationGatewayRoutingRule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRoutingRulePropertiesFormat", + "description": "Properties of the application gateway routing rule." + }, + "name": { + "type": "string", + "description": "Name of the routing rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Routing rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat", + "description": "Properties of the application gateway rewrite rule set." + }, + "name": { + "type": "string", + "description": "Name of the rewrite rule set that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Rewrite rule set of an application gateway." + }, + "ApplicationGatewayRewriteRuleSetPropertiesFormat": { + "properties": { + "rewriteRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRule" + }, + "description": "Rewrite rules in the rewrite rule set." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the rewrite rule set resource." + } + }, + "description": "Properties of rewrite rule set of the application gateway." + }, + "ApplicationGatewayRewriteRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the rewrite rule that is unique within an Application Gateway." + }, + "ruleSequence": { + "type": "integer", + "description": "Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet." + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleCondition" + }, + "description": "Conditions based on which the action set execution will be evaluated." + }, + "actionSet": { + "type": "object", + "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet", + "description": "Set of actions to be done as part of the rewrite Rule." + } + }, + "description": "Rewrite rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleCondition": { + "properties": { + "variable": { + "type": "string", + "description": "The condition parameter of the RewriteRuleCondition." + }, + "pattern": { + "type": "string", + "description": "The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition." + }, + "ignoreCase": { + "type": "boolean", + "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." + }, + "negate": { + "type": "boolean", + "description": "Setting this value as truth will force to check the negation of the condition given by the user." + } + }, + "description": "Set of conditions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayRewriteRuleActionSet": { + "properties": { + "requestHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Request Header Actions in the Action Set." + }, + "responseHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Response Header Actions in the Action Set." + }, + "urlConfiguration": { + "$ref": "#/definitions/ApplicationGatewayUrlConfiguration", + "description": "Url Configuration Action in the Action Set." + } + }, + "description": "Set of actions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayHeaderConfiguration": { + "properties": { + "headerName": { + "type": "string", + "description": "Header name of the header configuration." + }, + "headerValueMatcher": { + "type": "object", + "$ref": "#/definitions/HeaderValueMatcher", + "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" + }, + "headerValue": { + "type": "string", + "description": "Header value of the header configuration." + } + }, + "description": "Header configuration of the Actions set in Application Gateway." + }, + "HeaderValueMatcher": { + "type": "object", + "properties": { + "pattern": { + "type": "string", + "description": "The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite." + }, + "ignoreCase": { + "type": "boolean", + "description": "Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison." + }, + "negate": { + "type": "boolean", + "description": "Setting this value as truth will force to check the negation of the condition given by the user in the pattern field." + } + }, + "description": "An optional field under \"Rewrite Action\". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud" + }, + "ApplicationGatewayUrlConfiguration": { + "properties": { + "modifiedPath": { + "type": "string", + "description": "Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null." + }, + "modifiedQueryString": { + "type": "string", + "description": "Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null." + }, + "reroute": { + "type": "boolean", + "description": "If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false." + } + }, + "description": "Url configuration of the Actions set in Application Gateway." + }, + "ApplicationGatewayRedirectConfigurationPropertiesFormat": { + "properties": { + "redirectType": { + "type": "string", + "$ref": "#/definitions/RedirectTypeEnum", + "description": "HTTP redirection type." + }, + "targetListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to a listener to redirect the request to." + }, + "targetUrl": { + "type": "string", + "description": "Url to redirect the request to." + }, + "includePath": { + "type": "boolean", + "description": "Include path in the redirected url." + }, + "includeQueryString": { + "type": "boolean", + "description": "Include query string in the redirected url." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Request routing specifying redirect configuration." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Url path maps specifying default redirect configuration." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Path rules specifying redirect configuration." + } + }, + "description": "Properties of redirect configuration of the application gateway." + }, + "ApplicationGatewayRedirectConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat", + "description": "Properties of the application gateway redirect configuration." + }, + "name": { + "type": "string", + "description": "Name of the redirect configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Redirect configuration of an application gateway." + }, + "ApplicationGatewayPrivateLinkConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfigurationProperties", + "description": "Properties of the application gateway private link configuration." + }, + "name": { + "type": "string", + "description": "Name of the private link configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private Link Configuration on an application gateway." + }, + "ApplicationGatewayPrivateLinkConfigurationProperties": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfiguration" + }, + "description": "An array of application gateway private link ip configurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private link configuration." + } + }, + "description": "Properties of private link configuration on an application gateway." + }, + "ApplicationGatewayPrivateLinkIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfigurationProperties", + "description": "Properties of an application gateway private link ip configuration." + }, + "name": { + "type": "string", + "description": "The name of application gateway private link ip configuration." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The application gateway private link ip configuration." + }, + "ApplicationGatewayPrivateLinkIpConfigurationProperties": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource." + }, + "primary": { + "type": "boolean", + "description": "Whether the ip configuration is primary or not." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private link IP configuration." + } + }, + "description": "Properties of an application gateway private link IP configuration." + }, + "ApplicationGatewayPrivateLinkResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceProperties", + "description": "Properties of the application gateway private link resource." + }, + "name": { + "type": "string", + "description": "Name of the private link resource that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateLink Resource of an application gateway." + }, + "ApplicationGatewayPrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource." + }, + "ApplicationGatewayPrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResource" + }, + "description": "List of private link resources of an application gateway." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGatewayPrivateLinkResources API service call. Gets all private link resources for an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionProperties", + "description": "Properties of the application gateway private endpoint connection." + }, + "name": { + "type": "string", + "description": "Name of the private endpoint connection on an application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private Endpoint connection on an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private endpoint connection resource." + }, + "linkIdentifier": { + "readOnly": true, + "type": "string", + "description": "The consumer link id." + } + }, + "description": "Properties of Private Link Resource of an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "List of private endpoint connections on an application gateway." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGatewayPrivateEndpointConnection API service call. Gets all private endpoint connections for an application gateway." + }, + "ApplicationGatewayPropertiesFormat": { + "properties": { + "sku": { + "$ref": "#/definitions/ApplicationGatewaySku", + "description": "SKU of the application gateway resource." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "operationalState": { + "readOnly": true, + "type": "string", + "description": "Operational state of the application gateway resource.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping" + ], + "x-ms-enum": { + "name": "ApplicationGatewayOperationalState", + "modelAsString": true + } + }, + "gatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" + }, + "description": "Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate" + }, + "description": "Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "trustedClientCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayTrustedClientCertificate" + }, + "description": "Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "sslCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslCertificate" + }, + "description": "SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" + }, + "description": "Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "frontendPorts": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendPort" + }, + "description": "Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayProbe" + }, + "description": "Probes of the application gateway resource." + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" + }, + "description": "Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "backendSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendSettings" + }, + "description": "Backend settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "httpListeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHttpListener" + }, + "description": "Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayListener" + }, + "description": "Listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "sslProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslProfile" + }, + "description": "SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayUrlPathMap" + }, + "description": "URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" + }, + "description": "Request routing rules of the application gateway resource." + }, + "routingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRoutingRule" + }, + "description": "Routing rules of the application gateway resource." + }, + "rewriteRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet" + }, + "description": "Rewrite rules for the application gateway resource." + }, + "redirectConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" + }, + "description": "Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "webApplicationFirewallConfiguration": { + "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", + "description": "Web application firewall configuration." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + }, + "enableHttp2": { + "type": "boolean", + "description": "Whether HTTP2 is enabled on the application gateway resource." + }, + "enableFips": { + "type": "boolean", + "description": "Whether FIPS is enabled on the application gateway resource." + }, + "autoscaleConfiguration": { + "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", + "description": "Autoscale Configuration." + }, + "privateLinkConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfiguration" + }, + "description": "PrivateLink configurations on application gateway." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "Private Endpoint connections on application gateway." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway resource." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the application gateway resource." + }, + "forceFirewallPolicyAssociation": { + "type": "boolean", + "description": "If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config." + }, + "loadDistributionPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayLoadDistributionPolicy" + }, + "description": "Load distribution policies of the application gateway resource." + }, + "entraJWTValidationConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayEntraJWTValidationConfig" + }, + "description": "Entra JWT validation configurations for the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "globalConfiguration": { + "$ref": "#/definitions/ApplicationGatewayGlobalConfiguration", + "description": "Global Configuration." + }, + "defaultPredefinedSslPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "readOnly": true, + "description": "The default predefined SSL Policy applied on the application gateway resource." + } + }, + "description": "Properties of the application gateway." + }, + "ApplicationGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPropertiesFormat", + "description": "Properties of the application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the application gateway, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Application gateway resource." + }, + "ApplicationGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "List of an application gateways in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGateways API service call." + }, + "ApplicationGatewayUrlPathMapPropertiesFormat": { + "properties": { + "defaultBackendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend address pool resource of URL path map." + }, + "defaultBackendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend http settings resource of URL path map." + }, + "defaultRewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default Rewrite rule set resource of URL path map." + }, + "defaultRedirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default redirect configuration resource of URL path map." + }, + "defaultLoadDistributionPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default Load Distribution Policy resource of URL path map." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPathRule" + }, + "description": "Path rule of URL path map resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the URL path map resource." + } + }, + "description": "Properties of UrlPathMap of the application gateway." + }, + "ApplicationGatewayUrlPathMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat", + "description": "Properties of the application gateway URL path map." + }, + "name": { + "type": "string", + "description": "Name of the URL path map that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." + }, + "ApplicationGatewayWebApplicationFirewallConfiguration": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the web application firewall is enabled or not." + }, + "firewallMode": { + "type": "string", + "description": "Web application firewall mode.", + "enum": [ + "Detection", + "Prevention" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallMode", + "modelAsString": true + } + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the rule set type." + }, + "disabledRuleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" + }, + "description": "The disabled rule groups." + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether allow WAF to check request Body." + }, + "maxRequestBodySize": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size for WAF." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" + }, + "description": "The exclusion list." + } + }, + "required": [ + "enabled", + "firewallMode", + "ruleSetType", + "ruleSetVersion" + ], + "description": "Application gateway web application firewall configuration." + }, + "ApplicationGatewayAutoscaleConfiguration": { + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Lower bound on number of Application Gateway capacity." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "minimum": 2, + "exclusiveMinimum": false, + "description": "Upper bound on number of Application Gateway capacity." + } + }, + "required": [ + "minCapacity" + ], + "description": "Application Gateway autoscale configuration." + }, + "ApplicationGatewayConnectionDraining": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether connection draining is enabled or not." + }, + "drainTimeoutInSec": { + "type": "integer", + "format": "int32", + "maximum": 3600, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." + } + }, + "required": [ + "enabled", + "drainTimeoutInSec" + ], + "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration." + }, + "ApplicationGatewayFirewallDisabledRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the rule group that will be disabled." + }, + "rules": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." + } + }, + "required": [ + "ruleGroupName" + ], + "description": "Allows to disable rules within a rule group or an entire rule group." + }, + "ApplicationGatewayAvailableServerVariablesResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableServerVariables API service call." + }, + "ApplicationGatewayAvailableRequestHeadersResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableRequestHeaders API service call." + }, + "ApplicationGatewayAvailableResponseHeadersResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableResponseHeaders API service call." + }, + "ApplicationGatewayFirewallExclusion": { + "properties": { + "matchVariable": { + "type": "string", + "description": "The variable to be excluded." + }, + "selectorMatchOperator": { + "type": "string", + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + }, + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check." + }, + "ApplicationGatewayAvailableWafRuleSetsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" + }, + "description": "The list of application gateway rule sets." + } + }, + "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call." + }, + "ApplicationGatewayFirewallRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat", + "description": "Properties of the application gateway firewall rule set." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleSetPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall rule set." + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set." + }, + "tiers": { + "type": "array", + "description": "Tier of an application gateway that support the rule set.", + "items": { + "type": "string", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTierTypes", + "modelAsString": true + } + } + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ], + "description": "Properties of the web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the web application firewall rule group." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule group." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRule" + }, + "description": "The rules of the web application firewall rule group." + } + }, + "required": [ + "ruleGroupName", + "rules" + ], + "description": "A web application firewall rule group." + }, + "ApplicationGatewayFirewallRule": { + "properties": { + "ruleId": { + "type": "integer", + "format": "int32", + "description": "The identifier of the web application firewall rule." + }, + "ruleIdString": { + "type": "string", + "description": "The string representation of the web application firewall rule identifier." + }, + "state": { + "type": "string", + "description": "The string representation of the web application firewall rule state.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayWafRuleStateTypes", + "modelAsString": true + } + }, + "action": { + "type": "string", + "description": "The string representation of the web application firewall rule action.", + "enum": [ + "None", + "AnomalyScoring", + "Allow", + "Block", + "Log" + ], + "x-ms-enum": { + "name": "ApplicationGatewayWafRuleActionTypes", + "modelAsString": true + } + }, + "sensitivity": { + "type": "string", + "description": "The string representation of the web application firewall rule sensitivity.", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ApplicationGatewayWafRuleSensitivityTypes", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule." + } + }, + "required": [ + "ruleId" + ], + "description": "A web application firewall rule." + }, + "ApplicationGatewayAvailableSslOptions": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat", + "description": "Properties of the application gateway available SSL options." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { + "properties": { + "predefinedPolicies": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of available Ssl predefined policy." + }, + "defaultPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of the Ssl predefined policy applied by default to application gateway." + }, + "availableCipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "List of available Ssl cipher suites." + }, + "availableProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolsEnum" + }, + "description": "List of available Ssl protocols." + } + }, + "description": "Properties of ApplicationGatewayAvailableSslOptions." + }, + "ApplicationGatewayAvailableSslPredefinedPolicies": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + }, + "description": "List of available Ssl predefined policy." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewaySslPredefinedPolicy": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Ssl predefined policy." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat", + "description": "Properties of the application gateway SSL predefined policy." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "An Ssl predefined policy." + }, + "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { + "properties": { + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order for application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Properties of ApplicationGatewaySslPredefinedPolicy." + }, + "ApplicationGatewayCustomError": { + "properties": { + "statusCode": { + "type": "string", + "description": "Status code of the application gateway custom error.", + "enum": [ + "HttpStatus400", + "HttpStatus403", + "HttpStatus404", + "HttpStatus405", + "HttpStatus408", + "HttpStatus500", + "HttpStatus502", + "HttpStatus503", + "HttpStatus504" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCustomErrorStatusCode", + "modelAsString": true + } + }, + "customErrorPageUrl": { + "type": "string", + "description": "Error page URL of the application gateway custom error." + } + }, + "description": "Custom error of an application gateway." + }, + "PolicyNameEnum": { + "type": "string", + "description": "Ssl predefined policy name enums.", + "enum": [ + "AppGwSslPolicy20150501", + "AppGwSslPolicy20170401", + "AppGwSslPolicy20170401S", + "AppGwSslPolicy20220101", + "AppGwSslPolicy20220101S" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyName", + "modelAsString": true + } + }, + "ProtocolsEnum": { + "type": "string", + "description": "Ssl protocol enums.", + "enum": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2", + "TLSv1_3" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + }, + "CipherSuitesEnum": { + "type": "string", + "description": "Ssl cipher suites enums.", + "enum": [ + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslCipherSuite", + "modelAsString": true + } + }, + "RedirectTypeEnum": { + "type": "string", + "description": "Redirect type enum.", + "enum": [ + "Permanent", + "Found", + "SeeOther", + "Temporary" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + }, + "ApplicationGatewayProtocol": { + "type": "string", + "description": "Application Gateway protocol.", + "enum": [ + "Http", + "Https", + "Tcp", + "Tls" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true, + "values": [ + { + "value": "Http", + "description": "Supported for httpListeners and backendHttpSettingsCollection properties." + }, + { + "value": "Https", + "description": "Supported for httpListeners and backendHttpSettingsCollection properties." + }, + { + "value": "Tcp", + "description": "Supported for listeners and backendSettingsCollection properties." + }, + { + "value": "Tls", + "description": "Supported for listeners and backendSettingsCollection properties." + } + ] + } + }, + "ApplicationGatewayLoadDistributionPolicyPropertiesFormat": { + "properties": { + "loadDistributionTargets": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayLoadDistributionTarget" + }, + "description": "Load Distribution Targets resource of an application gateway." + }, + "loadDistributionAlgorithm": { + "$ref": "#/definitions/ApplicationGatewayLoadDistributionAlgorithmEnum", + "description": "Load Distribution Targets resource of an application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Load Distribution Policy resource." + } + }, + "description": "Properties of Load Distribution Policy of an application gateway." + }, + "ApplicationGatewayLoadDistributionPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayLoadDistributionPolicyPropertiesFormat", + "description": "Properties of the application gateway load distribution policy." + }, + "name": { + "type": "string", + "description": "Name of the load distribution policy that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Load Distribution Policy of an application gateway." + }, + "ApplicationGatewayLoadDistributionTargetPropertiesFormat": { + "properties": { + "weightPerServer": { + "type": "integer", + "format": "int32", + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "Weight per server. Range between 1 and 100." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + } + } + }, + "ApplicationGatewayLoadDistributionTarget": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayLoadDistributionTargetPropertiesFormat", + "description": "Properties of the application gateway load distribution target." + }, + "name": { + "type": "string", + "description": "Name of the load distribution policy that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Load Distribution Target of an application gateway." + }, + "ApplicationGatewayLoadDistributionAlgorithmEnum": { + "type": "string", + "description": "Load Distribution Algorithm enums.", + "enum": [ + "RoundRobin", + "LeastConnections", + "IpHash" + ], + "x-ms-enum": { + "name": "ApplicationGatewayLoadDistributionAlgorithm", + "modelAsString": true + } + }, + "ApplicationGatewayEntraJWTValidationConfigPropertiesFormat": { + "type": "object", + "properties": { + "unAuthorizedRequestAction": { + "type": "string", + "description": "Unauthorized request action.", + "enum": [ + "Deny", + "Allow" + ], + "x-ms-enum": { + "name": "ApplicationGatewayUnAuthorizedRequestAction", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "description": "The Tenant ID of the Microsoft Entra ID application." + }, + "clientId": { + "type": "string", + "description": "The Client ID of the Microsoft Entra ID application." + }, + "audiences": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of acceptable audience claims that can be present in the token (aud claim). A maximum of 5 audiences are permitted." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the entra jwt validation configuration resource." + } + }, + "description": "Properties of entra jwt validation configuration of the application gateway." + }, + "ApplicationGatewayEntraJWTValidationConfig": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayEntraJWTValidationConfigPropertiesFormat", + "description": "Properties of the application gateway entra jwt validation configuration." + }, + "name": { + "type": "string", + "description": "Name of the entra jwt validation configuration that is unique within an application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Entra JWT Validation Configuration of an application gateway." + }, + "ApplicationGatewayGlobalConfiguration": { + "properties": { + "enableRequestBuffering": { + "type": "boolean", + "description": "Enable request buffering." + }, + "enableResponseBuffering": { + "type": "boolean", + "description": "Enable response buffering." + } + }, + "description": "Application Gateway global configuration." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationGatewayWafDynamicManifests.json new file mode 100644 index 000000000000..a4a0aed47f80 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationGatewayWafDynamicManifests.json @@ -0,0 +1,257 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests/dafault": { + "get": { + "operationId": "ApplicationGatewayWafDynamicManifestsDefault_Get", + "description": "Gets the regional application gateway waf manifest.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region where the nrp are located at." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the regional application gateway waf manifest", + "schema": { + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets WAF default manifest": { + "$ref": "./examples/GetApplicationGatewayWafDynamicManifestsDefault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/applicationGatewayWafDynamicManifests": { + "get": { + "operationId": "ApplicationGatewayWafDynamicManifests_Get", + "description": "Gets the regional application gateway waf manifest.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region where the nrp are located at." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the regional application gateway waf manifest", + "schema": { + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets WAF manifests": { + "$ref": "./examples/GetApplicationGatewayWafDynamicManifests.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationGatewayWafDynamicManifestResultList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestResult" + }, + "description": "The list of application gateway waf manifest." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "type": "object", + "description": "Response for ApplicationGatewayWafDynamicManifests API service call." + }, + "ApplicationGatewayWafDynamicManifestResult": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayWafDynamicManifestPropertiesResult", + "description": "Properties of the ApplicationGatewayWafDynamicManifest ." + } + }, + "type": "object", + "description": "Response for ApplicationGatewayWafDynamicManifest API service call." + }, + "ApplicationGatewayWafDynamicManifestPropertiesResult": { + "description": "Properties of ApplicationGatewayWafDynamicManifest.", + "type": "object", + "properties": { + "defaultRuleSet": { + "description": "The default ruleset.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DefaultRuleSetPropertyFormat" + }, + "availableRuleSets": { + "description": "The available rulesets.", + "x-ms-client-flatten": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallManifestRuleSet" + }, + "x-ms-identifiers": [] + } + } + }, + "DefaultRuleSetPropertyFormat": { + "description": "the default web application firewall rule set.", + "type": "object", + "properties": { + "ruleSetType": { + "description": "The type of the web application firewall rule set.", + "type": "string" + }, + "ruleSetVersion": { + "description": "The version of the web application firewall rule set type.", + "type": "string" + } + } + }, + "ApplicationGatewayFirewallManifestRuleSet": { + "description": "Properties of the web application firewall rule set.", + "type": "object", + "properties": { + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "status": { + "type": "string", + "description": "The rule set status", + "enum": [ + "Preview", + "GA", + "Supported", + "Deprecated" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRuleSetStatusOptions", + "modelAsString": true + } + }, + "tiers": { + "type": "array", + "description": "Tier of an application gateway that support the rule set.", + "items": { + "type": "string", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTierTypes", + "modelAsString": true + } + } + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "applicationGateway.json#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set.", + "x-ms-identifiers": [] + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationSecurityGroup.json new file mode 100644 index 000000000000..fb537cc92b18 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/applicationSecurityGroup.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/applicationSecurityGroups/{applicationSecurityGroupName}": { + "delete": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Delete", + "description": "Deletes the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete application security group": { + "$ref": "./examples/ApplicationSecurityGroupDelete.json" + } + } + }, + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Get", + "description": "Gets information about the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get application security group": { + "$ref": "./examples/ApplicationSecurityGroupGet.json" + } + } + }, + "put": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_CreateOrUpdate", + "description": "Creates or updates an application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "Parameters supplied to the create or update ApplicationSecurityGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create application security group": { + "$ref": "./examples/ApplicationSecurityGroupCreate.json" + } + } + }, + "patch": { + "tags": [ + "applicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_UpdateTags", + "description": "Updates an application security group's tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update application security group tags": { + "$ref": "./examples/ApplicationSecurityGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_ListAll", + "description": "Gets all application security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all application security groups": { + "$ref": "./examples/ApplicationSecurityGroupListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_List", + "description": "Gets all the application security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { + "$ref": "./examples/ApplicationSecurityGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat", + "description": "Properties of the application security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "An application security group in a resource group." + }, + "ApplicationSecurityGroupPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application security group resource." + } + }, + "description": "Application security group properties." + }, + "ApplicationSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "A list of application security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of application security groups." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/availableDelegations.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/availableDelegations.json new file mode 100644 index 000000000000..210a5c8498cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/availableDelegations.json @@ -0,0 +1,178 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableDelegations_List", + "description": "Gets all of the available subnet delegations for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available delegations": { + "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableResourceGroupDelegations_List", + "description": "Gets all of the available subnet delegations for this resource group in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available delegations in the resource group": { + "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableDelegationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableDelegation" + }, + "description": "An array of available delegations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available delegations." + }, + "AvailableDelegation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the AvailableDelegation resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailableDelegation resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "serviceName": { + "type": "string", + "description": "The name of the service and resource." + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The actions permitted to the service upon delegation." + } + }, + "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/availableServiceAliases.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/availableServiceAliases.json new file mode 100644 index 000000000000..dbdf222fa009 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/availableServiceAliases.json @@ -0,0 +1,171 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/availableServiceAliases": { + "get": { + "operationId": "AvailableServiceAliases_List", + "description": "Gets all available service aliases for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all available service aliases for the subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableServiceAliasesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available service aliases": { + "$ref": "./examples/AvailableServiceAliasesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableServiceAliases": { + "get": { + "operationId": "AvailableServiceAliases_ListByResourceGroup", + "description": "Gets all available service aliases for this resource group in this region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all available service aliases for the resource group in the region.", + "schema": { + "$ref": "#/definitions/AvailableServiceAliasesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available service aliases in the resource group": { + "$ref": "./examples/AvailableServiceAliasesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableServiceAlias": { + "properties": { + "name": { + "type": "string", + "description": "The name of the service alias." + }, + "id": { + "type": "string", + "description": "The ID of the service alias." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "resourceName": { + "type": "string", + "description": "The resource name of the service alias." + } + }, + "description": "The available service alias." + }, + "AvailableServiceAliasesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableServiceAlias" + }, + "description": "An array of available service aliases." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available service aliases." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureFirewall.json new file mode 100644 index 000000000000..9ce717b1516f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureFirewall.json @@ -0,0 +1,1480 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/azureFirewalls/{azureFirewallName}": { + "delete": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_Delete", + "description": "Deletes the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Azure Firewall": { + "$ref": "./examples/AzureFirewallDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_Get", + "description": "Gets the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Firewall": { + "$ref": "./examples/AzureFirewallGet.json" + }, + "Get Azure Firewall With Zones": { + "$ref": "./examples/AzureFirewallGetWithZones.json" + }, + "Get Azure Firewall With management subnet": { + "$ref": "./examples/AzureFirewallGetWithMgmtSubnet.json" + }, + "Get Azure Firewall With Additional Properties": { + "$ref": "./examples/AzureFirewallGetWithAdditionalProperties.json" + }, + "Get Azure Firewall With IpGroups": { + "$ref": "./examples/AzureFirewallGetWithIpGroups.json" + } + } + }, + "put": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_CreateOrUpdate", + "description": "Creates or updates the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 56, + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureFirewall" + }, + "description": "Parameters supplied to the create or update Azure Firewall operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Azure Firewall": { + "$ref": "./examples/AzureFirewallPut.json" + }, + "Create Azure Firewall With Zones": { + "$ref": "./examples/AzureFirewallPutWithZones.json" + }, + "Create Azure Firewall With management subnet": { + "$ref": "./examples/AzureFirewallPutWithMgmtSubnet.json" + }, + "Create Azure Firewall in virtual Hub": { + "$ref": "./examples/AzureFirewallPutInHub.json" + }, + "Create Azure Firewall With Additional Properties": { + "$ref": "./examples/AzureFirewallPutWithAdditionalProperties.json" + }, + "Create Azure Firewall With IpGroups": { + "$ref": "./examples/AzureFirewallPutWithIpGroups.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_UpdateTags", + "description": "Updates tags of an Azure Firewall resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update azure firewall tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Azure Firewall Tags": { + "$ref": "./examples/AzureFirewallUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls": { + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_List", + "description": "Lists all Azure Firewalls in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of AzureFirewall resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewalls for a given resource group": { + "$ref": "./examples/AzureFirewallListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls": { + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_ListAll", + "description": "Gets all the Azure Firewalls in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of AzureFirewall resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewalls for a given subscription": { + "$ref": "./examples/AzureFirewallListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}/learnedIPPrefixes": { + "post": { + "operationId": "AzureFirewalls_ListLearnedPrefixes", + "description": "Retrieves a list of all IP prefixes that azure firewall has learned to not SNAT.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the azure firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learnt SNAT IP prefixes for no SNAT.", + "schema": { + "$ref": "#/definitions/IPPrefixesList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AzureFirewallListLearnedPrefixes": { + "$ref": "./examples/AzureFirewallListLearnedIPPrefixes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}/packetCapture": { + "post": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_PacketCapture", + "description": "Runs a packet capture on AzureFirewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 56, + "pattern": "^[a-zA-Z0-9]", + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPacketCaptureParameters" + }, + "description": "Parameters supplied to run packet capture on azure firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AzureFirewallPacketCapture": { + "$ref": "./examples/AzureFirewallPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}/packetCaptureOperation": { + "post": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_PacketCaptureOperation", + "description": "Runs a packet capture operation on AzureFirewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][\\w\\-._]{0,54}[A-Za-z0-9_]$", + "description": "The name of the azure firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPacketCaptureParameters" + }, + "description": "Parameters supplied to run packet capture on azure firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Azure Firewall Packet Capture Response", + "schema": { + "$ref": "#/definitions/AzureFirewallPacketCaptureResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AzureFirewallPacketCaptureOperation": { + "$ref": "./examples/AzureFirewallPacketCaptureOperation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "AzureFirewallIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "readOnly": true, + "description": "The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the PublicIP resource. This field is a mandatory input if subnet is not null." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall IP configuration resource." + } + }, + "description": "Properties of IP configuration of an Azure Firewall." + }, + "AzureFirewallIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallIPConfigurationPropertiesFormat", + "description": "Properties of the azure firewall IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an Azure Firewall." + }, + "AzureFirewallPublicIPAddress": { + "properties": { + "address": { + "type": "string", + "description": "Public IP Address value." + } + }, + "description": "Public IP Address associated with azure firewall." + }, + "AzureFirewallIpGroups": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource ID." + }, + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number." + } + }, + "description": "IpGroups associated with azure firewall." + }, + "HubPublicIPAddresses": { + "properties": { + "addresses": { + "type": "array", + "description": "The list of Public IP addresses associated with azure firewall or IP addresses to be retained.", + "items": { + "$ref": "#/definitions/AzureFirewallPublicIPAddress" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of Public IP addresses associated with azure firewall." + } + }, + "description": "Public IP addresses associated with azure firewall." + }, + "HubIPAddresses": { + "properties": { + "publicIPs": { + "description": "Public IP addresses associated with azure firewall.", + "$ref": "#/definitions/HubPublicIPAddresses" + }, + "privateIPAddress": { + "type": "string", + "description": "Private IP Address associated with azure firewall." + } + }, + "description": "IP addresses associated with azure firewall." + }, + "IpGroups": { + "type": "array", + "description": "List of IpGroups associated with azure firewall.", + "items": { + "$ref": "#/definitions/AzureFirewallIpGroups" + } + }, + "AzureFirewallPropertiesFormat": { + "properties": { + "applicationRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRuleCollection" + }, + "description": "Collection of application rule collections used by Azure Firewall." + }, + "natRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNatRuleCollection" + }, + "description": "Collection of NAT rule collections used by Azure Firewall." + }, + "networkRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleCollection" + }, + "description": "Collection of network rule collections used by Azure Firewall." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallIPConfiguration" + }, + "description": "IP configuration of the Azure Firewall resource." + }, + "managementIpConfiguration": { + "$ref": "#/definitions/AzureFirewallIPConfiguration", + "description": "IP configuration of the Azure Firewall used for management traffic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall resource." + }, + "threatIntelMode": { + "description": "The operation mode for Threat Intelligence.", + "$ref": "#/definitions/AzureFirewallThreatIntelMode" + }, + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The virtualHub to which the firewall belongs." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The firewallPolicy associated with this azure firewall." + }, + "hubIPAddresses": { + "description": "IP addresses associated with AzureFirewall.", + "$ref": "#/definitions/HubIPAddresses" + }, + "ipGroups": { + "readOnly": true, + "description": "IpGroups associated with AzureFirewall.", + "$ref": "#/definitions/IpGroups" + }, + "sku": { + "description": "The Azure Firewall Resource SKU.", + "$ref": "#/definitions/AzureFirewallSku" + }, + "additionalProperties": { + "$ref": "#/definitions/AzureFirewallAdditionalProperties", + "description": "The additional properties used to further config this azure firewall." + }, + "autoscaleConfiguration": { + "$ref": "#/definitions/AzureFirewallAutoscaleConfiguration", + "description": "Properties to provide a custom autoscale configuration to this azure firewall." + } + }, + "description": "Properties of the Azure Firewall." + }, + "AzureFirewall": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallPropertiesFormat", + "description": "Properties of the azure firewall." + }, + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of type local virtual network gateway." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall resource." + }, + "AzureFirewallListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewall" + }, + "description": "List of Azure Firewalls in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureFirewalls API service call." + }, + "AzureFirewallThreatIntelMode": { + "type": "string", + "description": "The operation mode for Threat Intel.", + "enum": [ + "Alert", + "Deny", + "Off" + ], + "x-ms-enum": { + "name": "AzureFirewallThreatIntelMode", + "modelAsString": true + } + }, + "AzureFirewallAdditionalProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The additional properties of azure firewall." + }, + "AzureFirewallApplicationRuleCollectionPropertiesFormat": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the application rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallRCAction", + "description": "The action type of a rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRule" + }, + "description": "Collection of rules used by a application rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application rule collection resource." + } + }, + "description": "Properties of the application rule collection." + }, + "AzureFirewallApplicationRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall application rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Application rule collection resource." + }, + "AzureFirewallApplicationRuleProtocol": { + "properties": { + "protocolType": { + "description": "Protocol type.", + "$ref": "#/definitions/AzureFirewallApplicationRuleProtocolType" + }, + "port": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "description": "Port number for the protocol, cannot be greater than 64000. This field is optional." + } + }, + "description": "Properties of the application rule protocol." + }, + "AzureFirewallApplicationRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the application rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRuleProtocol" + }, + "description": "Array of ApplicationRuleProtocols." + }, + "targetFqdns": { + "type": "array", + "description": "List of FQDNs for this rule.", + "items": { + "type": "string" + } + }, + "fqdnTags": { + "type": "array", + "description": "List of FQDN Tags for this rule.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of an application rule." + }, + "AzureFirewallNatRuleCollectionProperties": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the NAT rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallNatRCAction", + "description": "The action type of a NAT rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNatRule" + }, + "description": "Collection of rules used by a NAT rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT rule collection resource." + } + }, + "description": "Properties of the NAT rule collection." + }, + "AzureFirewallNatRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNatRuleCollectionProperties", + "description": "Properties of the azure firewall NAT rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NAT rule collection resource." + }, + "AzureFirewallNatRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the NAT rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description": "Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." + }, + "translatedAddress": { + "type": "string", + "description": "The translated address for this NAT rule." + }, + "translatedPort": { + "type": "string", + "description": "The translated port for this NAT rule." + }, + "translatedFqdn": { + "type": "string", + "description": "The translated FQDN for this NAT rule." + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of a NAT rule." + }, + "AzureFirewallNatRCAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/AzureFirewallNatRCActionType" + } + }, + "description": "AzureFirewall NAT Rule Collection Action." + }, + "AzureFirewallNatRCActionType": { + "type": "string", + "description": "The action type of a NAT rule collection.", + "enum": [ + "Snat", + "Dnat" + ], + "x-ms-enum": { + "name": "AzureFirewallNatRCActionType", + "modelAsString": true + } + }, + "AzureFirewallNetworkRuleCollectionPropertiesFormat": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the network rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallRCAction", + "description": "The action type of a rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRule" + }, + "description": "Collection of rules used by a network rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network rule collection resource." + } + }, + "description": "Properties of the network rule collection." + }, + "AzureFirewallNetworkRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall network rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network rule collection resource." + }, + "AzureFirewallNetworkRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the network rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description": "Array of AzureFirewallNetworkRuleProtocols." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "destinationFqdns": { + "type": "array", + "description": "List of destination FQDNs.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + }, + "destinationIpGroups": { + "type": "array", + "description": "List of destination IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of the network rule." + }, + "AzureFirewallRCAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/AzureFirewallRCActionType" + } + }, + "description": "Properties of the AzureFirewallRCAction." + }, + "AzureFirewallRCActionType": { + "type": "string", + "description": "The action type of a rule collection.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "AzureFirewallRCActionType", + "modelAsString": true + } + }, + "AzureFirewallNetworkRuleProtocol": { + "type": "string", + "description": "The protocol of a Network Rule resource.", + "enum": [ + "TCP", + "UDP", + "Any", + "ICMP" + ], + "x-ms-enum": { + "name": "AzureFirewallNetworkRuleProtocol", + "modelAsString": true + } + }, + "AzureFirewallApplicationRuleProtocolType": { + "type": "string", + "description": "The protocol type of a Application Rule resource.", + "enum": [ + "Http", + "Https", + "Mssql" + ], + "x-ms-enum": { + "name": "AzureFirewallApplicationRuleProtocolType", + "modelAsString": true + } + }, + "AzureFirewallSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an Azure Firewall SKU.", + "enum": [ + "AZFW_VNet", + "AZFW_Hub" + ], + "x-ms-enum": { + "name": "AzureFirewallSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an Azure Firewall.", + "enum": [ + "Standard", + "Premium", + "Basic" + ], + "x-ms-enum": { + "name": "AzureFirewallSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of an Azure Firewall." + }, + "IPPrefixesList": { + "type": "object", + "properties": { + "ipPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IP Prefix value." + } + }, + "description": "List of SNAT IP Prefixes learnt by firewall to not SNAT" + }, + "FirewallPacketCaptureParameters": { + "type": "object", + "properties": { + "durationInSeconds": { + "type": "integer", + "format": "int32", + "maximum": 1800, + "exclusiveMaximum": false, + "minimum": 30, + "exclusiveMinimum": false, + "default": 60, + "description": "Duration of packet capture in seconds. If the field is not provided, the default value is 60." + }, + "numberOfPacketsToCapture": { + "type": "integer", + "format": "int32", + "maximum": 90000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "default": 1000, + "description": "Number of packets to be captured. If the field is not provided, the default value is 1000." + }, + "sasUrl": { + "type": "string", + "description": "Upload capture location" + }, + "fileName": { + "type": "string", + "description": "Name of file to be uploaded to sasURL" + }, + "protocol": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol", + "description": "The protocol of packets to capture" + }, + "flags": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallPacketCaptureFlags" + }, + "description": "The tcp-flag type to be captured. Used with protocol TCP", + "x-ms-identifiers": [] + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallPacketCaptureRule" + }, + "description": "Rules to filter packet captures.", + "x-ms-identifiers": [] + }, + "operation": { + "$ref": "#/definitions/AzureFirewallPacketCaptureOperationType", + "description": "The Azure Firewall packet capture operation to perform" + } + }, + "description": "Azure Firewall Packet Capture Parameters." + }, + "AzureFirewallPacketCaptureFlags": { + "type": "object", + "properties": { + "type": { + "description": "Flags to capture", + "$ref": "#/definitions/AzureFirewallPacketCaptureFlagsType" + } + }, + "description": "Properties of the AzureFirewallRCAction." + }, + "AzureFirewallPacketCaptureFlagsType": { + "type": "string", + "description": "The flags type to be captured.", + "enum": [ + "fin", + "syn", + "rst", + "push", + "ack", + "urg" + ], + "x-ms-enum": { + "name": "AzureFirewallPacketCaptureFlagsType", + "modelAsString": true + } + }, + "AzureFirewallPacketCaptureRule": { + "type": "object", + "properties": { + "sources": { + "type": "array", + "description": "List of source IP addresses/subnets to be captured.", + "items": { + "type": "string" + } + }, + "destinations": { + "type": "array", + "description": "List of destination IP addresses/subnets to be captured.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of ports to be captured.", + "items": { + "type": "string" + } + } + }, + "description": "Group of src/dest ips and ports to be captured." + }, + "AzureFirewallAutoscaleConfiguration": { + "type": "object", + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 2, + "description": "The minimum number of capacity units for this azure firewall. Use null to reset the value to the service default.", + "x-nullable": true + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "minimum": 2, + "description": "The maximum number of capacity units for this azure firewall. Use null to reset the value to the service default.", + "x-nullable": true + } + }, + "description": "Azure Firewall Autoscale Configuration parameters." + }, + "AzureFirewallPacketCaptureResponse": { + "type": "object", + "properties": { + "statusCode": { + "$ref": "#/definitions/AzureFirewallPacketCaptureResponseCode", + "description": "The response code of the performed packet capture operation" + }, + "message": { + "type": "string", + "description": "Localized Message String of The Result Of The Azure Firewall Packet Capture Operation" + } + }, + "description": "Response of an Azure Firewall Packet Capture Operation." + }, + "AzureFirewallPacketCaptureOperationType": { + "type": "string", + "description": "The packet capture operation to perform. If the Start operation is selected, please provide all the fields in the firewallPacketCaptureParameters to successfully initiate the packet capture. If the Status or Stop operation is selected, only the operation field is required; all other fields in the firewallPacketCaptureParameters can be omitted to successfully retrieve the capture status or stop the capture.", + "enum": [ + "Start", + "Status", + "Stop" + ], + "default": "Start", + "x-ms-enum": { + "name": "AzureFirewallPacketCaptureOperationType", + "modelAsString": true + } + }, + "AzureFirewallPacketCaptureResponseCode": { + "type": "string", + "description": "The packet capture operation response codes.", + "enum": [ + "NotImplemented", + "AzureFirewallPacketCaptureStartSucceeded", + "AzureFirewallPacketCaptureStartFailed", + "AzureFirewallPacketCaptureStartFailedToUpload", + "AzureFirewallPacketCaptureStartFailure", + "AzureFirewallPacketCaptureInProgress", + "AzureFirewallPacketCaptureNotInProgress", + "AzureFirewallPacketCaptureStopSucceeded", + "AzureFirewallPacketCaptureFailed", + "AzureFirewallPacketCaptureCompleted" + ], + "x-ms-enum": { + "name": "AzureFirewallPacketCaptureResponseCode", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureFirewallFqdnTag.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureFirewallFqdnTag.json new file mode 100644 index 000000000000..46d5a7683f5b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureFirewallFqdnTag.json @@ -0,0 +1,130 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/azureFirewallFqdnTags": { + "get": { + "tags": [ + "AzureFirewallFqdnTags" + ], + "operationId": "AzureFirewallFqdnTags_ListAll", + "description": "Gets all the Azure Firewall FQDN Tags in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Azure Firewall FQDN Tag resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallFqdnTagListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewall FQDN Tags for a given subscription": { + "$ref": "./examples/AzureFirewallFqdnTagsListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AzureFirewallFqdnTagPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall FQDN tag resource." + }, + "fqdnTagName": { + "type": "string", + "readOnly": true, + "description": "The name of this FQDN Tag." + } + }, + "description": "Azure Firewall FQDN Tag Properties." + }, + "AzureFirewallFqdnTag": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat", + "description": "Properties of the azure firewall FQDN tag." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall FQDN Tag Resource." + }, + "AzureFirewallFqdnTagListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallFqdnTag" + }, + "description": "List of Azure Firewall FQDN Tags in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureFirewallFqdnTags API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureWebCategory.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureWebCategory.json new file mode 100644 index 000000000000..21843e9545bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/azureWebCategory.json @@ -0,0 +1,184 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/azureWebCategories/{name}": { + "get": { + "tags": [ + "WebCategories" + ], + "operationId": "WebCategories_Get", + "description": "Gets the specified Azure Web Category.", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the azureWebCategory." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands resourceIds back referenced by the azureWebCategory resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting azureWebCategory resource.", + "schema": { + "$ref": "#/definitions/AzureWebCategory" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Web Category by name": { + "$ref": "./examples/AzureWebCategoryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories": { + "get": { + "tags": [ + "WebCategories" + ], + "operationId": "WebCategories_ListBySubscription", + "description": "Gets all the Azure Web Categories in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Azure Web Category resources.", + "schema": { + "$ref": "#/definitions/AzureWebCategoryListResult" + } + }, + "default": { + "description": "Unexpected Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Web Categories for a given subscription": { + "$ref": "./examples/AzureWebCategoriesListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AzureWebCategoryPropertiesFormat": { + "properties": { + "group": { + "type": "string", + "readOnly": true, + "description": "The name of the group that the category belongs to." + } + }, + "description": "Azure Web Category Properties." + }, + "AzureWebCategory": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureWebCategoryPropertiesFormat", + "description": "Properties of the Azure Web Category." + }, + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Azure Web Category Resource." + }, + "AzureWebCategoryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureWebCategory" + }, + "description": "List of Azure Web Categories for a given Subscription." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureWebCategories API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/bastionHost.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/bastionHost.json new file mode 100644 index 000000000000..fa2039ebe38b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/bastionHost.json @@ -0,0 +1,1124 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/bastionHosts/{bastionHostName}": { + "delete": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_Delete", + "description": "Deletes the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Bastion Host": { + "$ref": "./examples/BastionHostDelete.json" + }, + "Delete Developer Bastion Host": { + "$ref": "./examples/BastionHostDeveloperDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_Get", + "description": "Gets the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an BastionHost resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Bastion Host": { + "$ref": "./examples/BastionHostGet.json" + }, + "Get Developer Bastion Host": { + "$ref": "./examples/BastionHostDeveloperGet.json" + }, + "Get Bastion Host With Zones": { + "$ref": "./examples/BastionHostGetWithZones.json" + }, + "Get Bastion Host With Private Only": { + "$ref": "./examples/BastionHostGetWithPrivateOnly.json" + } + } + }, + "put": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_CreateOrUpdate", + "description": "Creates or updates the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionHost" + }, + "description": "Parameters supplied to the create or update Bastion Host operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting Bastion Host resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting Bastion Host resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Bastion Host": { + "$ref": "./examples/BastionHostPut.json" + }, + "Create Bastion Host With Zones": { + "$ref": "./examples/BastionHostPutWithZones.json" + }, + "Create Bastion Host With Private Only": { + "$ref": "./examples/BastionHostPutWithPrivateOnly.json" + }, + "Create Developer Bastion Host": { + "$ref": "./examples/BastionHostDeveloperPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_UpdateTags", + "description": "Updates Tags for BastionHost resource", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update BastionHost tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting BastionHost resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Patch Bastion Host": { + "$ref": "./examples/BastionHostPatch.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts": { + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_List", + "description": "Lists all Bastion Hosts in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Bastion Host resources.", + "schema": { + "$ref": "#/definitions/BastionHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Bastion Hosts for a given subscription": { + "$ref": "./examples/BastionHostListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts": { + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_ListByResourceGroup", + "description": "Lists all Bastion Hosts in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of BastionHost resources.", + "schema": { + "$ref": "#/definitions/BastionHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Bastion Hosts for a given resource group": { + "$ref": "./examples/BastionHostListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/createShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "PutBastionShareableLink", + "description": "Creates a Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.", + "schema": { + "$ref": "#/definitions/BastionShareableLinkListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/deleteShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "DeleteBastionShareableLink", + "description": "Deletes the Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation deleted the BastionShareableLinks associated with the VMs, if they existed. No return body." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/deleteShareableLinksByToken": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "DeleteBastionShareableLinkByToken", + "description": "Deletes the Bastion Shareable Links for all the tokens specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkTokenRequest" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkDeleteByToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "GetBastionShareableLink", + "description": "Return the Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.", + "schema": { + "$ref": "#/definitions/BastionShareableLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getActiveSessions": { + "post": { + "tags": [ + "BastionHosts" + ], + "operationId": "GetActiveSessions", + "description": "Returns the list of currently active sessions on the Bastion.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of active sessions on the Bastion.", + "schema": { + "$ref": "#/definitions/BastionActiveSessionListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns a list of currently active sessions on the Bastion": { + "$ref": "./examples/BastionSessionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/disconnectActiveSessions": { + "post": { + "tags": [ + "BastionHosts" + ], + "operationId": "DisconnectActiveSessions", + "description": "Returns the list of currently active sessions on the Bastion.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SessionIdsParameters" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of sessions with the state of deleted/failed/not found.", + "schema": { + "$ref": "#/definitions/BastionSessionDeleteResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deletes the specified active session": { + "$ref": "./examples/BastionSessionDelete.json" + } + } + } + } + }, + "definitions": { + "Sku": { + "description": "The sku of this Bastion Host.", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku of this Bastion Host.", + "enum": [ + "Basic", + "Standard", + "Developer", + "Premium" + ], + "default": "Standard", + "x-ms-enum": { + "name": "BastionHostSkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "IPRule": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed." + } + }, + "type": "object" + }, + "BastionHostIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource. Null for private only bastion" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the bastion host IP configuration resource." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "Private IP allocation method." + } + }, + "required": [ + "subnet" + ], + "description": "Properties of IP configuration of an Bastion Host." + }, + "BastionHostIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BastionHostIPConfigurationPropertiesFormat", + "description": "Represents the ip configuration associated with the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Ip configuration type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an Bastion Host." + }, + "BastionHostPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionHostIPConfiguration" + }, + "description": "IP configuration of the Bastion Host resource." + }, + "dnsName": { + "type": "string", + "description": "FQDN for the endpoint on which bastion host is accessible." + }, + "virtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to an existing virtual network required for Developer Bastion Host only." + }, + "networkAcls": { + "properties": { + "ipRules": { + "type": "array", + "items": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "$ref": "#/definitions/IPRule" + }, + "description": "Sets the IP ACL rules for Developer Bastion Host." + } + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the bastion host resource." + }, + "scaleUnits": { + "type": "integer", + "format": "int32", + "description": "The scale units for the Bastion Host resource.", + "minimum": 2, + "maximum": 50 + }, + "disableCopyPaste": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Copy/Paste feature of the Bastion Host resource." + }, + "enableFileCopy": { + "type": "boolean", + "default": false, + "description": "Enable/Disable File Copy feature of the Bastion Host resource." + }, + "enableIpConnect": { + "type": "boolean", + "default": false, + "description": "Enable/Disable IP Connect feature of the Bastion Host resource." + }, + "enableShareableLink": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Shareable Link of the Bastion Host resource." + }, + "enableTunneling": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Tunneling feature of the Bastion Host resource." + }, + "enableKerberos": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Kerberos feature of the Bastion Host resource." + }, + "enableSessionRecording": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Session Recording feature of the Bastion Host resource." + }, + "enablePrivateOnlyBastion": { + "type": "boolean", + "default": false, + "description": "Enable/Disable Private Only feature of the Bastion Host resource." + } + }, + "description": "Properties of the Bastion Host." + }, + "BastionHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BastionHostPropertiesFormat", + "description": "Represents the bastion host resource." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "sku": { + "description": "The sku of this Bastion Host.", + "$ref": "#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Bastion Host resource." + }, + "BastionHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionHost" + }, + "description": "List of Bastion Hosts in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListBastionHosts API service call." + }, + "BastionShareableLink": { + "properties": { + "vm": { + "$ref": "#/definitions/VM", + "description": "Reference of the virtual machine resource." + }, + "bsl": { + "type": "string", + "readOnly": true, + "description": "The unique Bastion Shareable Link to the virtual machine." + }, + "createdAt": { + "type": "string", + "readOnly": true, + "description": "The time when the link was created." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Optional field indicating the warning or error message related to the vm in case of partial failure." + } + }, + "required": [ + "vm" + ], + "description": "Bastion Shareable Link." + }, + "BastionShareableLinkListRequest": { + "properties": { + "vms": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionShareableLink" + }, + "description": "List of VM references." + } + }, + "description": "Post request for Create/Delete/Get Bastion Shareable Link endpoints." + }, + "BastionShareableLinkTokenListRequest": { + "type": "object", + "properties": { + "tokens": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Bastion Shareable Link Token." + } + }, + "description": "Post request for Delete Bastion Shareable Link By Token endpoint." + }, + "BastionShareableLinkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionShareableLink" + }, + "description": "List of Bastion Shareable Links for the request." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for all the Bastion Shareable Link endpoints." + }, + "BastionActiveSession": { + "properties": { + "sessionId": { + "type": "string", + "readOnly": true, + "description": "A unique id for the session." + }, + "startTime": { + "type": "object", + "readOnly": true, + "description": "The time when the session started." + }, + "targetSubscriptionId": { + "type": "string", + "readOnly": true, + "description": "The subscription id for the target virtual machine." + }, + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of the resource." + }, + "targetHostName": { + "type": "string", + "readOnly": true, + "description": "The host name of the target." + }, + "targetResourceGroup": { + "type": "string", + "readOnly": true, + "description": "The resource group of the target." + }, + "userName": { + "type": "string", + "readOnly": true, + "description": "The user name who is active on this session." + }, + "targetIpAddress": { + "type": "string", + "readOnly": true, + "description": "The IP Address of the target." + }, + "protocol": { + "type": "string", + "readOnly": true, + "description": "The protocol used to connect to the target.", + "enum": [ + "SSH", + "RDP" + ], + "x-ms-enum": { + "name": "BastionConnectProtocol", + "modelAsString": true + } + }, + "targetResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource id of the target." + }, + "sessionDurationInMins": { + "type": "number", + "readOnly": true, + "description": "Duration in mins the session has been active." + } + }, + "description": "The session detail for a target." + }, + "BastionActiveSessionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionActiveSession" + }, + "description": "List of active sessions on the bastion." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for GetActiveSessions." + }, + "BastionSessionState": { + "properties": { + "sessionId": { + "type": "string", + "readOnly": true, + "description": "A unique id for the session." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Used for extra information." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the session. Disconnected/Failed/NotFound." + } + }, + "description": "The session state detail for a target." + }, + "BastionSessionDeleteResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionSessionState" + }, + "description": "List of sessions with their corresponding state." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for DisconnectActiveSessions." + }, + "VM": { + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "SessionIds": { + "properties": { + "sessionIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of session IDs." + } + }, + "description": "List of session IDs." + } + }, + "parameters": { + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "BastionShareableLinkRequest": { + "name": "bslRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionShareableLinkListRequest" + }, + "description": "Post request for Create/Delete/Get Bastion Shareable Link endpoints.", + "x-ms-parameter-location": "method" + }, + "BastionShareableLinkTokenRequest": { + "name": "bslTokenRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionShareableLinkTokenListRequest" + }, + "description": "Post request for Delete Bastion Shareable Link By Token endpoint.", + "x-ms-parameter-location": "method" + }, + "BastionHostName": { + "name": "bastionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Bastion Host.", + "x-ms-parameter-location": "method" + }, + "SessionIdsParameters": { + "name": "sessionIds", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionIds" + }, + "description": "The list of sessionids to disconnect.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/checkDnsAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/checkDnsAvailability.json new file mode 100644 index 000000000000..d16e2722cc38 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/checkDnsAvailability.json @@ -0,0 +1,96 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability": { + "get": { + "operationId": "CheckDnsNameAvailability", + "description": "Checks whether a domain name in the cloudapp.azure.com zone is available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "domainNameLabel", + "in": "query", + "required": true, + "type": "string", + "description": "The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the DNS name is available.", + "schema": { + "$ref": "#/definitions/DnsNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Dns Name Availability": { + "$ref": "./examples/CheckDnsNameAvailability.json" + } + } + } + } + }, + "definitions": { + "DnsNameAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Domain availability (True/False)." + } + }, + "description": "Response for the CheckDnsNameAvailability API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServiceNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServiceNetworkInterface.json new file mode 100644 index 000000000000..d63ffe8125cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServiceNetworkInterface.json @@ -0,0 +1,222 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListCloudServiceRoleInstanceNetworkInterfaces", + "description": "Gets information about all network interfaces in a role instance in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of role instance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List cloud service role instance network interfaces": { + "$ref": "./examples/CloudServiceRoleInstanceNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListCloudServiceNetworkInterfaces", + "description": "Gets all network interfaces in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List cloud service network interfaces": { + "$ref": "./examples/CloudServiceNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetCloudServiceNetworkInterface", + "description": "Get the specified network interface in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of role instance." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get cloud service network interface": { + "$ref": "./examples/CloudServiceNetworkInterfaceGet.json" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServicePublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServicePublicIpAddress.json new file mode 100644 index 000000000000..050ce04269ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServicePublicIpAddress.json @@ -0,0 +1,241 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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/cloudServices/{cloudServiceName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListCloudServicePublicIPAddresses", + "description": "Gets information about all public IP addresses on a cloud service level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { + "$ref": "./examples/CloudServicePublicIpListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListCloudServiceRoleInstancePublicIPAddresses", + "description": "Gets information about all public IP addresses in a role instance IP configuration in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of role instance." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { + "$ref": "./examples/CloudServiceRoleInstancePublicIpList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roleInstances/{roleInstanceName}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetCloudServicePublicIPAddress", + "description": "Get the specified public IP address in a cloud service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cloudServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "roleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The role instance name." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { + "$ref": "./examples/CloudServicePublicIpGet.json" + } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServiceSwap.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServiceSwap.json new file mode 100644 index 000000000000..65166edb11e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/cloudServiceSwap.json @@ -0,0 +1,280 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots/{singletonResource}": { + "get": { + "tags": [ + "VipSwap" + ], + "operationId": "VipSwap_Get", + "description": "Gets the SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production", + "parameters": [ + { + "name": "groupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "singletonResource", + "in": "path", + "required": true, + "type": "string", + "description": "Specifies a synthetic proxy resource that cannot be created or deleted. Value must be set to swap.", + "enum": [ + "swap" + ], + "x-ms-enum": { + "name": "singletonResource", + "modelAsString": false + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + }, + "200": { + "description": "Request successful. The operation returns the slot type for the specified cloud service.", + "schema": { + "$ref": "#/definitions/SwapResource" + } + } + }, + "x-ms-examples": { + "Get swap resource": { + "$ref": "./examples/CloudServiceSwapGet.json" + } + } + }, + "put": { + "tags": [ + "VipSwap" + ], + "operationId": "VipSwap_Create", + "description": "Performs vip swap operation on swappable cloud services.", + "parameters": [ + { + "name": "groupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "name": "singletonResource", + "in": "path", + "required": true, + "type": "string", + "description": "Specifies a synthetic resource that cannot be created or deleted. Value must be set to swap.", + "enum": [ + "swap" + ], + "x-ms-enum": { + "name": "singletonResource", + "modelAsString": false + } + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SwapResource" + }, + "description": "SwapResource object where slot type should be the target slot after vip swap for the specified cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Put vip swap operation.": { + "$ref": "./examples/CloudServiceSwapPut.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Compute/cloudServices/{resourceName}/providers/Microsoft.Network/cloudServiceSlots": { + "get": { + "tags": [ + "VipSwap" + ], + "operationId": "VipSwap_List", + "description": "Gets the list of SwapResource which identifies the slot type for the specified cloud service. The slot type on a cloud service can either be Staging or Production", + "parameters": [ + { + "name": "groupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cloud service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + }, + "200": { + "description": "Request successful. The operation returns the slot type for the specified cloud service.", + "schema": { + "$ref": "#/definitions/SwapResourceListResult" + } + } + }, + "x-ms-examples": { + "Get swap resource list": { + "$ref": "./examples/CloudServiceSwapList.json" + } + } + } + } + }, + "definitions": { + "SwapResource": { + "type": "object", + "properties": { + "id": { + "description": "Resource Id.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SwapResourceProperties" + } + }, + "description": "SwapResource to represent slot type on the specified cloud service." + }, + "SwapResourceProperties": { + "description": "Swap resource properties", + "type": "object", + "properties": { + "slotType": { + "description": "Specifies slot info on a cloud service", + "type": "string", + "enum": [ + "Production", + "Staging" + ], + "x-ms-enum": { + "name": "slotType", + "modelAsString": false + } + } + } + }, + "SwapResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SwapResource" + } + } + }, + "description": "SwapResource List with single entry to represent slot type on the specified cloud service." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/customIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/customIpPrefix.json new file mode 100644 index 000000000000..6341fada95f0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/customIpPrefix.json @@ -0,0 +1,522 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/customIpPrefixes/{customIpPrefixName}": { + "delete": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_Delete", + "description": "Deletes the specified custom IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the CustomIpPrefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete custom IP prefix": { + "$ref": "./examples/CustomIpPrefixDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_Get", + "description": "Gets the specified custom IP prefix in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the custom IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting CustomIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get custom IP prefix": { + "$ref": "./examples/CustomIpPrefixGet.json" + } + } + }, + "put": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_CreateOrUpdate", + "description": "Creates or updates a custom IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the custom IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + }, + "description": "Parameters supplied to the create or update custom IP prefix operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting CustomIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting CustomIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create custom IP prefix allocation method": { + "$ref": "./examples/CustomIpPrefixCreateCustomizedValues.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_UpdateTags", + "description": "Updates custom IP prefix tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "customIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the custom IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update custom IP prefix tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting customIpPrefix resource.", + "schema": { + "$ref": "#/definitions/CustomIpPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { + "$ref": "./examples/CustomIpPrefixUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/customIpPrefixes": { + "get": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_ListAll", + "description": "Gets all the custom IP prefixes in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of CustomIpPrefix resources.", + "schema": { + "$ref": "#/definitions/CustomIpPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all custom IP prefixes": { + "$ref": "./examples/CustomIpPrefixListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/customIpPrefixes": { + "get": { + "tags": [ + "CustomIpPrefixes" + ], + "operationId": "CustomIPPrefixes_List", + "description": "Gets all custom IP prefixes in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of CustomIpPrefix resources.", + "schema": { + "$ref": "#/definitions/CustomIpPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group Custom IP prefixes": { + "$ref": "./examples/CustomIpPrefixList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "CustomIpPrefixPropertiesFormat": { + "properties": { + "asn": { + "type": "string", + "description": "The ASN for CIDR advertising. Should be an integer as string." + }, + "cidr": { + "type": "string", + "description": "The prefix range in CIDR notation. Should include the start address and the prefix length." + }, + "signedMessage": { + "type": "string", + "description": "Signed message for WAN validation." + }, + "authorizationMessage": { + "type": "string", + "description": "Authorization message for WAN validation." + }, + "customIpPrefixParent": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The Parent CustomIpPrefix for IPv6 /64 CustomIpPrefix." + }, + "childCustomIpPrefixes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of all Children for IPv6 /48 CustomIpPrefix." + }, + "commissionedState": { + "type": "string", + "description": "The commissioned state of the Custom IP Prefix.", + "enum": [ + "Provisioning", + "Provisioned", + "Commissioning", + "CommissionedNoInternetAdvertise", + "Commissioned", + "Decommissioning", + "Deprovisioning", + "Deprovisioned" + ], + "x-ms-enum": { + "name": "CommissionedState", + "modelAsString": true + } + }, + "expressRouteAdvertise": { + "type": "boolean", + "description": "Whether to do express route advertise." + }, + "geo": { + "type": "string", + "description": "The Geo for CIDR advertising. Should be an Geo code.", + "enum": [ + "GLOBAL", + "AFRI", + "APAC", + "EURO", + "LATAM", + "NAM", + "ME", + "OCEANIA", + "AQ" + ], + "x-ms-enum": { + "name": "Geo", + "modelAsString": true + } + }, + "noInternetAdvertise": { + "type": "boolean", + "description": "Whether to Advertise the range to Internet." + }, + "prefixType": { + "type": "string", + "description": "Type of custom IP prefix. Should be Singular, Parent, or Child.", + "enum": [ + "Singular", + "Parent", + "Child" + ], + "x-ms-enum": { + "name": "CustomIpPrefixType", + "modelAsString": true + } + }, + "publicIpPrefixes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of all referenced PublicIpPrefixes." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the custom IP prefix resource." + }, + "failedReason": { + "readOnly": true, + "type": "string", + "description": "The reason why resource is in failed state." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the custom IP prefix resource." + } + }, + "description": "Custom IP prefix properties." + }, + "CustomIpPrefix": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the custom IP prefix." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomIpPrefixPropertiesFormat", + "description": "Custom IP prefix properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Custom IP prefix resource." + }, + "CustomIpPrefixListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomIpPrefix" + }, + "description": "A list of Custom IP prefixes that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListCustomIpPrefixes API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/ddosCustomPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/ddosCustomPolicy.json new file mode 100644 index 000000000000..39a47479973e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/ddosCustomPolicy.json @@ -0,0 +1,409 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/ddosCustomPolicies/{ddosCustomPolicyName}": { + "delete": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_Delete", + "description": "Deletes the specified DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyDelete.json" + } + } + }, + "get": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_Get", + "description": "Gets information about the specified DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_CreateOrUpdate", + "description": "Creates or updates a DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyCreate.json" + } + } + }, + "patch": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_UpdateTags", + "description": "Update a DDoS custom policy tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update DDoS custom policy resource tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DDoS Custom policy Update tags": { + "$ref": "./examples/DdosCustomPolicyUpdateTags.json" + } + } + } + } + }, + "definitions": { + "DdosCustomPolicy": { + "description": "A DDoS custom policy in a resource group.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosCustomPolicyPropertiesFormat", + "description": "Properties of the DDoS custom policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "DdosCustomPolicyPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS custom policy resource." + }, + "detectionRules": { + "type": "array", + "items": { + "$ref": "#/definitions/DdosDetectionRule" + }, + "description": "The list of DDoS detection rules associated with the custom policy." + }, + "frontEndIpConfiguration": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of frontend IP configurations associated with the custom policy." + } + }, + "description": "DDoS custom policy properties." + }, + "DdosDetectionRulePropertiesFormat": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS detection rule." + }, + "detectionMode": { + "type": "string", + "description": "The detection mode for the DDoS detection rule.", + "enum": [ + "TrafficThreshold" + ], + "x-ms-enum": { + "name": "DdosDetectionMode", + "modelAsString": true + } + }, + "trafficDetectionRule": { + "$ref": "#/definitions/TrafficDetectionRule", + "description": "The traffic detection rule details." + } + }, + "description": "DDoS detection rule properties." + }, + "DdosDetectionRule": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the DDoS detection rule." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource ID of the DDoS detection rule." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosDetectionRulePropertiesFormat", + "description": "Properties of the DDoS detection rule." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A DDoS detection rule resource." + }, + "TrafficDetectionRule": { + "type": "object", + "properties": { + "trafficType": { + "type": "string", + "description": "The traffic type (one of Tcp, Udp, TcpSyn) that the detection rule will be applied upon.", + "enum": [ + "Tcp", + "Udp", + "TcpSyn" + ], + "x-ms-enum": { + "name": "DdosTrafficType", + "modelAsString": true + } + }, + "packetsPerSecond": { + "type": "integer", + "format": "int32", + "description": "The customized packets per second threshold." + } + }, + "description": "Ddos Custom Policy traffic detection rule." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/ddosProtectionPlan.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/ddosProtectionPlan.json new file mode 100644 index 000000000000..9abc9b2521e5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/ddosProtectionPlan.json @@ -0,0 +1,450 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/ddosProtectionPlans/{ddosProtectionPlanName}": { + "delete": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Delete", + "description": "Deletes the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanDelete.json" + } + } + }, + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Get", + "description": "Gets information about the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanGet.json" + } + } + }, + "put": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_CreateOrUpdate", + "description": "Creates or updates a DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanCreate.json" + } + } + }, + "patch": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_UpdateTags", + "description": "Update a DDoS protection plan tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update DDoS protection plan resource tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DDoS protection plan Update tags": { + "$ref": "./examples/DdosProtectionPlanUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_List", + "description": "Gets all DDoS protection plans in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all DDoS protection plans": { + "$ref": "./examples/DdosProtectionPlanListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_ListByResourceGroup", + "description": "Gets all the DDoS protection plans in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List DDoS protection plans in resource group": { + "$ref": "./examples/DdosProtectionPlanList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DdosProtectionPlan": { + "description": "A DDoS protection plan in a resource group.", + "x-ms-azure-resource": true, + "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." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosProtectionPlanPropertiesFormat", + "description": "Properties of the DDoS protection plan." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + } + }, + "DdosProtectionPlanPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS protection plan resource." + }, + "publicIPAddresses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of public IPs associated with the DDoS protection plan resource. This list is read-only." + }, + "virtualNetworks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of virtual networks associated with the DDoS protection plan resource. This list is read-only." + } + }, + "description": "DDoS protection plan properties." + }, + "DdosProtectionPlanListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "A list of DDoS protection plans." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of DDoS protection plans." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/dscpConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/dscpConfiguration.json new file mode 100644 index 000000000000..48f604a8c41d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/dscpConfiguration.json @@ -0,0 +1,513 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/dscpConfigurations/{dscpConfigurationName}": { + "put": { + "tags": [ + "DscpConfiguration" + ], + "operationId": "DscpConfiguration_CreateOrUpdate", + "description": "Creates or updates a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "dscpConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DscpConfiguration" + }, + "description": "Parameters supplied to the create or update dscp configuration operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DscpConfiguration resource.", + "schema": { + "$ref": "#/definitions/DscpConfiguration" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DscpConfiguration resource.", + "schema": { + "$ref": "#/definitions/DscpConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create DSCP Configuration": { + "$ref": "./examples/DscpConfigurationCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "DscpConfiguration" + ], + "operationId": "DscpConfiguration_Delete", + "description": "Deletes a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "dscpConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete DSCP Configuration": { + "$ref": "./examples/DscpConfigurationDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "DscpConfiguration" + ], + "operationId": "DscpConfiguration_Get", + "description": "Gets a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "dscpConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting DSCP Configuration resource.", + "schema": { + "$ref": "#/definitions/DscpConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Dscp Configuration": { + "$ref": "./examples/DscpConfigurationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dscpConfigurations": { + "get": { + "tags": [ + "DscpConfigurations" + ], + "operationId": "DscpConfiguration_List", + "description": "Gets a DSCP Configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting DSCP Configuration resource.", + "schema": { + "$ref": "#/definitions/DscpConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Dscp Configuration": { + "$ref": "./examples/DscpConfigurationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dscpConfigurations": { + "get": { + "tags": [ + "DscpConfigurations" + ], + "operationId": "DscpConfiguration_ListAll", + "description": "Gets all dscp configurations in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/DscpConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network interfaces": { + "$ref": "./examples/DscpConfigurationListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DscpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DscpConfigurationPropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Differentiated Services Code Point configuration for any given network interface" + }, + "DscpConfigurationPropertiesFormat": { + "properties": { + "markings": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "List of markings to be used in the configuration." + }, + "sourceIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Source IP ranges." + }, + "destinationIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Sources port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Destination port ranges." + }, + "protocol": { + "type": "string", + "enum": [ + "DoNotUse", + "Icmp", + "Tcp", + "Udp", + "Gre", + "Esp", + "Ah", + "Vxlan", + "All" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + }, + "description": "RNM supported protocol types." + }, + "qosDefinitionCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/QosDefinition" + }, + "description": "QoS object definitions" + }, + "qosCollectionId": { + "type": "string", + "readOnly": true, + "description": "Qos Collection ID generated by RNM." + }, + "associatedNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "readOnly": true, + "description": "Associated Network Interfaces to the DSCP Configuration." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DSCP Configuration resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DSCP Configuration resource." + } + }, + "description": "Differentiated Services Code Point configuration properties." + }, + "QosDefinition": { + "type": "object", + "properties": { + "markings": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "List of markings to be used in the configuration." + }, + "sourceIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Source IP ranges." + }, + "destinationIpRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosIpRange" + }, + "description": "Destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Sources port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/QosPortRange" + }, + "description": "Destination port ranges." + }, + "protocol": { + "type": "string", + "enum": [ + "DoNotUse", + "Icmp", + "Tcp", + "Udp", + "Gre", + "Esp", + "Ah", + "Vxlan", + "All" + ], + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + }, + "description": "RNM supported protocol types." + } + }, + "description": "Quality of Service defines the traffic configuration between endpoints. Mandatory to have one marking." + }, + "QosIpRange": { + "properties": { + "startIP": { + "type": "string", + "description": "Start IP Address." + }, + "endIP": { + "type": "string", + "description": "End IP Address." + } + }, + "description": "Qos Traffic Profiler IP Range properties." + }, + "QosPortRange": { + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "Qos Port Range start." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "Qos Port Range end." + } + }, + "description": "Qos Traffic Profiler Port range properties." + }, + "DscpConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DscpConfiguration" + }, + "description": "A list of dscp configurations in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the DscpConfigurationList API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/endpointService.json new file mode 100644 index 000000000000..6238f70e8cef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/endpointService.json @@ -0,0 +1,119 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { + "$ref": "./examples/EndpointServicesList.json" + } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AllVirtualNetworkGatewayRadiusServerSecretsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AllVirtualNetworkGatewayRadiusServerSecretsList.json new file mode 100644 index 000000000000..d9aeea54a30e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AllVirtualNetworkGatewayRadiusServerSecretsList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "radiusServerAddress": "1.1.1.1", + "radiusServerSecret": "abc123" + }, + { + "radiusServerAddress": "2.2.2.2", + "radiusServerSecret": "mnop1234" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AllVpnServerConfigurationRadiusServerSecretsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AllVpnServerConfigurationRadiusServerSecretsList.json new file mode 100644 index 000000000000..53d02e986750 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AllVpnServerConfigurationRadiusServerSecretsList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4", + "resourceGroupName": "rg1", + "vpnServerConfigurationName": "vpnserverconfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "radiusServerAddress": "1.1.1.1", + "radiusServerSecret": "abc1234" + }, + { + "radiusServerAddress": "2.2.2.2", + "radiusServerSecret": "mnop12345" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json new file mode 100644 index 000000000000..9ebc77717828 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "Accept-Charset" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json new file mode 100644 index 000000000000..50d90e06af2a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "Access-Control-Allow-Origin" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableServerVariablesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableServerVariablesGet.json new file mode 100644 index 000000000000..2fd93ebfb4b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableServerVariablesGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "request_query" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsGet.json new file mode 100644 index 000000000000..57ffff631790 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsGet.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default", + "type": "Microsoft.Network/ApplicationGatewayAvailableSslOptions", + "properties": { + "predefinedPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501" + }, + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401" + }, + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401S" + } + ], + "defaultPolicy": "AppGwSslPolicy20150501", + "availableCipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "availableProtocols": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json new file mode 100644 index 000000000000..7bd41edce1ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AppGwSslPolicy20150501", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_0" + } + }, + { + "name": "AppGwSslPolicy20170401", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_1" + } + }, + { + "name": "AppGwSslPolicy20170401S", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401S", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_2" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json new file mode 100644 index 000000000000..1d07fa34eed1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "predefinedPolicyName": "AppGwSslPolicy20150501" + }, + "responses": { + "200": { + "body": { + "name": "AppGwSslPolicy20150501", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_0" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json new file mode 100644 index 000000000000..f931d9531cf1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OWASP_3.0", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets/", + "type": "Microsoft.Network/applicationGatewayAvailableWafRuleSets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200003, + "ruleIdString": "200003", + "description": "Multipart Request Body Strict Validation.", + "state": "Disabled" + }, + { + "ruleId": 200004, + "ruleIdString": "200004", + "description": "Possible Multipart Unmatched Boundary." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthGet.json new file mode 100644 index 000000000000..fb073de5a375 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "appgw", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "backendAddressPools": [ + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.8", + "health": "Up" + } + ] + } + ] + }, + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + ] + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthTest.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthTest.json new file mode 100644 index 000000000000..3be43f67ef49 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayBackendHealthTest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "probeRequest": { + "protocol": "Http", + "pickHostNameFromBackendHttpSettings": true, + "path": "/", + "timeout": 30, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + } + } + }, + "responses": { + "200": { + "body": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHealthHttpSettings": { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayCreate.json new file mode 100644 index 000000000000..3dcf3f859eac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayCreate.json @@ -0,0 +1,822 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "eastus", + "properties": { + "sku": { + "name": "Standard_v2", + "tier": "Standard_v2", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "****", + "password": "****" + } + }, + { + "name": "sslcert2", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "trustedRootCertificates": [ + { + "name": "rootcert", + "properties": { + "data": "****" + } + }, + { + "name": "rootcert1", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "properties": { + "data": "****" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + }, + { + "name": "appgwfp80", + "properties": { + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.0.1" + }, + { + "ipAddress": "10.0.0.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "properties": { + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "entraJWTValidationConfig": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "properties": { + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_add_x_forwarded_for_proxy}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc" + } + } + } + ] + } + } + ], + "entraJWTValidationConfigs": [ + { + "name": "entraJWTValidationConfig1", + "properties": { + "unAuthorizedRequestAction": "Deny", + "tenantId": "70a036f6-8e4d-4615-bad6-149c02e7720d", + "clientId": "37293f5a-97b3-451d-b786-f532d711c9ff" + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.0.1" + }, + { + "ipAddress": "10.0.0.2" + } + ] + } + } + ], + "loadDistributionPolicies": [], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP", + "verifyClientAuthMode": "Strict" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "listeners": [], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "entraJWTValidationConfig": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "reroute": true + } + } + } + ] + } + } + ], + "routingRules": [], + "probes": [], + "redirectConfigurations": [], + "privateEndpointConnections": [], + "entraJWTValidationConfigs": [ + { + "name": "entraJWTValidationConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1", + "properties": { + "provisioningState": "Succeeded", + "unAuthorizedRequestAction": "Deny", + "tenantId": "70a036f6-8e4d-4615-bad6-149c02e7720d", + "clientId": "37293f5a-97b3-451d-b786-f532d711c9ff" + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + }, + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.0.0.1" + }, + { + "ipAddress": "10.0.0.2" + } + ] + } + } + ], + "loadDistributionPolicies": [], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "listeners": [], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "entraJWTValidationConfig": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b" + } + } + } + ] + } + } + ], + "routingRules": [], + "probes": [], + "redirectConfigurations": [], + "privateEndpointConnections": [], + "entraJWTValidationConfigs": [ + { + "name": "entraJWTValidationConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1", + "properties": { + "provisioningState": "Succeeded", + "unAuthorizedRequestAction": "Deny", + "tenantId": "70a036f6-8e4d-4615-bad6-149c02e7720d", + "clientId": "37293f5a-97b3-451d-b786-f532d711c9ff" + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayDelete.json new file mode 100644 index 000000000000..e473717449dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayGet.json new file mode 100644 index 000000000000..720fa6723902 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayGet.json @@ -0,0 +1,405 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****", + "validatedCertData": "****", + "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + "10.0.0.1", + "10.0.0.2" + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP", + "verifyClientAuthMode": "Strict" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "defaultLoadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + }, + "entraJWTValidationConfig": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [], + "loadDistributionPolicies": [ + { + "name": "ldp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1", + "properties": { + "loadDistributionAlgorithm": "RoundRobin", + "loadDistributionTargets": [ + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 40, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + } + } + }, + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 60, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1" + } + } + } + ] + } + } + ], + "entraJWTValidationConfigs": [ + { + "name": "entraJWTValidationConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1", + "properties": { + "provisioningState": "Succeeded", + "unAuthorizedRequestAction": "Deny", + "tenantId": "70a036f6-8e4d-4615-bad6-149c02e7720d", + "clientId": "37293f5a-97b3-451d-b786-f532d711c9ff" + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayList.json new file mode 100644 index 000000000000..e7207e5322b9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayList.json @@ -0,0 +1,408 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****", + "validatedCertData": "****", + "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + "10.0.0.1", + "10.0.0.2" + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP", + "verifyClientAuthMode": "Strict" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "defaultLoadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "entraJWTValidationConfig": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [], + "loadDistributionPolicies": [ + { + "name": "ldp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1", + "properties": { + "loadDistributionAlgorithm": "RoundRobin", + "loadDistributionTargets": [ + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 40, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + } + } + }, + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 60, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1" + } + } + } + ] + } + } + ], + "entraJWTValidationConfigs": [ + { + "name": "entraJWTValidationConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1", + "properties": { + "provisioningState": "Succeeded", + "unAuthorizedRequestAction": "Deny", + "tenantId": "70a036f6-8e4d-4615-bad6-149c02e7720d", + "clientId": "37293f5a-97b3-451d-b786-f532d711c9ff" + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayListAll.json new file mode 100644 index 000000000000..3f980305ccd6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayListAll.json @@ -0,0 +1,407 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "trustedClientCertificates": [ + { + "name": "clientcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert", + "properties": { + "provisioningState": "Succeeded", + "data": "****", + "validatedCertData": "****", + "clientCertIssuerDN": "CN=User1, OU=Eng, O=Company Ltd, L=D4, S=Arizona, C=US" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + }, + { + "name": "appgwpool1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + "10.0.0.1", + "10.0.0.2" + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "sslProfiles": [ + { + "name": "sslProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1", + "properties": { + "provisioningState": "Succeeded", + "sslPolicy": { + "policyType": "Custom", + "minProtocolVersion": "TLSv1_1", + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256" + ] + }, + "clientAuthConfiguration": { + "verifyClientCertIssuerDN": true, + "verifyClientRevocation": "OCSP", + "verifyClientAuthMode": "Strict" + }, + "trustedClientCertificates": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/trustedClientCertificates/clientcert" + } + ] + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "sslProfile": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslProfiles/sslProfile1" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "defaultLoadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "loadDistributionPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1" + }, + "entraJWTValidationConfig": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [], + "loadDistributionPolicies": [ + { + "name": "ldp1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1", + "properties": { + "loadDistributionAlgorithm": "RoundRobin", + "loadDistributionTargets": [ + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 40, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + } + } + }, + { + "name": "ld11", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/loadDistributionPolicies/ldp1/loadDistributionTargets/ldt1", + "properties": { + "weightPerServer": 60, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool1" + } + } + } + ] + } + } + ], + "entraJWTValidationConfigs": [ + { + "name": "entraJWTValidationConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/entraJWTValidationConfigs/entraJWTValidationConfig1", + "properties": { + "provisioningState": "Succeeded", + "unAuthorizedRequestAction": "Deny", + "tenantId": "70a036f6-8e4d-4615-bad6-149c02e7720d", + "clientId": "37293f5a-97b3-451d-b786-f532d711c9ff" + } + } + ], + "globalConfiguration": { + "enableRequestBuffering": true, + "enableResponseBuffering": true + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..eeb9d8da2513 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..6ace3ad1d9f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1" + }, + "responses": { + "200": { + "body": { + "name": "coonection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/connection1", + "type": "Microsoft.Network/applicationGateways/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approval Done" + }, + "linkIdentifier": "805319460" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json new file mode 100644 index 000000000000..395bb8dcc553 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "coonection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/connection1", + "type": "Microsoft.Network/applicationGateways/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approval Done" + }, + "linkIdentifier": "805319460" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..c7dda86f8650 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1", + "parameters": { + "name": "connection1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + }, + "linkIdentifier": "linkId" + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateLinkResourceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateLinkResourceList.json new file mode 100644 index 000000000000..51c03b95fe79 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayPrivateLinkResourceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/privateLink1", + "type": "Microsoft.Network/applicationGateways/privateLinkResources", + "properties": { + "groupId": "privateLink1", + "requiredMembers": [ + "privateLink1" + ], + "requiredZoneNames": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayStart.json new file mode 100644 index 000000000000..0557694cb465 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayStop.json new file mode 100644 index 000000000000..0557694cb465 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayStop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayUpdateTags.json new file mode 100644 index 000000000000..40ea851a70e6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationGatewayUpdateTags.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupCreate.json new file mode 100644 index 000000000000..a64c33625117 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupCreate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupDelete.json new file mode 100644 index 000000000000..d1208968174e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupGet.json new file mode 100644 index 000000000000..609ac96e34aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupList.json new file mode 100644 index 000000000000..fa6573927e46 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupListAll.json new file mode 100644 index 000000000000..6ba4caed555c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..2f253b30fda8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ApplicationSecurityGroupUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AutoApprovedPrivateLinkServicesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AutoApprovedPrivateLinkServicesGet.json new file mode 100644 index 000000000000..1639a40aedd3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AutoApprovedPrivateLinkServicesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "regionName", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls3" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json new file mode 100644 index 000000000000..b37bf40fac04 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "regionName", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls3" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableDelegationsResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableDelegationsResourceGroupGet.json new file mode 100644 index 000000000000..d1b36b90dc1d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableDelegationsResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westcentralus", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableDelegationsSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableDelegationsSubscriptionGet.json new file mode 100644 index 000000000000..de42c13854f0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableDelegationsSubscriptionGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailablePrivateEndpointTypesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailablePrivateEndpointTypesGet.json new file mode 100644 index 000000000000..485641553ef8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailablePrivateEndpointTypesGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "regionName", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/availablePrivateEndpointTypes/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availablePrivateEndpointTypes", + "resourceName": "Microsoft.Provider/resourceType" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json new file mode 100644 index 000000000000..eeb1178fdf5d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "regionName", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availablePrivateEndpointTypes/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availablePrivateEndpointTypes", + "resourceName": "Microsoft.Provider/resourceType" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableServiceAliasesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableServiceAliasesList.json new file mode 100644 index 000000000000..09561ea322b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableServiceAliasesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "servicesAzure", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure" + }, + { + "name": "servicesAzureManagedInstance", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure/ManagedInstance" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableServiceAliasesListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableServiceAliasesListByResourceGroup.json new file mode 100644 index 000000000000..052b1152ca99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AvailableServiceAliasesListByResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westcentralus", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "servicesAzure", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure" + }, + { + "name": "servicesAzureManagedInstance", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure/ManagedInstance" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallDelete.json new file mode 100644 index 000000000000..acb22e388c2c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallFqdnTagsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallFqdnTagsListBySubscription.json new file mode 100644 index 000000000000..7879909e61d4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallFqdnTagsListBySubscription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azfwfqdntag", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewallFqdnTags/azfwfqdntag", + "type": "Microsoft.Network/azureFirewallFqdnTags", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "fqdnTagName": "azfwfqdntag" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGet.json new file mode 100644 index 000000000000..1186fe2436e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGet.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {}, + "autoscaleConfiguration": { + "minCapacity": 10, + "maxCapacity": 15 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithAdditionalProperties.json new file mode 100644 index 000000000000..76b5a827b5c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithIpGroups.json new file mode 100644 index 000000000000..4df9cf7d2fad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithIpGroups.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups3" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "changeNumber": "5" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2", + "changeNumber": "4" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups3", + "changeNumber": "1" + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithMgmtSubnet.json new file mode 100644 index 000000000000..661000e606e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithZones.json new file mode 100644 index 000000000000..e4fc436de7a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallGetWithZones.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListByResourceGroup.json new file mode 100644 index 000000000000..5ce0651400dd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListByResourceGroup.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListBySubscription.json new file mode 100644 index 000000000000..07b56ff6e609 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListBySubscription.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListLearnedIPPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListLearnedIPPrefixes.json new file mode 100644 index 000000000000..02bcad7318a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallListLearnedIPPrefixes.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azureFirewall1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01&t=638385313328642925&c=abc-123&s=def-456&h=xyz-789" + } + }, + "200": { + "body": { + "ipPrefixes": [ + "10.101.0.0/16", + "10.102.0.0/16" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPacketCapture.json new file mode 100644 index 000000000000..b2c27dfe7964 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPacketCapture.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azureFirewall1", + "parameters": { + "durationInSeconds": 300, + "numberOfPacketsToCapture": 5000, + "sasUrl": "someSASURL", + "fileName": "azureFirewallPacketCapture", + "protocol": "Any", + "flags": [ + { + "type": "syn" + }, + { + "type": "fin" + } + ], + "filters": [ + { + "sources": [ + "20.1.1.0" + ], + "destinations": [ + "20.1.2.0" + ], + "destinationPorts": [ + "4500" + ] + }, + { + "sources": [ + "10.1.1.0", + "10.1.1.1" + ], + "destinations": [ + "10.1.2.0" + ], + "destinationPorts": [ + "123", + "80" + ] + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPacketCaptureOperation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPacketCaptureOperation.json new file mode 100644 index 000000000000..bb27939b5726 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPacketCaptureOperation.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azureFirewall1", + "parameters": { + "durationInSeconds": 300, + "numberOfPacketsToCapture": 5000, + "sasUrl": "someSASURL", + "fileName": "azureFirewallPacketCapture", + "protocol": "Any", + "flags": [ + { + "type": "syn" + }, + { + "type": "fin" + } + ], + "filters": [ + { + "sources": [ + "20.1.1.0" + ], + "destinations": [ + "20.1.2.0" + ], + "destinationPorts": [ + "4500" + ] + }, + { + "sources": [ + "10.1.1.0", + "10.1.1.1" + ], + "destinations": [ + "10.1.2.0" + ], + "destinationPorts": [ + "123", + "80" + ] + } + ], + "operation": "Status" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": { + "statusCode": "AzureFirewallPacketCaptureInProgress", + "message": "Packet capture in progress. Please wait till it is finished or stop the current capture before starting another." + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPut.json new file mode 100644 index 000000000000..7f437a241d7a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPut.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {}, + "autoscaleConfiguration": { + "minCapacity": 8, + "maxCapacity": 8 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutInHub.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutInHub.json new file mode 100644 index 000000000000..3f0701a4a67c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutInHub.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [], + "count": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [ + { + "address": "13.73.240.12" + } + ], + "count": 1 + }, + "privateIPAddress": "10.0.0.0" + }, + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [ + { + "address": "13.73.240.12" + } + ], + "count": 1 + }, + "privateIPAddress": "10.0.0.0" + }, + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithAdditionalProperties.json new file mode 100644 index 000000000000..dd868196fbe4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -0,0 +1,516 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithIpGroups.json new file mode 100644 index 000000000000..a189aaf1b047 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithIpGroups.json @@ -0,0 +1,514 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "changeNumber": "5" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2", + "changeNumber": "4" + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithMgmtSubnet.json new file mode 100644 index 000000000000..713855b5a2f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -0,0 +1,516 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithZones.json new file mode 100644 index 000000000000..212034b76f32 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallPutWithZones.json @@ -0,0 +1,518 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "location": "West US 2", + "tags": { + "key1": "value1" + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "threatIntelMode": "Alert", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/applicationRuleCollections/apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/natRuleCollections/natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall/networkRuleCollections/netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallUpdateTags.json new file mode 100644 index 000000000000..f685c451e0cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureFirewallUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "azfwtest", + "azureFirewallName": "fw1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01&t=1234567890&c=abc-123&s=def-456&h=xyz-789" + } + }, + "200": { + "body": { + "name": "fw1", + "id": "/subscriptions/subid/resourceGroups/azfwtest/providers/Microsoft.Network/azureFirewalls/fw1", + "type": "Microsoft.Network/azureFirewalls", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureWebCategoriesListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureWebCategoriesListBySubscription.json new file mode 100644 index 000000000000..c6ad1d60c102 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureWebCategoriesListBySubscription.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "4de8428a-4a92-4cea-90ff-b47128b8cab8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Arts", + "id": "/subscriptions/4de8428a-4a92-4cea-90ff-b47128b8cab8/providers/Microsoft.Network/azureWebCategories/Arts", + "type": "Microsoft.Network/azureWebCategories", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "group": "General" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureWebCategoryGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureWebCategoryGet.json new file mode 100644 index 000000000000..fc6714de7f79 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/AzureWebCategoryGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "4de8428a-4a92-4cea-90ff-b47128b8cab8", + "name": "Arts" + }, + "responses": { + "200": { + "body": { + "name": "Arts", + "id": "/subscriptions/4de8428a-4a92-4cea-90ff-b47128b8cab8/providers/Microsoft.Network/azureWebCategories/Arts", + "type": "Microsoft.Network/azureWebCategories", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "group": "General" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDelete.json new file mode 100644 index 000000000000..d91a1dafc535 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperDelete.json new file mode 100644 index 000000000000..2cf635dbc415 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg2", + "bastionHostName": "bastionhostdeveloper" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperGet.json new file mode 100644 index 000000000000..5f2b32921abe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhostdeveloper'" + }, + "responses": { + "200": { + "body": { + "name": "bastionhostdeveloper'", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "ipConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperPut.json new file mode 100644 index 000000000000..6f00fdb3450f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostDeveloperPut.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg2", + "bastionHostName": "bastionhostdeveloper", + "sku": { + "name": "Developer" + }, + "parameters": { + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "ipConfigurations": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhostdeveloper", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "ipConfigurations": [] + } + } + }, + "201": { + "body": { + "name": "bastionhostdeveloper'", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "ipConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGet.json new file mode 100644 index 000000000000..42efbc27802e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant'" + }, + "responses": { + "200": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Standard" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGetWithPrivateOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGetWithPrivateOnly.json new file mode 100644 index 000000000000..5c0d3d7c3728 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGetWithPrivateOnly.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": { + "body": { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGetWithZones.json new file mode 100644 index 000000000000..b3e90316aa3f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostGetWithZones.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": { + "body": { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Standard" + }, + "zones": [ + "1", + "2" + ], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostListByResourceGroup.json new file mode 100644 index 000000000000..478a611d0ca5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostListByResourceGroup.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + }, + { + "name": "bastionhost2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost2", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": true, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost2/bastionHostIpConfigurations/IpConf", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName2" + } + } + } + ] + } + }, + { + "name": "bastionhost3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3/bastionHostIpConfigurations/IpConf", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet3/subnets/AzureBastionSubnet" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostListBySubscription.json new file mode 100644 index 000000000000..4977e70a7ffc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostListBySubscription.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + }, + { + "name": "bastionhostdeveloper", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/bastionHosts/bastionhostdeveloper", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Developer" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "networkAcls": { + "ipRules": [ + { + "addressPrefix": "1.1.1.1/16" + } + ] + }, + "dnsName": "omnibrain.uswest.bastionglobal.azure.com", + "ipConfigurations": [] + } + }, + { + "name": "bastionhost3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": true, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost3/bastionHostIpConfigurations/IpConf", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet3/subnets/AzureBastionSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName3" + } + } + } + ] + } + }, + { + "name": "bastionhost4", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost4", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "zones": [], + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhost4/bastionHostIpConfigurations/IpConf", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet4/subnets/AzureBastionSubnet" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPatch.json new file mode 100644 index 000000000000..4973424269e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPatch.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "200": { + "body": { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + }, + "sku": { + "name": "Standard" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPut.json new file mode 100644 index 000000000000..f20a472d294a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPut.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sku": { + "name": "Standard" + }, + "zones": [], + "parameters": { + "properties": { + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhost", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "bastionhosttenant'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPutWithPrivateOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPutWithPrivateOnly.json new file mode 100644 index 000000000000..d9593166b4d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPutWithPrivateOnly.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sku": { + "name": "Premium" + }, + "zones": [], + "parameters": { + "properties": { + "enablePrivateOnlyBastion": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "bastionhosttenant", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Premium" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": true, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPutWithZones.json new file mode 100644 index 000000000000..095b37e38919 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionHostPutWithZones.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sku": { + "name": "Standard" + }, + "zones": [ + "1", + "2" + ], + "parameters": { + "properties": { + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhost", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "scaleUnits": 2, + "disableCopyPaste": false, + "enableTunneling": false, + "enableIpConnect": false, + "enableShareableLink": false, + "enableKerberos": false, + "enableSessionRecording": false, + "enablePrivateOnlyBastion": false, + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionSessionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionSessionDelete.json new file mode 100644 index 000000000000..07b63b94d39d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionSessionDelete.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sessionIds": [ + "session1", + "session2", + "session3" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sessionId": "session1", + "message": "session session1 invalidated!", + "state": "Disconnected" + }, + { + "sessionId": "session2", + "message": "session session2 could not be disconnected!", + "state": "Failed" + }, + { + "sessionId": "session3", + "message": "session session3 not found!", + "state": "NotFound" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionSessionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionSessionsList.json new file mode 100644 index 000000000000..66614f43744c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionSessionsList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sessionId": "sessionId", + "startTime": "2019-1-1T12:00:00.0000Z", + "targetSubscriptionId": "subid", + "resourceType": "VM", + "targetHostName": "vm01", + "targetResourceGroup": "rg1", + "userName": "user", + "targetIpAddress": "1.1.1.1", + "protocol": "SSH", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm01", + "sessionDurationInMins": 0.0 + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getActiveSessions/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkCreate.json new file mode 100644 index 000000000000..9249f1e18d7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkCreate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1", + "createdAt": "2019-10-18T12:00:00.0000Z" + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2", + "createdAt": "2019-10-17T12:00:00.0000Z" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkDelete.json new file mode 100644 index 000000000000..07e6f15e454e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkDelete.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkDeleteByToken.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkDeleteByToken.json new file mode 100644 index 000000000000..1465e69013f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkDeleteByToken.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslTokenRequest": { + "tokens": [ + "abcd1234-efgh-hijk-5678-abcdefgh1234", + "dcba4321-hgfe-kjih-8765-hgfedcba4321" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkGet.json new file mode 100644 index 000000000000..b59a1c06dca0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/BastionShareableLinkGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1", + "createdAt": "2019-10-18T12:00:00.0000Z" + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2", + "createdAt": "2019-10-17T12:00:00.0000Z" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckDnsNameAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckDnsNameAvailability.json new file mode 100644 index 000000000000..b4c6e5749c6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckDnsNameAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "location": "westus", + "domainNameLabel": "testdns" + }, + "responses": { + "200": { + "body": { + "available": false + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckPrivateLinkServiceVisibility.json new file mode 100644 index 000000000000..2cbcc3b7f871 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckPrivateLinkServiceVisibility.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "location": "westus", + "parameters": { + "privateLinkServiceAlias": "mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" + } + }, + "responses": { + "200": { + "body": { + "visible": true + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json new file mode 100644 index 000000000000..f5644db5afe2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "location": "westus", + "resourceGroupName": "rg1", + "parameters": { + "privateLinkServiceAlias": "mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" + } + }, + "responses": { + "200": { + "body": { + "visible": true + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceNetworkInterfaceGet.json new file mode 100644 index 000000000000..a91940c3a874 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceNetworkInterfaceGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1", + "cloudServiceName": "cs1", + "roleInstanceName": "TestVMRole_IN_0" + }, + "responses": { + "200": { + "body": { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "dns.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceNetworkInterfaceList.json new file mode 100644 index 000000000000..ee7d9ef76982 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceNetworkInterfaceList.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cloudServiceName": "cs1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServicePublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServicePublicIpGet.json new file mode 100644 index 000000000000..bc779c610aa1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServicePublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cloudServiceName": "cs1", + "resourceGroupName": "cs-tester", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "roleInstanceName": "Test_VM_0", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServicePublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServicePublicIpListAll.json new file mode 100644 index 000000000000..43f3939ae992 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServicePublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "cloudServiceName": "cs1", + "resourceGroupName": "cs-tester", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json new file mode 100644 index 000000000000..1466302bd510 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceRoleInstanceNetworkInterfaceList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cloudServiceName": "cs1", + "roleInstanceName": "TestVMRole_IN_0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/TestVMRole_IN_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceRoleInstancePublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceRoleInstancePublicIpList.json new file mode 100644 index 000000000000..d77649776e21 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceRoleInstancePublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "cloudServiceName": "cs1", + "resourceGroupName": "cs-tester", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "roleInstanceName": "Test_VM_0", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/cs-tester/providers/Microsoft.Compute/cloudServices/cs1/roleInstances/Test_VM_0/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapGet.json new file mode 100644 index 000000000000..8a866491ccd2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "groupName": "rg1", + "resourceName": "testCloudService", + "singletonResource": "swap" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/testCloudService/providers/Microsoft.Network/cloudServiceSlots/swap", + "name": "swap", + "type": "Microsoft.Network/cloudServiceSlots", + "properties": { + "slotType": "Staging" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapList.json new file mode 100644 index 000000000000..644caf927ead --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "groupName": "rg1", + "resourceName": "testCloudService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/cloudServices/testCloudService/providers/Microsoft.Network/cloudServiceSlots/swap", + "name": "swap", + "type": "Microsoft.Network/cloudServiceSlots", + "properties": { + "slotType": "Staging" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapPut.json new file mode 100644 index 000000000000..d61f4ee25557 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CloudServiceSwapPut.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "groupName": "rg1", + "resourceName": "testCloudService", + "singletonResource": "swap", + "parameters": { + "properties": { + "slotType": "Production" + } + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupDelete.json new file mode 100644 index 000000000000..867d2b4295d2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "configurationPolicyGroupName": "policyGroup1", + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupGet.json new file mode 100644 index 000000000000..162318fc9a92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "configurationPolicyGroupName": "policyGroup1", + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json new file mode 100644 index 000000000000..14f6bda2a51c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnServerConfigurations/configurationPolicyGroups", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupPut.json new file mode 100644 index 000000000000..a66f68a2a061 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ConfigurationPolicyGroupPut.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "configurationPolicyGroupName": "policyGroup1", + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VpnServerConfigurationPolicyGroupParameters": { + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + } + }, + "201": { + "body": { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + }, + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixCreateCustomizedValues.json new file mode 100644 index 000000000000..4fc41e76d45e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixCreateCustomizedValues.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix", + "zones": [ + "1" + ], + "parameters": { + "location": "westus", + "properties": { + "cidr": "0.0.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "192.168.254.2/24", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + }, + "201": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "192.168.254.2/24", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixDelete.json new file mode 100644 index 000000000000..f1960318db76 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixGet.json new file mode 100644 index 000000000000..e953780b283f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix" + }, + "responses": { + "200": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.0.0/24", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixList.json new file mode 100644 index 000000000000..1a9e0f802c88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixList.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.0.0/24", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.1.0/30", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix4", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002:0001::/64", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [], + "customIpPrefixParent": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5" + } + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix5", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002::/48", + "commissionedState": "Provisioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4" + } + ] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixListAll.json new file mode 100644 index 000000000000..24067a503057 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixListAll.json @@ -0,0 +1,264 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.0.0/24", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/customIpPrefixes/test-customipprefix2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.2.0/23", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix3", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix3", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.4.0/22", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix4", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002:0001::/64", + "commissionedState": "Commissioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [], + "customIpPrefixParent": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5" + } + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix5", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix5", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "2607:f0d1:1002::/48", + "commissionedState": "Provisioned", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix4" + } + ] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix6", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Failed", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.5.0/22", + "commissionedState": "ProvisionFailed", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "CustomerSignatureNotVerified", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix7", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.6.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "asn": "11", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "noInternetAdvertise": false, + "expressRouteAdvertise": false, + "failedReason": "", + "geo": "GLOBAL", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "expressRouteAdvertise": true, + "noInternetAdvertise": false, + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + }, + { + "name": "test-customipprefix6", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/customIpPrefixes/test-customipprefix8", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "0.0.7.0/22", + "commissionedState": "Commissioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "expressRouteAdvertise": true, + "noInternetAdvertise": false, + "failedReason": "", + "prefixType": "Parent", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "type": "Microsoft.Network/customIpPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixUpdateTags.json new file mode 100644 index 000000000000..7a47dab482df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/CustomIpPrefixUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "customIpPrefixName": "test-customipprefix", + "zones": [ + "1" + ], + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-customipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/customIpPrefixes/test-customipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "cidr": "192.168.254.2/24", + "commissionedState": "Provisioning", + "signedMessage": "signedMessage", + "authorizationMessage": "authorizationMessage", + "failedReason": "", + "publicIpPrefixes": [], + "childCustomIpPrefixes": [] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/customIpPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyCreate.json new file mode 100644 index 000000000000..02960ec7c3ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyCreate.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "location": "centraluseuap", + "properties": { + "detectionRules": [ + { + "name": "detectionRuleTcp", + "properties": { + "detectionMode": "TrafficThreshold", + "trafficDetectionRule": { + "trafficType": "Tcp", + "packetsPerSecond": 1000000 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "detectionRules": [ + { + "name": "detectionRuleTcp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy/ddosDetectionRules/detectionRuleTcp", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/ddosCustomPolicies/ddosDetectionRules", + "properties": { + "provisioningState": "Succeeded", + "detectionMode": "TrafficThreshold", + "trafficDetectionRule": { + "trafficType": "Tcp", + "packetsPerSecond": 1000000 + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "detectionRules": [ + { + "name": "detectionRuleTcp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy/ddosDetectionRules/detectionRuleTcp", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/ddosCustomPolicies/ddosDetectionRules", + "properties": { + "provisioningState": "Succeeded", + "detectionMode": "TrafficThreshold", + "trafficDetectionRule": { + "trafficType": "Tcp", + "packetsPerSecond": 1000000 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyDelete.json new file mode 100644 index 000000000000..b79c4abe2fe3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyGet.json new file mode 100644 index 000000000000..58faf7788c82 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy" + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "detectionRules": [ + { + "name": "detectionRuleTcp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy/ddosDetectionRules/detectionRuleTcp", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/ddosCustomPolicies/ddosDetectionRules", + "properties": { + "provisioningState": "Succeeded", + "detectionMode": "TrafficThreshold", + "trafficDetectionRule": { + "trafficType": "Tcp", + "packetsPerSecond": 1000000 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyUpdateTags.json new file mode 100644 index 000000000000..92305433aa1d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosCustomPolicyUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "detectionRules": [ + { + "name": "detectionRuleTcp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy/ddosDetectionRules/detectionRuleTcp", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/ddosCustomPolicies/ddosDetectionRules", + "properties": { + "provisioningState": "Succeeded", + "detectionMode": "TrafficThreshold", + "trafficDetectionRule": { + "trafficType": "Tcp", + "packetsPerSecond": 1000000 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanCreate.json new file mode 100644 index 000000000000..6a386f8ce2d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "virtualNetworks": [] + } + } + }, + "201": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanDelete.json new file mode 100644 index 000000000000..f95569512d33 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanGet.json new file mode 100644 index 000000000000..a8d54b43a17e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanList.json new file mode 100644 index 000000000000..e24cb9c837be --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanListAll.json new file mode 100644 index 000000000000..5467866ee913 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanListAll.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet1" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip3" + } + ], + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanUpdateTags.json new file mode 100644 index 000000000000..1b94e50031ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DdosProtectionPlanUpdateTags.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DefaultSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DefaultSecurityRuleGet.json new file mode 100644 index 000000000000..95cf33e800c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DefaultSecurityRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1", + "defaultSecurityRuleName": "AllowVnetInBound" + }, + "responses": { + "200": { + "body": { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DefaultSecurityRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DefaultSecurityRuleList.json new file mode 100644 index 000000000000..bdaf8e2245ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DefaultSecurityRuleList.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationCreate.json new file mode 100644 index 000000000000..2c271578614f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationCreate.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "dscpConfigurationName": "mydscpconfig", + "parameters": { + "properties": { + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 10, + "end": 11 + }, + { + "start": 20, + "end": 21 + } + ], + "destinationPortRanges": [ + { + "start": 15, + "end": 15 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ], + "associatedNetworkInterfaces": [], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e" + }, + "type": "Microsoft.Network/dscpConfiguration" + } + }, + "201": { + "body": { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ], + "associatedNetworkInterfaces": [], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e" + }, + "type": "Microsoft.Network/dscpConfiguration" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationDelete.json new file mode 100644 index 000000000000..aad2de5673c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "dscpConfigurationName": "mydscpConfig" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationGet.json new file mode 100644 index 000000000000..d1d98c450eb5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationGet.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "dscpConfigurationName": "mydscpConfig" + }, + "responses": { + "200": { + "body": { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2" + } + ], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationList.json new file mode 100644 index 000000000000..c12a4fc5f68c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationList.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2" + } + ], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + }, + { + "name": "mydscpConfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic3" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic4" + } + ], + "qosCollectionId": "9as24mf6-d9cb-7a7f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationListAll.json new file mode 100644 index 000000000000..e32b77d3903c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/DscpConfigurationListAll.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydscpConfig", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/dscpConfiguration/mydscpConfig", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2" + } + ], + "qosCollectionId": "0f8fad5b-d9cb-469f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + }, + { + "name": "mydscpConfig2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/dscpConfiguration/mydscpConfig2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "associatedNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/test-nic3" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/test-nic4" + } + ], + "qosCollectionId": "9as24mf6-d9cb-7a7f-a165-70867728950e", + "qosDefinitionCollection": [ + { + "markings": [ + 1 + ], + "sourceIpRanges": [ + { + "startIP": "127.0.0.1", + "endIP": "127.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "127.0.10.1", + "endIP": "127.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 61, + "end": 62 + } + ], + "protocol": "Tcp" + }, + { + "markings": [ + 2 + ], + "sourceIpRanges": [ + { + "startIP": "12.0.0.1", + "endIP": "12.0.0.2" + } + ], + "destinationIpRanges": [ + { + "startIP": "12.0.10.1", + "endIP": "12.0.10.2" + } + ], + "sourcePortRanges": [ + { + "start": 11, + "end": 12 + } + ], + "destinationPortRanges": [ + { + "start": 51, + "end": 52 + } + ], + "protocol": "Udp" + } + ] + }, + "type": "Microsoft.Network/dscpConfiguration" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForConnection.json new file mode 100644 index 000000000000..51b4ecb898c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForConnection.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2025-03-01", + "effectiveRoutesParameters": { + "resourceId": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "virtualWanResourceType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "addressPrefixes": [ + "10.147.128.0/17" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0" + ], + "nextHopType": "Remote Hub", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0", + "asPath": "65520-65520" + }, + { + "addressPrefixes": [ + "10.0.0.0/16" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1" + ], + "nextHopType": "ExpressRouteGateway", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1", + "asPath": "12076-12076" + } + ] + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForRouteTable.json new file mode 100644 index 000000000000..a36f38fd1726 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForRouteTable.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2025-03-01", + "effectiveRoutesParameters": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "virtualWanResourceType": "RouteTable" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "addressPrefixes": [ + "10.147.128.0/17" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0" + ], + "nextHopType": "Remote Hub", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0", + "asPath": "65520-65520" + }, + { + "addressPrefixes": [ + "10.0.0.0/16" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1" + ], + "nextHopType": "ExpressRouteGateway", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1", + "asPath": "12076-12076" + } + ] + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForVirtualHub.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForVirtualHub.json new file mode 100644 index 000000000000..09250b112491 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EffectiveRoutesListForVirtualHub.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2025-03-01", + "effectiveRoutesParameters": null + }, + "responses": { + "200": { + "body": { + "value": [ + { + "addressPrefixes": [ + "10.147.128.0/17" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0" + ], + "nextHopType": "Remote Hub", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/virtualHubs/hub0", + "asPath": "65520-65520" + }, + { + "addressPrefixes": [ + "10.0.0.0/16" + ], + "nextHops": [ + "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1" + ], + "nextHopType": "ExpressRouteGateway", + "routeOrigin": "/subscriptions/testSub/resourceGroups/testRg/providers/Microsoft.Network/expressRouteGateways/ErGw1", + "asPath": "12076-12076" + } + ] + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EndpointServicesList.json new file mode 100644 index 000000000000..d9fafb9058f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/EndpointServicesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitARPTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitARPTableList.json new file mode 100644 index 000000000000..d64c087bbd33 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitARPTableList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationCreate.json new file mode 100644 index 000000000000..3090d08f4575 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "authorizationName": "authorizatinName", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "authorizationParameters": { + "properties": {} + } + }, + "responses": { + "201": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available" + } + } + }, + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationDelete.json new file mode 100644 index 000000000000..86a7ff10133c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationGet.json new file mode 100644 index 000000000000..5e150348348d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "body": { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + }, + "type": "Microsoft.Network/expressRouteCircuits/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationList.json new file mode 100644 index 000000000000..321872b59406 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitAuthorizationList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionCreate.json new file mode 100644 index 000000000000..c08b34da0b0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections", + "expressRouteCircuitConnectionParameters": { + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/29", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::/125" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionDelete.json new file mode 100644 index 000000000000..682aec73e2fa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..69224a74a3e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + }, + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..91a5f6c21c87 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitConnectionList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + }, + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSEUR", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSEUR", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharckteurope/providers/Microsoft.Network/expressRouteCircuits/dedharcktams/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitCreate.json new file mode 100644 index 000000000000..48c353035abf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + }, + "properties": { + "authorizations": [], + "peerings": [], + "allowClassicOperations": false, + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + } + }, + "location": "Brazil South" + } + }, + "responses": { + "201": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "Brazil South", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + }, + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "Brazil South", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json new file mode 100644 index 000000000000..a83a584650bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "type": "Microsoft.Network/expressRouteCircuits", + "circuitName": "expressRouteCircuit1", + "parameters": { + "location": "westus", + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + }, + "properties": { + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "enableDirectPortRateLimit": false, + "authorizationKey": "b0be57f5-1fba-463b-adec-ffe767354cdd", + "bandwidthInGbps": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "enableDirectPortRateLimit": false, + "authorizationKey": "b0be57f5-1fba-463b-adec-ffe767354cdd", + "authorizationStatus": "Enabled", + "bandwidthInGbps": 10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + }, + "201": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "enableDirectPortRateLimit": false, + "authorizationKey": "b0be57f5-1fba-463b-adec-ffe767354cdd", + "authorizationStatus": "Enabled", + "bandwidthInGbps": 10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitDelete.json new file mode 100644 index 000000000000..4e84e995c934 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitGet.json new file mode 100644 index 000000000000..fe0f6bf53264 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitListByResourceGroup.json new file mode 100644 index 000000000000..105c5ad7849d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitListBySubscription.json new file mode 100644 index 000000000000..fb5f525fed90 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitListBySubscription.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringCreate.json new file mode 100644 index 000000000000..81307c070ca2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200 + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringDelete.json new file mode 100644 index 000000000000..2fe0963909cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringGet.json new file mode 100644 index 000000000000..619ac32797ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringName": "MicrosoftPeering" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "routeFilter": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName" + } + }, + "type": "Microsoft.Network/expressRouteCircuits/peerings" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringList.json new file mode 100644 index 000000000000..64171c0b657d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringList.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "expressRouteConnection": "" + } + }, + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "10.0.0.0/30", + "secondaryPeerAddressPrefix": "10.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringStats.json new file mode 100644 index 000000000000..fceb7b702a8d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitPeeringStats.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": { + "body": { + "primarybytesIn": 537408, + "primarybytesOut": 44032550, + "secondarybytesIn": 0, + "secondarybytesOut": 39002500 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitRouteTableList.json new file mode 100644 index 000000000000..c56390e0b1f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitRouteTableList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitRouteTableSummaryList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitRouteTableSummaryList.json new file mode 100644 index 000000000000..df6894979f03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitRouteTableSummaryList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operationStatus/default/operationId/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitStats.json new file mode 100644 index 000000000000..1bd1e0f16020 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitStats.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primarybytesIn": 537408, + "primarybytesOut": 44032550, + "secondarybytesIn": 0, + "secondarybytesOut": 39002500 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitUpdateTags.json new file mode 100644 index 000000000000..b9de07a84501 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCircuitUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "ertest", + "circuitName": "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionCreate.json new file mode 100644 index 000000000000..01b238ad42c1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionCreate.json @@ -0,0 +1,138 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "resourceGroupName": "resourceGroupName", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "connectionName": "connectionName", + "putExpressRouteConnectionParameters": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "name": "connectionName", + "properties": { + "routingWeight": 2, + "authorizationKey": "authorizationKey", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2, + "enableInternetSecurity": false, + "expressRouteGatewayBypass": false, + "enablePrivateLinkFastPath": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "201": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionDelete.json new file mode 100644 index 000000000000..0691fda2b6ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "connectionName": "connectionName", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionGet.json new file mode 100644 index 000000000000..4bcece792fa1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "connectionName": "connectionName" + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1, + "enableInternetSecurity": false, + "expressRouteGatewayBypass": false, + "enablePrivateLinkFastPath": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionList.json new file mode 100644 index 000000000000..ac8ad792be27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteConnectionList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "resourceGroupName", + "expressRouteGatewayName": "expressRouteGatewayName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1, + "enableInternetSecurity": false, + "expressRouteGatewayBypass": false, + "enablePrivateLinkFastPath": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json new file mode 100644 index 000000000000..d8ba5df3e383 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json new file mode 100644 index 000000000000..2f2d3a6fdee4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json new file mode 100644 index 000000000000..2f8749dacc95 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json new file mode 100644 index 000000000000..bc520599d2cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionGet.json new file mode 100644 index 000000000000..7fe026c60ade --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "" + }, + "responses": { + "200": { + "body": { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionList.json new file mode 100644 index 000000000000..c8d489fa75df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "name": "" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json new file mode 100644 index 000000000000..ade98566de71 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "CrossConnection-SiliconValley", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionUpdate.json new file mode 100644 index 000000000000..9e44af3de681 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "", + "parameters": { + "properties": { + "serviceProviderProvisioningState": "NotProvisioned" + } + } + }, + "responses": { + "200": { + "body": { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionUpdateTags.json new file mode 100644 index 000000000000..d650e8f8da77 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "", + "crossConnectionParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsArpTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsArpTable.json new file mode 100644 index 000000000000..756fd20fa483 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsArpTable.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "192.116.14.254", + "macAddress": "885a.9269.9110" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsRouteTable.json new file mode 100644 index 000000000000..7122ab396d12 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsRouteTable.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "10.6.0.0/16", + "nextHop": "10.6.1.12", + "locPrf": "", + "weight": 0, + "path": "65514" + }, + { + "network": "10.7.0.0/16", + "nextHop": "10.7.1.13", + "locPrf": "", + "weight": 0, + "path": "65514" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json new file mode 100644 index 000000000000..f68c877bb851 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "10.6.1.112", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "Active" + }, + { + "neighbor": "10.6.1.113", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "1" + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayCreate.json new file mode 100644 index 000000000000..bb550840acf6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "subscriptionId": "subid", + "resourceGroupName": "resourceGroupName", + "api-version": "2025-03-01", + "putExpressRouteGatewayParameters": { + "location": "westus", + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupId/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + }, + "allowNonVirtualWanTraffic": false + } + } + }, + "responses": { + "201": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + }, + "allowNonVirtualWanTraffic": false + } + } + }, + "200": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + }, + "allowNonVirtualWanTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayDelete.json new file mode 100644 index 000000000000..88ddea787a7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayGet.json new file mode 100644 index 000000000000..10837608ca2a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "allowNonVirtualWanTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayListByResourceGroup.json new file mode 100644 index 000000000000..bd8d85769475 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayListByResourceGroup.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "allowNonVirtualWanTraffic": false, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hvirtualHubNameub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayListBySubscription.json new file mode 100644 index 000000000000..2004f4044c4c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayListBySubscription.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "allowNonVirtualWanTraffic": false, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hvirtualHubNameub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayUpdateTags.json new file mode 100644 index 000000000000..26f9b6a332e6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteGatewayUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "expressRouteGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "allowNonVirtualWanTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteLinkGet.json new file mode 100644 index 000000000000..f3e94a988047 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteLinkGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "linkName": "linkName" + }, + "responses": { + "200": { + "body": { + "name": "linkName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/linkName", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocationName", + "connectorType": "LC", + "adminState": "Disabled" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteLinkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteLinkList.json new file mode 100644 index 000000000000..45a7a2ea8884 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteLinkList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "name": "link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationCreate.json new file mode 100644 index 000000000000..0270c1e0fb85 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "authorizationName": "authorizatinName", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "authorizationParameters": { + "properties": {} + } + }, + "responses": { + "201": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + }, + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationDelete.json new file mode 100644 index 000000000000..b8dda83a03bf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationGet.json new file mode 100644 index 000000000000..561694160f44 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationList.json new file mode 100644 index 000000000000..e8c01cf4f7b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortAuthorizationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "expressRoutePortName": "expressRoutePortName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ExpressRoutePorts/expressRoutePortName/authorizations/authorizationName", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available", + "circuitResourceUri": "" + }, + "type": "Microsoft.Network/expressRoutePorts/authorizations" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortCreate.json new file mode 100644 index 000000000000..f1595df2acd9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortCreate.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "billingType": "UnlimitedData" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortDelete.json new file mode 100644 index 000000000000..6d09914811f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortGet.json new file mode 100644 index 000000000000..5a5934f30818 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortGet.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortList.json new file mode 100644 index 000000000000..fa39ad79c624 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortList.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortListByResourceGroup.json new file mode 100644 index 000000000000..852502cef957 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "coloLocation": "coloLocation1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "coloLocation": "coloLocation2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortUpdateLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortUpdateLink.json new file mode 100644 index 000000000000..076f51c36967 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortUpdateLink.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "links": [ + { + "name": "link1", + "properties": { + "adminState": "Enabled" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortUpdateTags.json new file mode 100644 index 000000000000..5c9f40bc9447 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortUpdateTags.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "billingType": "UnlimitedData", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortsLocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortsLocationGet.json new file mode 100644 index 000000000000..c16100c5add7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortsLocationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "locationName": "locationName" + }, + "responses": { + "200": { + "body": { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName", + "type": "Microsoft.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + { + "offerName": "100 Gbps", + "valueInGbps": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortsLocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortsLocationList.json new file mode 100644 index 000000000000..f95dc1ccf924 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRoutePortsLocationList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName", + "type": "Microsoft.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteProviderList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteProviderList.json new file mode 100644 index 000000000000..39ea68dcbfb3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ExpressRouteProviderList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "providerName", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/", + "type": "Microsoft.Network/expressRouteServiceProviders", + "properties": { + "provisioningState": "Succeeded", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ], + "bandwidthsOffered": [ + { + "offerName": "50Mbps", + "valueInMbps": 50 + }, + { + "offerName": "100Mbps", + "valueInMbps": 100 + }, + { + "offerName": "200Mbps", + "valueInMbps": 200 + }, + { + "offerName": "500Mbps", + "valueInMbps": 500 + }, + { + "offerName": "1Gbps", + "valueInMbps": 1000 + }, + { + "offerName": "2Gbps", + "valueInMbps": 2000 + }, + { + "offerName": "5Gbps", + "valueInMbps": 5000 + }, + { + "offerName": "10Gbps", + "valueInMbps": 10000 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDelete.json new file mode 100644 index 000000000000..3eee92e919e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Network/locations/region1" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftDelete.json new file mode 100644 index 000000000000..9f94243a93e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftDeploy.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftDeploy.json new file mode 100644 index 000000000000..849e0d1cb13f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftDeploy.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftGet.json new file mode 100644 index 000000000000..54e6809442b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftGet.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftPut.json new file mode 100644 index 000000000000..03be1ecdf1f5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyDraftPut.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyGet.json new file mode 100644 index 000000000000..ca6a54046931 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyGet.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "size": "0.5MB", + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyListByResourceGroup.json new file mode 100644 index 000000000000..30fa08c72968 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "sku": { + "tier": "Standard" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyListBySubscription.json new file mode 100644 index 000000000000..9010e7790b46 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyListBySubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "sku": { + "tier": "Standard" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json new file mode 100644 index 000000000000..19708a9e6d37 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyNatRuleCollectionGroupGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "NatRule1", + "translatedFqdn": "internalhttpserver", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ], + "name": "NatRC", + "priority": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json new file mode 100644 index 000000000000..92885454560e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyNatRuleCollectionGroupPut.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "priority": 100, + "name": "Example-Nat-Rule-Collection", + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "nat-rule1", + "translatedFqdn": "internalhttp.server.net", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "name": "Example-Nat-Rule-Collection", + "priority": 100, + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "nat-rule1", + "translatedFqdn": "internalhttp.server.net", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyNatRuleCollection", + "name": "Example-Nat-Rule-Collection", + "priority": 100, + "action": { + "type": "DNAT" + }, + "rules": [ + { + "ruleType": "NatRule", + "name": "nat-rule1", + "translatedFqdn": "internalhttp.server.net", + "translatedPort": "8080", + "ipProtocols": [ + "TCP", + "UDP" + ], + "sourceAddresses": [ + "2.2.2.2" + ], + "sourceIpGroups": [], + "destinationAddresses": [ + "152.23.32.23" + ], + "destinationPorts": [ + "8080" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyPatch.json new file mode 100644 index 000000000000..6978bc527817 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyPatch.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-03-01", + "subscriptionId": "subId", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyPut.json new file mode 100644 index 000000000000..36492279399d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyPut.json @@ -0,0 +1,344 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "size": "0.5MB", + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup2" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "size": "0.5MB", + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup2" + } + ], + "insights": { + "isEnabled": true, + "retentionDays": 100, + "logAnalyticsResources": { + "workspaces": [ + { + "region": "westus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace1" + } + }, + { + "region": "eastus", + "workspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/workspace2" + } + } + ], + "defaultWorkspaceId": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/microsoft.operationalinsights/workspaces/defaultWorkspace" + } + } + }, + "firewalls": [], + "snat": { + "privateRanges": [ + "IANAPrivateRanges" + ] + }, + "sql": { + "allowSqlRedirect": true + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + }, + "explicitProxy": { + "enableExplicitProxy": true, + "httpPort": 8087, + "httpsPort": 8087, + "enablePacFile": true, + "pacFilePort": 8087, + "pacFile": "https://tinawstorage.file.core.windows.net/?sv=2020-02-10&ss=bfqt&srt=sco&sp=rwdlacuptfx&se=2021-06-04T07:01:12Z&st=2021-06-03T23:01:12Z&sip=68.65.171.11&spr=https&sig=Plsa0RRVpGbY0IETZZOT6znOHcSro71LLTTbzquYPgs%3D" + }, + "sku": { + "tier": "Premium" + }, + "intrusionDetection": { + "mode": "Alert", + "profile": "Balanced", + "configuration": { + "signatureOverrides": [ + { + "id": "2525004", + "mode": "Deny" + } + ], + "bypassTrafficSettings": [ + { + "name": "bypassRule1", + "description": "Rule 1", + "protocol": "TCP", + "sourceAddresses": [ + "1.2.3.4" + ], + "destinationAddresses": [ + "5.6.7.8" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + }, + "transportSecurity": { + "certificateAuthority": { + "name": "clientcert", + "keyVaultSecretId": "https://kv/secret" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyQuerySignatureOverrides.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyQuerySignatureOverrides.json new file mode 100644 index 000000000000..4e7a69217bb0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyQuerySignatureOverrides.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "filters": [ + { + "field": "Mode", + "values": [ + "Deny" + ] + } + ], + "search": "", + "orderBy": { + "field": "severity", + "order": "Ascending" + }, + "resultsPerPage": 20, + "skip": 0 + } + }, + "responses": { + "200": { + "body": { + "signatures": [ + { + "signatureId": 2000015, + "mode": 2, + "severity": 1, + "direction": 2, + "group": "A Network Trojan was detected", + "description": "P2P Phatbot Control Connection", + "sourcePorts": [ + "any" + ], + "destinationPorts": [ + "any" + ], + "lastUpdated": "2010-07-30T00:00:00", + "inheritedFromParentPolicy": false, + "protocol": "tcp" + }, + { + "signatureId": 2000106, + "mode": 2, + "severity": 1, + "direction": 1, + "group": "Attempted User Privilege Gain", + "description": "WEB_SERVER SQL sp_delete_alert attempt", + "sourcePorts": [ + "any" + ], + "destinationPorts": [ + "any" + ], + "lastUpdated": "2019-09-27T00:00:00", + "inheritedFromParentPolicy": false, + "protocol": "http" + } + ], + "matchingRecordsCount": 2 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json new file mode 100644 index 000000000000..46e290213291 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyQuerySignatureOverridesFilterValues.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "filterName": "severity" + } + }, + "responses": { + "200": { + "body": { + "filterValues": [ + "low", + "medium", + "high" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDelete.json new file mode 100644 index 000000000000..7ac585796765 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Network/locations/region1" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json new file mode 100644 index 000000000000..93ddca5ee978 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json new file mode 100644 index 000000000000..d6e69395b0a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json new file mode 100644 index 000000000000..21b939a25047 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupDraftPut.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupGet.json new file mode 100644 index 000000000000..9c0225aeb4da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "size": "1.2MB", + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupList.json new file mode 100644 index 000000000000..c426d3f14866 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "network-rule-1", + "ruleType": "NetworkRule", + "description": "Network rule", + "destinationAddresses": [ + "*" + ], + "sourceAddresses": [ + "10.1.25.0/24" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupPut.json new file mode 100644 index 000000000000..b035f2cde5c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupPut.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "size": "1.2MB", + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "size": "1.2MB", + "provisioningState": "Succeeded", + "priority": 100, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 100, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json new file mode 100644 index 000000000000..d58dcbffe1ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Allow" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Insert trusted tenants header", + "protocols": [ + { + "protocolType": "Http", + "port": 80 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "fqdnTags": [ + "WindowsVirtualDesktop" + ], + "httpHeadersToInsert": [ + { + "headerName": "Restrict-Access-To-Tenants", + "headerValue": "contoso.com,fabrikam.onmicrosoft.com" + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Allow" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Insert trusted tenants header", + "protocols": [ + { + "protocolType": "Http", + "port": 80 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "fqdnTags": [ + "WindowsVirtualDesktop" + ], + "httpHeadersToInsert": [ + { + "headerName": "Restrict-Access-To-Tenants", + "headerValue": "contoso.com,fabrikam.onmicrosoft.com" + } + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Allow" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Insert trusted tenants header", + "protocols": [ + { + "protocolType": "Http", + "port": 80 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "fqdnTags": [ + "WindowsVirtualDesktop" + ], + "httpHeadersToInsert": [ + { + "headerName": "Restrict-Access-To-Tenants", + "headerValue": "contoso.com,fabrikam.onmicrosoft.com" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json new file mode 100644 index 000000000000..efd659415f72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleGroups/ruleGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json new file mode 100644 index 000000000000..fc5d0afd38c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "network-rule-1", + "ruleType": "NetworkRule", + "description": "Network rule", + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json new file mode 100644 index 000000000000..4d68cd1a3ce4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json new file mode 100644 index 000000000000..1ae266a33dd2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json new file mode 100644 index 000000000000..36ce4df443db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json new file mode 100644 index 000000000000..acc869b31db6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "ApplicationRule", + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ], + "webCategories": [ + "Hacking" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesGet.json new file mode 100644 index 000000000000..25f58dfddad0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesList.json new file mode 100644 index 000000000000..72c6efdb9367 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesPatch.json new file mode 100644 index 000000000000..8e7bd1d49282 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesPatch.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesPut.json new file mode 100644 index 000000000000..8e7bd1d49282 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/FirewallPolicySignatureOverridesPut.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "e747cc13-97d4-4a79-b463-42d7f4e558f2", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e747cc13-97d4-4a79-b463-42d7f4e558f2/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/signatureOverrides/default", + "name": "default", + "type": "Microsoft.Network/firewallPolicies/signatureOverrides", + "properties": { + "signatures": { + "2000105": "Off", + "2000106": "Deny" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GenerateExpressRoutePortsLOA.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GenerateExpressRoutePortsLOA.json new file mode 100644 index 000000000000..23c8b8495603 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GenerateExpressRoutePortsLOA.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "request": { + "customerName": "customerName" + } + }, + "responses": { + "200": { + "description": "Request successful. Returns the content as a base64 encoded string", + "body": { + "encodedContent": "TWFuIGlzIGRpc3" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json new file mode 100644 index 000000000000..4545ee8e6b3e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualWANName": "wan1", + "vpnClientParams": { + "vpnServerConfigurationResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1", + "authenticationMethod": "EAPTLS" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "profileUrl": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetApplicationGatewayWafDynamicManifests.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetApplicationGatewayWafDynamicManifests.json new file mode 100644 index 000000000000..34e1652d2724 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetApplicationGatewayWafDynamicManifests.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/subid/providers/Microsoft.Network/applicationGatewayWafDynamicManifests/default", + "type": "Microsoft.Network/applicationGatewayWafDynamicManifest", + "properties": { + "defaultRuleSet": { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + }, + "availableRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "status": "0", + "tiers": [ + "WAF_v2" + ], + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200002, + "ruleIdString": "200002", + "description": "Failed to Parse Request Body.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200003, + "ruleIdString": "200003", + "description": "Multipart Request Body Strict Validation.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200004, + "ruleIdString": "200004", + "description": "Possible Multipart Unmatched Boundary.", + "state": "Enabled", + "action": "AnomalyScoring" + } + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json new file mode 100644 index 000000000000..967dc55ba2e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetApplicationGatewayWafDynamicManifestsDefault.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/providers/Microsoft.Network/applicationGatewayWafDynamicManifests/default", + "type": "Microsoft.Network/applicationGatewayWafDynamicManifest", + "properties": { + "defaultRuleSet": { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + }, + "availableRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "status": "0", + "tiers": [ + "WAF_v2" + ], + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200002, + "ruleIdString": "200002", + "description": "Failed to Parse Request Body.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200003, + "ruleIdString": "200003", + "description": "Multipart Request Body Strict Validation.", + "state": "Enabled", + "action": "AnomalyScoring" + }, + { + "ruleId": 200004, + "ruleIdString": "200004", + "description": "Possible Multipart Unmatched Boundary.", + "state": "Enabled", + "action": "AnomalyScoring" + } + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetInboundRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetInboundRoutes.json new file mode 100644 index 000000000000..b9078f3d09e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetInboundRoutes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2025-03-01", + "getInboundRoutesParameters": { + "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1", + "connectionType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "prefix": "192.168.50.0/24", + "asPath": "65520-65520", + "bgpCommunities": "4293853166,12076,51004" + }, + { + "prefix": "10.200.0.0/16", + "asPath": "65520-65520-12076-12076", + "bgpCommunities": "4293787629,12076,51027,4293734188" + } + ] + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetOutboundRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetOutboundRoutes.json new file mode 100644 index 000000000000..49d1e2cd3145 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetOutboundRoutes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2025-03-01", + "getOutboundRoutesParameters": { + "resourceUri": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGw1/expressRouteConnections/exrConn1", + "connectionType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "prefix": "192.168.50.0/24", + "asPath": "65520-65520", + "bgpCommunities": "4293853166,12076,51004" + }, + { + "prefix": "10.200.0.0/16", + "asPath": "65520-65520-12076-12076", + "bgpCommunities": "4293787629,12076,51027,4293734188" + } + ] + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetVirtualWanVpnServerConfigurations.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetVirtualWanVpnServerConfigurations.json new file mode 100644 index 000000000000..5d20bf887dc0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/GetVirtualWanVpnServerConfigurations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "vpnServerConfigurationResourceIds": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig2" + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableDelete.json new file mode 100644 index 000000000000..2120e17d6eb6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableGet.json new file mode 100644 index 000000000000..5d01c4cb5891 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableList.json new file mode 100644 index 000000000000..0baa47b13d1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTableList.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "hubRouteTable1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1a", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + }, + { + "name": "hubRouteTable2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route2a", + "destinationType": "CIDR", + "destinations": [ + "40.0.0.0/8", + "50.0.0.0/8", + "60.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/vn1" + } + ], + "labels": [ + "label3" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn4" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn2", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn1" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTablePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTablePut.json new file mode 100644 index 000000000000..75bf0565aeff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubRouteTablePut.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "routeTableParameters": { + "properties": { + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionDelete.json new file mode 100644 index 000000000000..cc923dcfcd9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionGet.json new file mode 100644 index 000000000000..e287d29a1e49 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionGet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionList.json new file mode 100644 index 000000000000..685ee04c1744 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionList.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + } + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + }, + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn2" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionPut.json new file mode 100644 index 000000000000..b59947419b00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/HubVirtualNetworkConnectionPut.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "hubVirtualNetworkConnectionParameters": { + "properties": { + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Updating", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "201": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Updating", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutesConfig": { + "propagateStaticRoutes": true, + "vnetLocalRouteOverrideCriteria": "Equal" + }, + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ], + "bgpConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/bgpConnections/bgpConn1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleCreate.json new file mode 100644 index 000000000000..d3b6fb7f27a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1", + "inboundNatRuleParameters": { + "properties": { + "protocol": "Tcp", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "idleTimeoutInMinutes": 4, + "enableTcpReset": false, + "enableFloatingIP": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": false, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + }, + "201": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": false, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleDelete.json new file mode 100644 index 000000000000..930051644fdb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleGet.json new file mode 100644 index 000000000000..76ce2fc43e73 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleList.json new file mode 100644 index 000000000000..5d21ecede02d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundNatRuleList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + }, + { + "name": "natRule1.3", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3392, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundSecurityRuleGet.json new file mode 100644 index 000000000000..6d373393967b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundSecurityRuleGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "ruleCollectionName": "rule1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "ruleType": "Permanent", + "provisioningState": "Succeeded", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundSecurityRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundSecurityRulePut.json new file mode 100644 index 000000000000..743d1b98ae67 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/InboundSecurityRulePut.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "ruleCollectionName": "rule1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "properties": { + "ruleType": "Permanent", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "ruleType": "Permanent", + "provisioningState": "Succeeded", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "ruleType": "Permanent", + "provisioningState": "Succeeded", + "rules": [ + { + "name": "inboundRule1", + "protocol": "TCP", + "sourceAddressPrefix": "50.20.121.5/32", + "destinationPortRange": 22, + "destinationPortRanges": [ + "80-100" + ], + "appliesOn": [ + "slbip1" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationCreate.json new file mode 100644 index 000000000000..eae8d4d7bf9d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation", + "parameters": { + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + }, + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + }, + "201": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationDelete.json new file mode 100644 index 000000000000..09ba894bdc71 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationGet.json new file mode 100644 index 000000000000..2013697f9f8c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation" + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationList.json new file mode 100644 index 000000000000..53bcca9b5e01 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipallocation1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation1", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + }, + { + "name": "test-ipallocation2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation2", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.6.0/24", + "ipamAllocationId": "57dc7256-2ff7-43f2-b9c8-85a70b5c6408", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationListByResourceGroup.json new file mode 100644 index 000000000000..6937eb8a9dd2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipallocation1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation1", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + }, + { + "name": "test-ipallocation2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation2", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.6.0/24", + "ipamAllocationId": "57dc7256-2ff7-43f2-b9c8-85a70b5c6408", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationUpdateTags.json new file mode 100644 index 000000000000..27e0257c70cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpAllocationUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation", + "location": "centraluseuap", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsCreate.json new file mode 100644 index 000000000000..1ad4407e4a3b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsCreate.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + }, + "201": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsDelete.json new file mode 100644 index 000000000000..929840ccc392 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Network/ipGroups/ipGroups1?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsGet.json new file mode 100644 index 000000000000..1d3ee4216276 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1" + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsListByResourceGroup.json new file mode 100644 index 000000000000..9f04170dff19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + }, + { + "name": "ipGroups2", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "14.64.39.16/32", + "41.74.146.80/31", + "42.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsListBySubscription.json new file mode 100644 index 000000000000..a7340ea49da2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsListBySubscription.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "iptag1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup1/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + }, + { + "name": "iptag2", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup2/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "14.64.39.16/32", + "41.74.146.80/31", + "42.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsUpdateTags.json new file mode 100644 index 000000000000..328db0e2a439 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpGroupsUpdateTags.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "ipGroupsName": "ipGroups1", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-03-01", + "subscriptionId": "subId", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ], + "firewallPolicies": [] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json new file mode 100644 index 000000000000..d584938086cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Create.json @@ -0,0 +1,83 @@ +{ + "title": "Create/Update the Pool resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool", + "body": { + "location": "eastus", + "properties": { + "description": "Test description.", + "parentPoolName": "", + "addressPrefixes": [ + "10.0.0.0/24" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPool", + "type": "Microsoft.Network/networkManagers/ipamPools", + "properties": { + "description": "Test description.", + "ipAddressType": [ + "IPv4" + ], + "parentPoolName": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "provisioningState": "Updating" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool", + "tags": {}, + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + }, + "201": { + "body": { + "name": "TestPool", + "type": "Microsoft.Network/networkManagers/ipamPools", + "properties": { + "description": "Test description.", + "ipAddressType": [ + "IPv4" + ], + "parentPoolName": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool", + "tags": {}, + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/ipamPoolOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Delete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Delete.json new file mode 100644 index 000000000000..5e90e13b9558 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Delete the Pool resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/ipamPoolOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Get.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Get.json new file mode 100644 index 000000000000..8fb80423bdb3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Get.json @@ -0,0 +1,41 @@ +{ + "title": "Gets the specific Pool resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool" + }, + "responses": { + "200": { + "body": { + "name": "TestPool", + "type": "Microsoft.Network/networkManagers/ipamPools", + "properties": { + "description": "Test description.", + "ipAddressType": [ + "IPv4" + ], + "parentPoolName": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool", + "tags": {}, + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_GetPoolUsage.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_GetPoolUsage.json new file mode 100644 index 000000000000..1cfe9e2bd2aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_GetPoolUsage.json @@ -0,0 +1,67 @@ +{ + "title": "Get the Pool Usage", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool" + }, + "responses": { + "200": { + "body": { + "addressPrefixes": [ + "10.0.0.0/8", + "192.0.0.0/8" + ], + "childPools": [ + { + "resourceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool1", + "addressPrefixes": [ + "10.0.2.0/26" + ] + }, + { + "resourceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool2", + "addressPrefixes": [ + "10.0.3.0/26" + ] + } + ], + "allocatedAddressPrefixes": [ + "10.0.2.0/26", + "10.0.3.0/26" + ], + "reservedAddressPrefixes": [ + "10.0.0.0/24" + ], + "availableAddressPrefixes": [ + "10.0.1.0/24", + "10.0.2.64/26", + "10.0.2.128/25", + "10.0.3.64/26", + "10.0.3.128/25", + "10.0.4.0/22", + "10.0.8.0/21", + "10.0.16.0/20", + "10.0.32.0/19", + "10.0.64.0/18", + "10.0.128.0/17", + "10.1.0.0/16", + "10.2.0.0/15", + "10.4.0.0/14", + "10.8.0.0/13", + "10.16.0.0/12", + "10.32.0.0/11", + "10.64.0.0/10", + "10.128.0.0/9", + "192.0.0.0/8" + ], + "totalNumberOfIPAddresses": "33554432", + "numberOfAllocatedIPAddresses": "128", + "numberOfReservedIPAddresses": "256", + "numberOfAvailableIPAddresses": "33554048" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_List.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_List.json new file mode 100644 index 000000000000..ee82a6e3bac3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_List.json @@ -0,0 +1,45 @@ +{ + "title": "Gets list of Pool resources at Network Manager level", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestPool", + "type": "Microsoft.Network/networkManagers/ipamPools", + "properties": { + "description": "Test description.", + "ipAddressType": [ + "IPv4" + ], + "parentPoolName": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool", + "tags": {}, + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_ListAssociatedResources.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_ListAssociatedResources.json new file mode 100644 index 000000000000..c5058324cd62 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_ListAssociatedResources.json @@ -0,0 +1,32 @@ +{ + "title": "List Associated Resource in the Pool", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/testVnet", + "poolId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool", + "description": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "reservedPrefixes": [], + "totalNumberOfIPAddresses": "256", + "numberOfReservedIPAddresses": "0", + "createdAt": "2020-09-09T20:00:00.0000000Z", + "reservationExpiresAt": null + } + ], + "nextLink": "{baseurl}/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/listAssociatedResources?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Update.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Update.json new file mode 100644 index 000000000000..d94ac263cace --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/IpamPools_Update.json @@ -0,0 +1,47 @@ +{ + "title": "Updates the specific Pool resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool", + "parameters": { + "properties": { + "description": "Test description.", + "displayName": "TestPool" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestPool", + "type": "Microsoft.Network/networkManagers/ipamPools", + "properties": { + "description": "Test description.", + "ipAddressType": [ + "IPv4" + ], + "parentPoolName": "test-ipam-pool", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool", + "tags": {}, + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json new file mode 100644 index 000000000000..e826a139b564 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json new file mode 100644 index 000000000000..840dfcbffd50 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json new file mode 100644 index 000000000000..96ebd6ef3e6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2025-03-01", + "parameters": { + "properties": { + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + }, + "201": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolDelete.json new file mode 100644 index 000000000000..aaa1a98e15ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolGet.json new file mode 100644 index 000000000000..adbaebe4c00b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolList.json new file mode 100644 index 000000000000..c1b38526975d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerBackendAddressPoolList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreate.json new file mode 100644 index 000000000000..9e320de32e38 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreate.json @@ -0,0 +1,347 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "properties": { + "scope": "Public", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "scope": "Public", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false, + "enableConnectionTracking": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "scope": "Public", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false, + "enableConnectionTracking": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json new file mode 100644 index 000000000000..04c861443810 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerConsumer.json @@ -0,0 +1,351 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json new file mode 100644 index 000000000000..e3874ce8d326 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithOneBackendPool.json @@ -0,0 +1,333 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + }, + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 0, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "All", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + }, + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + }, + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json new file mode 100644 index 000000000000..6e836af1321a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGatewayLoadBalancerProviderWithTwoBackendPool.json @@ -0,0 +1,364 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb1", + "properties": {} + }, + { + "name": "be-lb2", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 0, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "All", + "loadDistribution": "Default", + "backendAddressPool": {}, + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + }, + { + "name": "be-lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 0, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Gateway" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15000, + "identifier": 900, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + }, + { + "name": "be-lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "tunnelInterfaces": [ + { + "port": 15001, + "identifier": 901, + "protocol": "VXLAN", + "type": "Internal" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb2" + } + ], + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGlobalTier.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGlobalTier.json new file mode 100644 index 000000000000..ae331c7fde58 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateGlobalTier.json @@ -0,0 +1,317 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard", + "tier": "Global" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancerBackendAddresses": [ + { + "name": "regional-lb1-address", + "properties": { + "loadBalancerFrontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb" + } + } + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard", + "tier": "Global" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "regional-lb1-address", + "properties": { + "loadBalancerFrontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb" + } + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard", + "tier": "Global" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "regional-lb1-address", + "properties": { + "loadBalancerFrontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/regional-lb-rg1/providers/Microsoft.Network/loadBalancers/regional-lb/frontendIPConfigurations/fe-rlb" + } + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateStandardSku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateStandardSku.json new file mode 100644 index 000000000000..08e486568eb1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateStandardSku.json @@ -0,0 +1,344 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false, + "enableConnectionTracking": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false, + "enableConnectionTracking": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithInboundNatPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithInboundNatPool.json new file mode 100644 index 000000000000..bdaf8e21b6ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithInboundNatPool.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + } + }, + "name": "test", + "zones": [], + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + }, + "protocol": "Tcp", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "enableTcpReset": true + }, + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "type": "Microsoft.Network/loadBalancers/inboundNatPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "type": "Microsoft.Network/loadBalancers/inboundNatPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithOutboundRules.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithOutboundRules.json new file mode 100644 index 000000000000..115623ddb692 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithOutboundRules.json @@ -0,0 +1,426 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "protocol": "Tcp", + "loadDistribution": "Default", + "frontendPort": 80, + "backendPort": 80, + "idleTimeoutInMinutes": 15, + "enableFloatingIP": true, + "disableOutboundSnat": true + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [ + { + "name": "rule1", + "properties": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "protocol": "All" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "disableOutboundSnat": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "outboundRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "allocatedOutboundPorts": 1024, + "protocol": "All", + "enableTcpReset": false, + "idleTimeoutInMinutes": 4, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ] + } + } + ], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "disableOutboundSnat": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "outboundRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "allocatedOutboundPorts": 1024, + "protocol": "All", + "enableTcpReset": false, + "idleTimeoutInMinutes": 4, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ] + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json new file mode 100644 index 000000000000..8b5a0c47407d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithSyncModePropertyOnPool.json @@ -0,0 +1,355 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "syncMode": "Automatic", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + } + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "syncMode": "Automatic" + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "syncMode": "Automatic" + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithZones.json new file mode 100644 index 000000000000..13286b6415a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerCreateWithZones.json @@ -0,0 +1,351 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + }, + "zones": [ + "1" + ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerDelete.json new file mode 100644 index 000000000000..e7484dc6e6f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerFrontendIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerFrontendIPConfigurationGet.json new file mode 100644 index 000000000000..dec87f40b92a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerFrontendIPConfigurationGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "frontendIPConfigurationName": "frontend", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerFrontendIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerFrontendIPConfigurationList.json new file mode 100644 index 000000000000..0470bf608e9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerFrontendIPConfigurationList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerGet.json new file mode 100644 index 000000000000..1b97e07d7b23 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerGet.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "scope": "Public", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerGetInboundNatRulePortMapping.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerGetInboundNatRulePortMapping.json new file mode 100644 index 000000000000..51f33c36a683 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerGetInboundNatRulePortMapping.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "8bec96ef-0a6a-45b8-9860-4ffde7bf3572", + "properties": { + "ipAddress": "10.0.0.4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "inboundNatRulesPortMapping": [ + { + "inboundNatRuleName": "natRule", + "frontendPort": 3389, + "backendPort": 3389 + } + ] + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 0, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendPortRangeStart": 3389, + "frontendPortRangeEnd": 4000, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + } + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerHealth.json new file mode 100644 index 000000000000..fb0b2621d3b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerHealth.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "groupName": "rg1", + "loadBalancerName": "lb1", + "loadBalancingRuleName": "rulelb" + }, + "responses": { + "200": { + "body": { + "up": 1, + "down": 0, + "loadBalancerBackendAddresses": [ + { + "ipAddress": "10.1.0.4", + "networkInterfaceIPConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/NIC1/IpConfigurations/ipConfig", + "state": "Up", + "reason": "Up_Probe_Success" + } + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus2euap/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerList.json new file mode 100644 index 000000000000..1713c7a43bc1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerList.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + }, + { + "name": "lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerListAll.json new file mode 100644 index 000000000000..31639eb35f58 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerListAll.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + }, + { + "name": "lb3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerLoadBalancingRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerLoadBalancingRuleGet.json new file mode 100644 index 000000000000..530f2e1d06e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerLoadBalancingRuleGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "loadBalancingRuleName": "rule1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerLoadBalancingRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerLoadBalancingRuleList.json new file mode 100644 index 000000000000..fcdbf10eac9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerLoadBalancingRuleList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerNetworkInterfaceListSimple.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerNetworkInterfaceListSimple.json new file mode 100644 index 000000000000..870a51ccac0a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerNetworkInterfaceListSimple.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mynic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inbound1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerNetworkInterfaceListVmss.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerNetworkInterfaceListVmss.json new file mode 100644 index 000000000000..af7f67977826 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerNetworkInterfaceListVmss.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerOutboundRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerOutboundRuleGet.json new file mode 100644 index 000000000000..b0a9fedd2d74 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerOutboundRuleGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "outboundRuleName": "rule1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerOutboundRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerOutboundRuleList.json new file mode 100644 index 000000000000..b85a54bfd67e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerOutboundRuleList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerProbeGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerProbeGet.json new file mode 100644 index 000000000000..1f3aa083bad7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerProbeGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "probeName": "probe1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerProbeList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerProbeList.json new file mode 100644 index 000000000000..48b39224c581 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerProbeList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerUpdateTags.json new file mode 100644 index 000000000000..372acb172128 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancerUpdateTags.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancersSwapPublicIpAddresses.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancersSwapPublicIpAddresses.json new file mode 100644 index 000000000000..b47e58610dc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LoadBalancersSwapPublicIpAddresses.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "location": "westus", + "parameters": { + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfe1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/pip2" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb2/frontendIPConfigurations/lbfe2", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip1" + } + } + } + ] + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayCreate.json new file mode 100644 index 000000000000..95be2f1a2011 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayCreate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw", + "parameters": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14", + "fqdn": "site1.contoso.com" + }, + "location": "Central US" + } + }, + "responses": { + "201": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14" + } + } + }, + "200": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayDelete.json new file mode 100644 index 000000000000..b084111fc931 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayGet.json new file mode 100644 index 000000000000..575c55cc1ace --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw" + }, + "responses": { + "200": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayList.json new file mode 100644 index 000000000000..15a880c8913b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "localgw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + }, + { + "name": "localgw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.2.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..138720357b28 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/LocalNetworkGatewayUpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/MigrateLoadBalancerToIPBased.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/MigrateLoadBalancerToIPBased.json new file mode 100644 index 000000000000..44367816b8fa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/MigrateLoadBalancerToIPBased.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "groupName": "rg1", + "loadBalancerName": "lb1", + "parameters": { + "pools": [ + "pool1", + "pool2" + ] + } + }, + "responses": { + "200": { + "body": { + "migratedPools": [ + "pool1", + "pool2" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayCreateOrUpdate.json new file mode 100644 index 000000000000..c3d748b9a6b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayCreateOrUpdate.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natgateway", + "parameters": { + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + }, + "201": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayCreateOrUpdateStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayCreateOrUpdateStandardV2Sku.json new file mode 100644 index 000000000000..a5ecae85c95c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayCreateOrUpdateStandardV2Sku.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natgateway", + "parameters": { + "location": "westus", + "sku": { + "name": "StandardV2" + }, + "properties": { + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ], + "sourceVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + }, + "type": "Microsoft.Network/natGateways" + } + }, + "201": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "publicIpAddressesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2" + } + ], + "publicIpPrefixesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ], + "sourceVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + }, + "type": "Microsoft.Network/natGateways" + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayDelete.json new file mode 100644 index 000000000000..f889abbcf71c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/westus2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayGet.json new file mode 100644 index 000000000000..0328dab07cf5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayGetStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayGetStandardV2Sku.json new file mode 100644 index 000000000000..12f14a3b6f3d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayGetStandardV2Sku.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "publicIpAddressesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2" + } + ], + "publicIpPrefixesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ], + "sourceVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayList.json new file mode 100644 index 000000000000..cde17bd70577 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayList.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateway/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway2", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway3", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway3", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "publicIpAddressesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2" + } + ], + "publicIpPrefixesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ], + "sourceVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + }, + "type": "Microsoft.Network/natGateways" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayListAll.json new file mode 100644 index 000000000000..7813bc23b60b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayListAll.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway2", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway3", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway3", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "publicIpAddressesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2" + } + ], + "publicIpPrefixesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ], + "sourceVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + }, + "type": "Microsoft.Network/natGateways" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayUpdateTags.json new file mode 100644 index 000000000000..13dce778b4cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayUpdateTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayUpdateTagsStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayUpdateTagsStandardV2Sku.json new file mode 100644 index 000000000000..48ae5ab44fc7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatGatewayUpdateTagsStandardV2Sku.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "publicIpAddressesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress2" + } + ], + "publicIpPrefixesV6": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix2" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ], + "sourceVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleDelete.json new file mode 100644 index 000000000000..95092183ad71 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleGet.json new file mode 100644 index 000000000000..8ccdbf3fe157 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "natRuleName": "natRule1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [], + "egressVpnSiteLinkConnections": [], + "ingressVpnSiteLinkConnections": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleList.json new file mode 100644 index 000000000000..6241bcabe211 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRuleList.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRulePut.json new file mode 100644 index 000000000000..5ad32a0f86d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NatRulePut.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "NatRuleParameters": { + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + } + }, + "201": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/cloudnet1-VNG/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection1" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/vpnLinkConnection2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceCreate.json new file mode 100644 index 000000000000..95da2beb1f36 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceCreate.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + } + } + }, + { + "name": "ipconfig2", + "properties": { + "privateIPAddressPrefixLength": 28 + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + }, + "201": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json new file mode 100644 index 000000000000..9175ae1f1931 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceCreateGatewayLoadBalancerConsumer.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + }, + "201": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "gatewayLoadBalancer": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb-provider" + } + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceDelete.json new file mode 100644 index 000000000000..d8bd77dfd910 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceEffectiveNSGList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceEffectiveNSGList.json new file mode 100644 index 000000000000..33cb51148f9e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceEffectiveNSGList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" + }, + "association": { + "networkManager": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "networkInterface": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "effectiveSecurityRules": [ + { + "name": "securityRules/rule1", + "protocol": "Tcp", + "sourcePortRange": "456-456", + "destinationPortRange": "6579-6579", + "sourceAddressPrefix": "0.0.0.0/32", + "destinationAddressPrefix": "0.0.0.0/32", + "access": "Allow", + "priority": 234, + "direction": "Inbound" + }, + { + "name": "securityRules/default-allow-rdp", + "protocol": "Tcp", + "sourcePortRange": "0-65535", + "destinationPortRange": "3389-3389", + "sourceAddressPrefix": "1.1.1.1/32", + "destinationAddressPrefix": "0.0.0.0/0", + "access": "Allow", + "priority": 1000, + "direction": "Inbound" + }, + { + "name": "defaultSecurityRules/AllowInternetOutBound", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "0.0.0.0/0", + "destinationAddressPrefix": "Internet", + "expandedDestinationAddressPrefix": [ + "32.0.0.0/3", + "4.0.0.0/6", + "2.0.0.0/7", + "1.0.0.0/8" + ], + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com//subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceEffectiveRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceEffectiveRouteTableList.json new file mode 100644 index 000000000000..027d414402fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceEffectiveRouteTableList.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.20.2.0/24" + ], + "nextHopType": "VnetLocal", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "0.0.0.0/0" + ], + "nextHopType": "Internet", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "10.0.0.0/8" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "100.64.0.0/10" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.16.0.0/12" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "192.168.0.0/16" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceGet.json new file mode 100644 index 000000000000..c93edf2b0dc9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceGet.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "dscpConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/dscpConfiguration/mydscpconfiguration" + }, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceIPConfigurationGet.json new file mode 100644 index 000000000000..0e0e154f0c7f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceIPConfigurationGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "ipConfigurationName": "ipconfig1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ], + "virtualNetworkTaps": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP1" + }, + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceIPConfigurationList.json new file mode 100644 index 000000000000..ea4feb3aee94 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceIPConfigurationList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet12/subnets/subnet12" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceList.json new file mode 100644 index 000000000000..6cb52aabb40a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceList.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + }, + { + "name": "test-nic2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + }, + { + "name": "ipconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.16/28", + "privateIPAddressPrefixLength": 28, + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": false, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceListAll.json new file mode 100644 index 000000000000..0909ffefb678 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceListAll.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + }, + { + "name": "test-nic2", + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceLoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceLoadBalancerList.json new file mode 100644 index 000000000000..7a8df5479f3b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceLoadBalancerList.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lbname1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "frontendIPConfigurations": [ + { + "name": "lbfrontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/publicIPAddresses/myDynamicPublicIP" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "bepool1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1" + } + } + } + ], + "probes": [ + { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "probeThreshold": 1, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inbound1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationCreate.json new file mode 100644 index 000000000000..c5da840f4499 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2025-03-01", + "tapConfigurationParameters": { + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + }, + "201": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationDelete.json new file mode 100644 index 000000000000..9e53f69b0447 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationGet.json new file mode 100644 index 000000000000..4bea30e13302 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationList.json new file mode 100644 index 000000000000..d481e8d5d439 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceTapConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceUpdateTags.json new file mode 100644 index 000000000000..2e40f0385800 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkInterfaceUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableIPForwarding": false, + "vnetEncryptionSupported": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json new file mode 100644 index 000000000000..aa1bb7f2fd81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerActiveConnectivityConfigurationsList.json @@ -0,0 +1,59 @@ +{ + "title": "Get Azure Virtual Network Manager Active Connectivity Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "parameters": { + "regions": [ + "westus" + ], + "skipToken": "fakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "region": "westus", + "commitTime": "2020-07-10T18:03:22.2578238+05:30", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "isGlobal": "True", + "deleteExistingPeering": "True", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "provisioningState": "Succeeded" + }, + "configurationGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerActiveSecurityAdminRulesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerActiveSecurityAdminRulesList.json new file mode 100644 index 000000000000..309d6f0fac2a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerActiveSecurityAdminRulesList.json @@ -0,0 +1,73 @@ +{ + "title": "Get Azure Virtual Network Manager Active Security Admin Rules", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "parameters": { + "regions": [ + "westus" + ], + "skipToken": "fakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "region": "westus", + "commitTime": "2020-07-10T18:03:22.2578238+05:30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "configurationDescription": "SampleDescription", + "ruleCollectionDescription": "SampleRuleCollectionDescription", + "ruleCollectionAppliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1" + } + ], + "kind": "Default", + "properties": { + "description": "Sample Admin Rule", + "flag": "AllowVnetInbound", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "access": "Deny", + "priority": 1, + "provisioningState": "Succeeded" + }, + "ruleGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionDelete.json new file mode 100644 index 000000000000..70004c9599da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionGet.json new file mode 100644 index 000000000000..077ada4d7fb4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionList.json new file mode 100644 index 000000000000..1b57508c63b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionPut.json new file mode 100644 index 000000000000..c9e9fe04a5a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleCollectionPut.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleCollection": { + "properties": { + "description": "A sample policy", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleDelete.json new file mode 100644 index 000000000000..61ee19cd1a8e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleGet.json new file mode 100644 index 000000000000..cc3dac50ab62 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleList.json new file mode 100644 index 000000000000..29f197d5be9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRuleList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "kind": "Custom", + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagers/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRulePut.json new file mode 100644 index 000000000000..72f89c861ee6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRulePut.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule", + "adminRule": { + "kind": "Custom", + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRulePut_NetworkGroupSource.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRulePut_NetworkGroupSource.json new file mode 100644 index 000000000000..c4889a334ad0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerAdminRulePut_NetworkGroupSource.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleAdminRule", + "adminRule": { + "kind": "Custom", + "properties": { + "description": "This is Sample Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "NetworkGroup", + "addressPrefix": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/ng1" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule using a network group as a source and destination.", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleAdminRule", + "kind": "Custom", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule using a network group as a source and destination.", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "ServiceTag", + "addressPrefix": "Internet" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerCommitPost.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerCommitPost.json new file mode 100644 index 000000000000..801574a1efcb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerCommitPost.json @@ -0,0 +1,47 @@ +{ + "title": "Post Azure Virtual Network Manager Commit", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resoureGroupSample", + "networkManagerName": "testNetworkManager", + "parameters": { + "targetLocations": [ + "useast" + ], + "configurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig" + ], + "commitType": "SecurityAdmin" + } + }, + "responses": { + "200": { + "body": { + "commitId": "testCommitId", + "targetLocations": [ + "useast" + ], + "configurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig" + ], + "commitType": "SecurityAdmin" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "commitId": "testCommitId", + "targetLocations": [ + "useast" + ], + "configurationIds": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resoureGroupSample/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/SampleSecurityAdminConfig" + ], + "commitType": "SecurityAdmin" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupDelete.json new file mode 100644 index 000000000000..87d24b331a04 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupDelete.json @@ -0,0 +1,12 @@ +{ + "title": "Delete Management Group Connection to Azure Virtual Network Manager", + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "managementGroupA", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupGet.json new file mode 100644 index 000000000000..b7598b52663a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupGet.json @@ -0,0 +1,33 @@ +{ + "title": "Get Management Group Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "managementGroupA", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "providers/Microsoft.Management/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupList.json new file mode 100644 index 000000000000..1ef1c35b55fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupList.json @@ -0,0 +1,37 @@ +{ + "title": "List Management Group Azure Virtual Network Manager Connections", + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "managementGroupA" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + ], + "nextLink": "{baseurl}/managementGroups/subscriptionA/providers/Microsoft.Network/networkManagerConnections?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupPut.json new file mode 100644 index 000000000000..e18fe3bc5e20 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionManagementGroupPut.json @@ -0,0 +1,61 @@ +{ + "title": "Create/Update Management Group Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2025-03-01", + "managementGroupId": "managementGroupA", + "networkManagerConnectionName": "TestNMConnection", + "parameters": { + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/providers/Microsoft.Management/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/managementGroups/managementGroupA/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionDelete.json new file mode 100644 index 000000000000..28e3bd148ed1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionDelete.json @@ -0,0 +1,12 @@ +{ + "title": "Delete Subscription Connection to Azure Virtual Network Manager", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionGet.json new file mode 100644 index 000000000000..8b17e614d6e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionGet.json @@ -0,0 +1,33 @@ +{ + "title": "Get Subscription Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "networkManagerConnectionName": "TestNMConnection" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionList.json new file mode 100644 index 000000000000..6e6ed2c4da9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionList.json @@ -0,0 +1,37 @@ +{ + "title": "List Subscription Azure Virtual Network Manager Connections", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionPut.json new file mode 100644 index 000000000000..837a28bc37a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectionSubscriptionPut.json @@ -0,0 +1,61 @@ +{ + "title": "Create/Update Subscription Azure Virtual Network Manager Connection", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "networkManagerConnectionName": "TestNMConnection", + "parameters": { + "properties": { + "networkManagerId": "/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestNMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagerConnections/TestNMConnection", + "type": "Microsoft.Network/networkManagerConnections", + "name": "TestMConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "networkManagerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "connectionState": "Pending", + "description": "This is a network manager connection to testNetworkManager." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationDelete.json new file mode 100644 index 000000000000..091369d295ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationDelete.json @@ -0,0 +1,20 @@ +{ + "title": "Get Azure Virtual Network Manager Connectivity Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestConnectivityConfig", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/connectivityConfigurations/myTestConnectivityConfig/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationGet.json new file mode 100644 index 000000000000..51d701173c6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationGet.json @@ -0,0 +1,54 @@ +{ + "title": "Get Azure Virtual Network Manager Connectivity Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestConnectivityConfig" + }, + "responses": { + "200": { + "body": { + "name": "myTestConnectivityConfig", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "isGlobal": "True", + "deleteExistingPeering": "True", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "connectivityCapabilities": { + "connectedGroupPrivateEndpointsScale": "Standard", + "connectedGroupAddressOverlap": "Allowed", + "peeringEnforcement": "Unenforced" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationList.json new file mode 100644 index 000000000000..2f6250b0ef97 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationList.json @@ -0,0 +1,58 @@ +{ + "title": "Get Azure Virtual Network Manager Connecitivity Configuration List", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myTestConnectivityConfig", + "id": "subscription/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/netwrokGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "connectivityCapabilities": { + "connectedGroupPrivateEndpointsScale": "Standard", + "connectedGroupAddressOverlap": "Allowed", + "peeringEnforcement": "Unenforced" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/managedNetworks/testNetworkManager/connectivityConfigurations?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationPut.json new file mode 100644 index 000000000000..3f12d75ac3ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerConnectivityConfigurationPut.json @@ -0,0 +1,123 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Connectivity Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestConnectivityConfig", + "connectivityConfiguration": { + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "connectivityCapabilities": { + "connectedGroupPrivateEndpointsScale": "Standard", + "connectedGroupAddressOverlap": "Allowed", + "peeringEnforcement": "Unenforced" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myTestConnectivityConfig", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Connectivity Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "connectivityCapabilities": { + "connectedGroupPrivateEndpointsScale": "Standard", + "connectedGroupAddressOverlap": "Allowed", + "peeringEnforcement": "Unenforced" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "myTestConnectivityConfig", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "type": "Microsoft.Network/networkManagers/connectivityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myTestConnectivityConfig", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "deleteExistingPeering": "True", + "isGlobal": "True", + "appliesToGroups": [ + { + "networkGroupId": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "connectivityCapabilities": { + "connectedGroupPrivateEndpointsScale": "Standard", + "connectedGroupAddressOverlap": "Allowed", + "peeringEnforcement": "Unenforced" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDefaultAdminRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDefaultAdminRuleGet.json new file mode 100644 index 000000000000..d5e14c690110 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDefaultAdminRuleGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleDefaultAdminRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleDefaultAdminRule", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations/ruleCollections/rules", + "name": "SampleDefaultAdminRule", + "kind": "Default", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "flag": "AllowVnetInbound", + "description": "This is Sample Default Admin Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "access": "Deny", + "priority": 1, + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDelete.json new file mode 100644 index 000000000000..fc93968dafdc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDelete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete Azure Virtual Network Manager", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDeploymentStatusList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDeploymentStatusList.json new file mode 100644 index 000000000000..d9a520d4a28f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerDeploymentStatusList.json @@ -0,0 +1,51 @@ +{ + "title": "Post Azure Virtual Network Manager Deployment Status", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resoureGroupSample", + "networkManagerName": "testNetworkManager", + "parameters": { + "regions": [ + "eastus", + "westus" + ], + "deploymentTypes": [ + "Connectivity", + "AdminPolicy" + ], + "skipToken": "FakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentType": "AdminPolicy", + "configurationIds": [ + "SecConfig1", + "SecConfig2" + ], + "commitTime": "2021-01-26T06:58:50.883Z", + "region": "eastus", + "deploymentStatus": "Deploying", + "errorMessage": "" + }, + { + "deploymentType": "Connectivity", + "configurationIds": [ + "ConnConfig1", + "ConnConfig2" + ], + "commitTime": "2021-01-26T06:58:50.883Z", + "region": "eastus", + "deploymentStatus": "Deployed", + "errorMessage": "" + } + ], + "skipToken": "NextFakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json new file mode 100644 index 000000000000..1bef99b0e3a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerEffectiveConnectivityConfigurationsList.json @@ -0,0 +1,59 @@ +{ + "title": "List Azure Virtual Network Manager Effective Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "virtualNetworkName": "testVirtualNetwork", + "parameters": { + "skipToken": "FakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/connectivityConfigurations/myTestConnectivityConfig", + "properties": { + "description": "Sample Configuration", + "connectivityTopology": "HubAndSpoke", + "hubs": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myHubVnet", + "resourceType": "Microsoft.Network/virtualNetworks" + } + ], + "isGlobal": "True", + "deleteExistingPeering": "True", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/groups/group1", + "useHubGateway": "True", + "groupConnectivity": "None", + "isGlobal": "False" + } + ], + "connectivityCapabilities": { + "connectedGroupPrivateEndpointsScale": "Standard", + "connectedGroupAddressOverlap": "Allowed", + "peeringEnforcement": "Unenforced" + }, + "provisioningState": "Succeeded" + }, + "configurationGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json new file mode 100644 index 000000000000..59abfb552afe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerEffectiveSecurityAdminRulesList.json @@ -0,0 +1,68 @@ +{ + "title": "List Azure Virtual Network Manager Effective Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "virtualNetworkName": "testVirtualNetwork", + "parameters": { + "skipToken": "FakeSkipTokenCode" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "configurationDescription": "SampleDescription", + "ruleCollectionDescription": "SampleRuleCollectionDescription", + "ruleCollectionAppliesToGroups": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1" + } + ], + "kind": "Default", + "properties": { + "description": "Sample Admin Rule", + "flag": "AllowVnetInbound", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "access": "Deny", + "priority": 1, + "provisioningState": "Succeeded" + }, + "ruleGroups": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/group1", + "properties": { + "description": "A group for all test Virtual Networks", + "provisioningState": "Succeeded" + } + } + ] + } + ], + "skipToken": "FakeSkipTokenCode" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGet.json new file mode 100644 index 000000000000..373978861ef9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGet.json @@ -0,0 +1,40 @@ +{ + "title": "Get Azure Virtual Network Manager", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManagers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "SecurityUser" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupDelete.json new file mode 100644 index 000000000000..4d6080ab04cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupDelete.json @@ -0,0 +1,20 @@ +{ + "title": "Delete Azure Virtual Network Manager Group", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/networkGroups/testNetworkGroup/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupGet.json new file mode 100644 index 000000000000..9547e8cc9112 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupGet.json @@ -0,0 +1,33 @@ +{ + "title": "Get Azure Virtual Network Manager Network Group", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup" + }, + "responses": { + "200": { + "body": { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "memberType": "VirtualNetwork", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupList.json new file mode 100644 index 000000000000..501fc59851d5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupList.json @@ -0,0 +1,37 @@ +{ + "title": "List Azure Virtual Network Manager Network Groups", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "memberType": "VirtualNetwork", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupPut.json new file mode 100644 index 000000000000..36aed084065e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerGroupPut.json @@ -0,0 +1,66 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Network Group", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "parameters": { + "properties": { + "description": "A sample group", + "memberType": "VirtualNetwork" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "memberType": "VirtualNetwork", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testNetworkGroup", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup", + "type": "Microsoft.Network/networkManagers/networkGroups", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample group", + "memberType": "VirtualNetwork", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerList.json new file mode 100644 index 000000000000..b0fdfee5ebc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerList.json @@ -0,0 +1,45 @@ +{ + "title": "List Azure Virtual Network Manager", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerListAll.json new file mode 100644 index 000000000000..4dbd1da036e9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerListAll.json @@ -0,0 +1,44 @@ +{ + "title": "List Azure Virtual Network Manager in Subscription", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "SecurityUser" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/networkManagers?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerPatch.json new file mode 100644 index 000000000000..c74f02f5ab3d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerPatch.json @@ -0,0 +1,52 @@ +{ + "title": "Patch Managed Network Tags", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager", + "type": "Microsoft.Network/networkManager", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000001" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerPut.json new file mode 100644 index 000000000000..ddd5c9355e30 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerPut.json @@ -0,0 +1,91 @@ +{ + "title": "Create/Update Azure Virtual Network Manager", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "parameters": { + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [ + "/Microsoft.Management/testmg" + ], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [ + "Microsoft.Management/managementGroups/testMg" + ], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "TestNetworkManager", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager", + "type": "Microsoft.Network/networkManagers", + "etag": "sadf-asdf-asdf-asdf", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "My Test Network Manager", + "networkManagerScopes": { + "managementGroups": [ + "Microsoft.Management/managementGroups/testMg" + ], + "subscriptions": [ + "/subscriptions/00000000-0000-0000-0000-000000000000" + ] + }, + "networkManagerScopeAccesses": [ + "Connectivity" + ], + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationDelete.json new file mode 100644 index 000000000000..d5b8a603d867 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestRoutingConfig" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationGet.json new file mode 100644 index 000000000000..7087b980db6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestRoutingConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig", + "name": "myTestRoutingConfig", + "type": "Microsoft.Network/networkManagers/routingConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "routeTableUsageMode": "ManagedOnly", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationList.json new file mode 100644 index 000000000000..a29425c16174 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig", + "name": "myTestRoutingConfig", + "type": "Microsoft.Network/networkManagers/routingConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "routeTableUsageMode": "ManagedOnly", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationPut.json new file mode 100644 index 000000000000..f726a92f2cce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingConfigurationPut.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestRoutingConfig", + "networkManagerName": "testNetworkManager", + "routingConfiguration": { + "properties": { + "description": "A sample policy", + "routeTableUsageMode": "ManagedOnly" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/routingConfigurations/myTestRoutingConfig", + "name": "myTestRoutingConfig", + "type": "Microsoft.Network/networkManagers/routingConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "routeTableUsageMode": "ManagedOnly", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/routingConfigurations/myTestRoutingConfig", + "name": "myTestRoutingConfig", + "type": "Microsoft.Network/networkManagers/routingConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "routeTableUsageMode": "ManagedOnly", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionDelete.json new file mode 100644 index 000000000000..12d6b6b2b5d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestRoutingConfig", + "ruleCollectionName": "testRuleCollection" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionGet.json new file mode 100644 index 000000000000..8649a2e7d4d6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestRoutingConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "disableBgpRoutePropagation": "False", + "appliesTo": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionList.json new file mode 100644 index 000000000000..23d7fe1f3d13 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestRoutingConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "disableBgpRoutePropagation": "False", + "appliesTo": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections?api-version=2023-03-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionPut.json new file mode 100644 index 000000000000..2a4b7f625cf3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleCollectionPut.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestRoutingConfig", + "ruleCollectionName": "testRuleCollection", + "ruleCollection": { + "properties": { + "description": "A sample policy", + "appliesTo": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection", + "name": "myTestRoutingConfig", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "disableBgpRoutePropagation": "False", + "appliesTo": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/routingConfigurations/myTestRoutingConfig", + "name": "myTestRoutingConfig", + "type": "Microsoft.Network/networkManagers/routingConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "disableBgpRoutePropagation": "False", + "appliesTo": [ + { + "networkGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleDelete.json new file mode 100644 index 000000000000..8ad477ef7e76 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestRoutingConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "sampleRule", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection/rules/sampleRule/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleGet.json new file mode 100644 index 000000000000..f4c7491df52b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleRoutingRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleRoutingRule", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules", + "name": "SampleRoutingRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is a routing rule", + "destination": { + "destinationAddress": "10.0.0.0/16", + "type": "AddressPrefix" + }, + "nextHop": { + "nextHopAddress": "", + "nextHopType": "VirtualNetworkGateway" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleList.json new file mode 100644 index 000000000000..a28d6012f8e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRuleList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestRoutingConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection/rules/SampleAdminRule", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules", + "name": "SampleRoutingRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Admin Rule", + "destination": { + "destinationAddress": "10.0.0.0/16", + "type": "AddressPrefix" + }, + "nextHop": { + "nextHopAddress": "", + "nextHopType": "VirtualNetworkGateway" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkManagers/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection/rules?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRulePut.json new file mode 100644 index 000000000000..64d72aadda79 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerRoutingRulePut.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestRoutingConfig", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleRoutingRule", + "routingRule": { + "properties": { + "description": "This is Sample Routing Rule", + "destination": { + "destinationAddress": "10.0.0.0/16", + "type": "AddressPrefix" + }, + "nextHop": { + "nextHopType": "VirtualNetworkGateway" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/routingConfigurations/myTestRoutingConfig/ruleCollections/testRuleCollection/rules/SampleRoutingRule", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules", + "name": "SampleRoutingRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Routing Rule", + "destination": { + "destinationAddress": "10.0.0.0/16", + "type": "AddressPrefix" + }, + "nextHop": { + "nextHopAddress": "", + "nextHopType": "VirtualNetworkGateway" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/RoutingAdminConfigurations/myTestRoutingConfig/ruleCollections/rules/SampleRoutingRule", + "type": "Microsoft.Network/networkManagers/routingConfigurations/ruleCollections/rules", + "name": "SampleRoutingRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "This is Sample Routing Rule", + "destination": { + "destinationAddress": "0.0.0.0/0", + "type": "AddressPrefix" + }, + "nextHop": { + "nextHopAddress": "", + "nextHopType": "VirtualNetworkGateway" + }, + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionDelete.json new file mode 100644 index 000000000000..8131e185d737 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionDelete.json @@ -0,0 +1,15 @@ +{ + "title": "Delete Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "scopeConnectionName": "TestScopeConnection", + "force": false + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionGet.json new file mode 100644 index 000000000000..f2a56bd17599 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionGet.json @@ -0,0 +1,36 @@ +{ + "title": "Get Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "scopeConnectionName": "TestScopeConnection" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "name": "TestScopeConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "connectionState": "Pending", + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000", + "description": "This is a scope connection to a cross tenant subscription." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionList.json new file mode 100644 index 000000000000..579219d746e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionList.json @@ -0,0 +1,40 @@ +{ + "title": "List Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "name": "TestScopeConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "connectionState": "Pending", + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000", + "description": "This is a scope connection to a cross tenant subscription." + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections?api-version=2021-02-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionPut.json new file mode 100644 index 000000000000..e24f3c90333c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerScopeConnectionPut.json @@ -0,0 +1,66 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Scope Connection", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "scopeConnectionName": "TestScopeConnection", + "parameters": { + "properties": { + "tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f", + "resourceId": "subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b", + "description": "This is a scope connection to a cross tenant subscription." + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "name": "TestScopeConnection", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "00000000-0000-0000-0000-000000000000", + "connectionState": "Pending", + "resourceId": "subscriptions/00000000-0000-0000-0000-000000000000", + "description": "This is a scope connection to a cross tenant subscription." + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection", + "type": "Microsoft.Network/networkManagers/scopeConnections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "tenantId": "6babcaad-604b-40ac-a9d7-9fd97c0b779f", + "connectionState": "Pending", + "resourceId": "subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b", + "description": "This is a scope connection to a cross tenant subscription." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json new file mode 100644 index 000000000000..6f2d60877864 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationGet.json new file mode 100644 index 000000000000..393df6304e0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationList.json new file mode 100644 index 000000000000..66c0b22d2ded --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityAdminConfigurations?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationPut.json new file mode 100644 index 000000000000..ce36c5dee00e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationPut.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "securityAdminConfiguration": { + "properties": { + "description": "A sample policy", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "applyOnNetworkIntentPolicyBasedServices": [ + "None" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationPut_ManualAggregation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationPut_ManualAggregation.json new file mode 100644 index 000000000000..5ba232de022e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityAdminConfigurationPut_ManualAggregation.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "securityAdminConfiguration": { + "properties": { + "description": "A configuration which will update any network groups ip addresses at commit times.", + "networkGroupAddressSpaceAggregationOption": "Manual" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "networkGroupAddressSpaceAggregationOption": "Manual" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityAdminConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityAdminConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "networkGroupAddressSpaceAggregationOption": "Manual" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationDelete.json new file mode 100644 index 000000000000..eef2fb281aad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationGet.json new file mode 100644 index 000000000000..70335c8a9e09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityUserConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "f506e3ca-4d68-41f1-9099-b50bc2c1b198" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationList.json new file mode 100644 index 000000000000..9f7ee279820b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityUserConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "f506e3ca-4d68-41f1-9099-b50bc2c1b198" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationPut.json new file mode 100644 index 000000000000..664706feaa5d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserConfigurationPut.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "securityUserConfiguration": { + "properties": { + "description": "A sample policy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "e74045ed-c817-48df-adb2-a06753ad4fff" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityConfigurations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "resourceGuid": "e74045ed-c817-48df-adb2-a06753ad4fff" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionDelete.json new file mode 100644 index 000000000000..eaba7a81d06e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionGet.json new file mode 100644 index 000000000000..b659eb943570 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ], + "resourceGuid": "4224a5e7-d273-43d4-9bb0-b38e9b937ded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionList.json new file mode 100644 index 000000000000..92e5e8544d0e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "testRuleCollection", + "type": "Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample rule collection", + "provisioningState": "Succeeded", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ], + "resourceGuid": "4224a5e7-d273-43d4-9bb0-b38e9b937ded" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionPut.json new file mode 100644 index 000000000000..93a7865b38df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleCollectionPut.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "securityUserRuleCollection": { + "properties": { + "description": "A sample policy", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ], + "resourceGuid": "4224a5e7-d273-43d4-9bb0-b38e9b937ded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/securityUserConfigurations/myTestSecurityConfig", + "name": "myTestSecurityConfig", + "type": "Microsoft.Network/networkManagers/securityUserConfigurations/ruleCollections", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample policy", + "provisioningState": "Succeeded", + "appliesToGroups": [ + { + "networkGroupId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testGroup" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleDelete.json new file mode 100644 index 000000000000..90d2884656f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleUserRule", + "force": false + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleGet.json new file mode 100644 index 000000000000..709e2fcff8f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleGet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig", + "networkManagerName": "testNetworkManager", + "ruleName": "SampleUserRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/SecurityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule", + "type": "Microsoft.Network/networkManagers/SecurityUserConfigurations/ruleCollections/rules", + "name": "SampleUserRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample User Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "f930553b-f78d-48c5-9445-6cf86b85e615" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleList.json new file mode 100644 index 000000000000..976e62c1ad62 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRuleList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "ruleCollectionName": "testRuleCollection", + "configurationName": "myTestSecurityConfig" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkmanagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule", + "type": "Microsoft.Network/networkManagers/securityConfigurations/ruleCollections/rules", + "name": "SampleUserRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample User Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "f930553b-f78d-48c5-9445-6cf86b85e615" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRulePut.json new file mode 100644 index 000000000000..9a09b7840b0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerSecurityUserRulePut.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "configurationName": "myTestSecurityConfig", + "ruleCollectionName": "testRuleCollection", + "ruleName": "SampleUserRule", + "securityUserRule": { + "properties": { + "description": "Sample User Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/SecurityUserConfigurations/Policy1/ruleCollections/testRuleCollection/rules/SampleUserRule", + "type": "Microsoft.Network/networkManagers/SecurityUserConfigurations/ruleCollections/rules", + "name": "SampleUserRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample User Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "f930553b-f78d-48c5-9445-6cf86b85e615" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/securityUserConfigurations/myTestSecurityConfig/ruleCollections/testRuleCollection/rules/SampleUserRule", + "type": "Microsoft.Network/networkManagers/SecurityUserConfigurations/ruleCollections/rules", + "name": "SampleUserRule", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "Sample User Rule", + "protocol": "Tcp", + "sources": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "destinations": [ + { + "addressPrefixType": "IPPrefix", + "addressPrefix": "*" + } + ], + "sourcePortRanges": [ + "0-65535" + ], + "destinationPortRanges": [ + "22" + ], + "direction": "Inbound", + "provisioningState": "Succeeded", + "resourceGuid": "f930553b-f78d-48c5-9445-6cf86b85e615" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberDelete.json new file mode 100644 index 000000000000..9fabfb9a43f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberDelete.json @@ -0,0 +1,15 @@ +{ + "title": "Delete Azure Virtual Network Manager Static Member", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SampleRG", + "networkManagerName": "TestNM", + "networkGroupName": "testNetworkGroup", + "staticMemberName": "testStaticMember" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberGet.json new file mode 100644 index 000000000000..05a82b10c043 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberGet.json @@ -0,0 +1,31 @@ +{ + "title": "Get Azure Virtual Network Manager Static Member", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "staticMemberName": "testStaticMember" + }, + "responses": { + "200": { + "body": { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberList.json new file mode 100644 index 000000000000..751903068bc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberList.json @@ -0,0 +1,37 @@ +{ + "title": "List Azure Virtual Network Manager Static Members", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1", + "region": "useast2", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "{baseurl}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberPut.json new file mode 100644 index 000000000000..49ae851da34b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkManagerStaticMemberPut.json @@ -0,0 +1,64 @@ +{ + "title": "Create/Update Azure Virtual Network Manager Static Member", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "networkGroupName": "testNetworkGroup", + "staticMemberName": "testStaticMember", + "parameters": { + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1", + "region": "useast2", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "headers": { + "ETag": "be3cfaa2-3d02-4624-92d7-a26766306c8b" + }, + "body": { + "name": "testStaticMember", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/networkGroups/testNetworkGroup/staticMembers/testStaticMember", + "type": "Microsoft.Network/networkManagers/networkGroups/staticMembers", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/virtualnetworks/vnet1", + "region": "useast2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileCreateConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileCreateConfigOnly.json new file mode 100644 index 000000000000..ef0f40a12b77 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileCreateConfigOnly.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1", + "parameters": { + "location": "westus", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + }, + "201": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileDelete.json new file mode 100644 index 000000000000..bc4433ea48b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileGetConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileGetConfigOnly.json new file mode 100644 index 000000000000..8b72b3b4cfbf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileGetConfigOnly.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileGetWithContainerNic.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileGetWithContainerNic.json new file mode 100644 index 000000000000..9381eb9e455c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileGetWithContainerNic.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [ + { + "name": "containerGroup1_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup1_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileList.json new file mode 100644 index 000000000000..cfbbe262231e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileList.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileListAll.json new file mode 100644 index 000000000000..705e3e1a5b37 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileListAll.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileUpdateTags.json new file mode 100644 index 000000000000..57833dc03887 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkProfileUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "test-np", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-np", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-np", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupCreate.json new file mode 100644 index 000000000000..b24aef16c8c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupCreate.json @@ -0,0 +1,235 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "flushConnection": false, + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "flushConnection": false, + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupCreateWithRule.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupCreateWithRule.json new file mode 100644 index 000000000000..b8ae22afe42d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupCreateWithRule.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "properties": { + "securityRules": [ + { + "name": "rule1", + "properties": { + "protocol": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "destinationPortRange": "80", + "sourcePortRange": "*", + "priority": 130, + "direction": "Inbound" + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupDelete.json new file mode 100644 index 000000000000..d50e804151d6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + }, + "204": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2022-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupGet.json new file mode 100644 index 000000000000..308564d777cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupGet.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupList.json new file mode 100644 index 000000000000..dd8f8bd4aa4d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupList.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupListAll.json new file mode 100644 index 000000000000..8ecd49c03bc8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupListAll.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleCreate.json new file mode 100644 index 000000000000..ba206f71e448 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "securityRuleParameters": { + "properties": { + "protocol": "*", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "destinationPortRange": "8080", + "sourcePortRange": "*", + "priority": 100, + "direction": "Outbound" + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleDelete.json new file mode 100644 index 000000000000..b9e27653a44b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2022-09-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleGet.json new file mode 100644 index 000000000000..49f85af4d8fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleList.json new file mode 100644 index 000000000000..ec082e266048 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupRuleList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..5d737900129a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityGroupUpdateTags.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterDelete.json new file mode 100644 index 000000000000..f2c30da4d83a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterDelete.json @@ -0,0 +1,18 @@ +{ + "title": "Delete Network Security Perimeter", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "testNSP1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/networkSecurityPerimeterOperationStatuses/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterGet.json new file mode 100644 index 000000000000..16b9da908351 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterGet.json @@ -0,0 +1,32 @@ +{ + "title": "Get Network Security Perimeter", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1" + }, + "responses": { + "200": { + "body": { + "name": "nsp1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterList.json new file mode 100644 index 000000000000..b82f48c3e9c4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterList.json @@ -0,0 +1,55 @@ +{ + "title": "List Network Security Perimeter", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNSP1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP1", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + { + "name": "testNSP2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP2", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterListAll.json new file mode 100644 index 000000000000..fd1d42038077 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterListAll.json @@ -0,0 +1,54 @@ +{ + "title": "List all the Network Security Perimeters in a Subscription", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testNSP1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP1", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + { + "name": "testNSP2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/testNSP2", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/providers/Microsoft.Network/networkSecurityPerimeters?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterPatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterPatch.json new file mode 100644 index 000000000000..5b94db5c1dab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterPatch.json @@ -0,0 +1,39 @@ +{ + "title": "Patch Network Security Perimeter", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "parameters": { + "tags": { + "description": "nsp1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkSecurityPerimeter", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": { + "description": "nsp1" + }, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterPut.json new file mode 100644 index 000000000000..9d17c14d3efb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkSecurityPerimeterPut.json @@ -0,0 +1,57 @@ +{ + "title": "Create/Update Network Security Perimeter", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "parameters": { + "location": "location1", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "TestNetworkSecurityPerimeter", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "201": { + "body": { + "name": "TestNetworkSecurityPerimeter", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/TestNetworkSecurityPerimeter", + "type": "Microsoft.Network/networkSecurityPerimeters", + "tags": {}, + "location": "East US 2 EUAP", + "properties": { + "perimeterGuid": "guid", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceBootDiagnostics.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceBootDiagnostics.json new file mode 100644 index 000000000000..08c81b946c42 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceBootDiagnostics.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "request": { + "instanceId": 0, + "serialConsoleStorageSasUrl": "https://blobcortextesturl.blob.core.windows.net/nvaBootDiagContainer/serialLogs.txt?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b", + "consoleScreenshotStorageSasUrl": "https://blobcortextesturl.blob.core.windows.net/nvaBootDiagContainer/consoleScreenshot.png?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "instanceId": 0 + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionDelete.json new file mode 100644 index 000000000000..d6620c90792d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "connection1", + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionGet.json new file mode 100644 index 000000000000..3cd96fd82780 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "connectionName": "connection1", + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/NetworkVirtualAppliances/nva1/NetworkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "tunnelIdentifier": 0, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionList.json new file mode 100644 index 000000000000..5ada58fa851e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/NetworkVirtualAppliances/nva1/NetworkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionPut.json new file mode 100644 index 000000000000..aacf8ee55869 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceConnectionPut.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "connectionName": "connection1", + "networkVirtualApplianceName": "nva1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "NetworkVirtualApplianceConnectionParameters": { + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "enableInternetSecurity": false, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva1/networkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva1/networkVirtualApplianceConnections/connection1", + "properties": { + "name": "connection1", + "asn": 64512, + "tunnelIdentifier": 0, + "bgpPeerAddress": [ + "169.254.16.13", + "169.254.16.14" + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceDelete.json new file mode 100644 index 000000000000..cf5fc0ed8068 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceEmptyRestart.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceEmptyRestart.json new file mode 100644 index 000000000000..d05290df83f5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceEmptyRestart.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" + }, + "body": { + "instanceIds": [] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceGet.json new file mode 100644 index 000000000000..2a3c2f43b866 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceGet.json @@ -0,0 +1,188 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "virtualApplianceConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/networkVirtualApplianceConnections/connection1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "192.168.12.5", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.6", + "instanceName": "nva_1" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.7", + "instanceName": "nva_1" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.8", + "instanceName": "nva_1" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.9", + "instanceName": "nva_1" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "192.168.12.10", + "instanceName": "nva_1" + } + ], + "privateIpAddress": "192.168.12.11" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceListByResourceGroup.json new file mode 100644 index 000000000000..2f9737e65cb0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceListByResourceGroup.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceListBySubscription.json new file mode 100644 index 000000000000..4cfc46cdf286 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceListBySubscription.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualAppliancePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualAppliancePut.json new file mode 100644 index 000000000000..7e63c53b68eb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualAppliancePut.json @@ -0,0 +1,332 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "publicnicipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "publicnicipconfig-2", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "privatenicipconfig-2", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "AdditionalNic", + "name": "exrsdwan", + "publicIpAddress": "4.231.25.19", + "privateIpAddress": "10.1.113.4", + "instanceName": "nva_0" + } + ] + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "additionalNics": [ + { + "name": "exrsdwan", + "hasPublicIp": true + } + ], + "internetIngressPublicIps": [ + { + "id": "/subscriptions/{{subscriptionId}}/resourceGroups/{{rg}}/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "publicnicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "publicnicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "privatenicipconfig", + "properties": { + "primary": true + } + }, + { + "name": "privatenicipconfig-2", + "properties": { + "primary": false + } + } + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSaaSPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSaaSPut.json new file mode 100644 index 000000000000..d5cb3484ec39 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSaaSPut.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "delegation": { + "serviceName": "PaloAltoNetworks.Cloudngfw/firewalls" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "delegation": { + "serviceName": "PaloAltoNetworks.Cloudngfw/firewalls", + "provisioningState": "Succeeded" + }, + "deploymentType": "PartnerManaged", + "partnerManagedResource": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Lifter/firewalls/paloAltoFirewall", + "internalLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustILB", + "standardLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustSLB" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "delegation": { + "serviceName": "PaloAltoNetworks.Cloudngfw/firewalls", + "provisioningState": "Succeeded" + }, + "deploymentType": "PartnerManaged", + "partnerManagedResource": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Lifter/firewalls/paloAltoFirewall", + "internalLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustILB", + "standardLoadBalancerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/trustSLB" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteDelete.json new file mode 100644 index 000000000000..1ef999a3ea51 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteDelete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteGet.json new file mode 100644 index 000000000000..6705064913aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteList.json new file mode 100644 index 000000000000..7ca4b68866fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSiteList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSitePut.json new file mode 100644 index 000000000000..82fbcf62c995 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSitePut.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "properties": { + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + }, + "201": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSkuGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSkuGet.json new file mode 100644 index 000000000000..9760b39cf6c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSkuGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "skuName": "ciscoSdwan" + }, + "responses": { + "200": { + "body": { + "name": "ciscoSdwan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualApplianceSkus/ciscoSdwan", + "type": "Microsoft.Network/networkVirtualApplianceSkus", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "vendor": "Cisco", + "availableVersions": [ + "11.12" + ], + "availableScaleUnits": [ + { + "scaleUnit": "1", + "instanceCount": 2 + }, + { + "scaleUnit": "2", + "instanceCount": 2 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSkuList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSkuList.json new file mode 100644 index 000000000000..9141c3d09698 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSkuList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ciscoSdwan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualApplianceSkus/ciscoSdwan", + "type": "Microsoft.Network/networkVirtualApplianceSkus", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "vendor": "Cisco", + "availableVersions": [ + "11.12" + ], + "availableScaleUnits": [ + { + "scaleUnit": "1", + "instanceCount": 2 + }, + { + "scaleUnit": "2", + "instanceCount": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSpecificReimage.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSpecificReimage.json new file mode 100644 index 000000000000..e9f2a4494f1b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSpecificReimage.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "instanceIds": [ + "0" + ] + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "instanceIds": [ + "0" + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSpecificRestart.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSpecificRestart.json new file mode 100644 index 000000000000..5ce62493cb35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceSpecificRestart.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "instanceIds": [ + "0", + "1" + ] + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01" + }, + "body": { + "instanceIds": [ + "0", + "1" + ] + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceUpdateTags.json new file mode 100644 index 000000000000..690b54511d00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceUpdateTags.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "addressPrefix": "192.168.1.0/16", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetAdditionalPrivatePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetAdditionalPrivatePut.json new file mode 100644 index 000000000000..e9485f976403 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetAdditionalPrivatePut.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet3" + }, + "type": [ + "AdditionalPrivateNic" + ], + "name": "myAdditionalInterface" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "addressPrefix": "192.168.1.0/16", + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet3" + }, + "type": [ + "AdditionalPrivateNic" + ], + "name": "myAdditionalInterface" + } + ], + "virtualApplianceNics": [ + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_1" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_1" + }, + { + "nicType": "", + "name": "myAdditionalInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.5", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "myAdditionalInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.6", + "instanceName": "nva_1" + } + ], + "privateIpAddress": "192.168.12.7" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet3" + }, + "type": [ + "AdditionalPrivateNic" + ], + "name": "myAdditionalInterface" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetAdditionalPublicPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetAdditionalPublicPut.json new file mode 100644 index 000000000000..9d2dc463fa21 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetAdditionalPublicPut.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet3" + }, + "type": [ + "AdditionalPublicNic" + ], + "name": "myAdditionalPublicInterface" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "addressPrefix": "192.168.1.0/16", + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet3" + }, + "type": [ + "AdditionalPublicNic" + ], + "name": "myAdditionalPublicInterface" + } + ], + "virtualApplianceNics": [ + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_1" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_1" + }, + { + "nicType": "", + "name": "myAdditionalPublicInterface-ipconfig", + "publicIpAddress": "40.30.2.4", + "privateIpAddress": "192.168.12.5", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "myAdditionalPublicInterface-ipconfig", + "publicIpAddress": "40.30.2.5", + "privateIpAddress": "192.168.12.6", + "instanceName": "nva_1" + } + ], + "privateIpAddress": "192.168.12.7" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet3" + }, + "type": [ + "AdditionalPublicNic" + ], + "name": "myAdditionalPublicInterface" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetBasicPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetBasicPut.json new file mode 100644 index 000000000000..400adfd7c2ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetBasicPut.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "addressPrefix": "192.168.1.0/16", + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ], + "virtualApplianceNics": [ + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_1" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_1" + } + ], + "privateIpAddress": "192.168.12.5" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetIngressPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetIngressPut.json new file mode 100644 index 000000000000..9764dc8cbdc3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetIngressPut.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "internetIngressPublicIps": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "addressPrefix": "192.168.1.0/16", + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "internetIngressPublicIps": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ], + "virtualApplianceNics": [ + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "managementInterface-ipconfig", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_1" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "", + "name": "dataInterface-ipconfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_1" + } + ], + "privateIpAddress": "192.168.12.5" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "internetIngressPublicIps": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/slbip" + } + ], + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetNetworkProfilePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetNetworkProfilePut.json new file mode 100644 index 000000000000..48fbd77ad492 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkVirtualApplianceVnetNetworkProfilePut.json @@ -0,0 +1,361 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "myPrimaryPublicIpConfig", + "properties": { + "primary": true + } + }, + { + "name": "myNonPrimaryPublicIpConfig", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "myPrimaryPrivateIpConfig", + "properties": { + "primary": true + } + }, + { + "name": "myNonPrimaryPrivateIpConfig", + "properties": { + "primary": false + } + } + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "addressPrefix": "192.168.1.0/16", + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "myPrimaryPublicIpConfig", + "properties": { + "primary": true + } + }, + { + "name": "myNonPrimaryPublicIpConfig", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "myPrimaryPrivateIpConfig", + "properties": { + "primary": true + } + }, + { + "name": "myNonPrimaryPrivateIpConfig", + "properties": { + "primary": false + } + } + ] + } + } + ] + }, + "virtualApplianceNics": [ + { + "nicType": "PublicNic", + "name": "myPrimaryPublicIpConfig", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "myNonPrimaryPublicIpConfig", + "publicIpAddress": "40.30.2.3", + "privateIpAddress": "192.168.12.2", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "myPrimaryPrivateIpConfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.3", + "instanceName": "nva_0" + }, + { + "nicType": "PrivateNic", + "name": "myNonPrimaryPrivateIpConfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.4", + "instanceName": "nva_0" + }, + { + "nicType": "PublicNic", + "name": "myPrimaryPublicIpConfig", + "publicIpAddress": "40.30.2.4", + "privateIpAddress": "192.168.12.5", + "instanceName": "nva_1" + }, + { + "nicType": "PublicNic", + "name": "myNonPrimaryPublicIpConfig", + "publicIpAddress": "40.30.2.5", + "privateIpAddress": "192.168.12.6", + "instanceName": "nva_1" + }, + { + "nicType": "PrivateNic", + "name": "myPrimaryPrivateIpConfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.7", + "instanceName": "nva_1" + }, + { + "nicType": "PrivateNic", + "name": "myNonPrimaryPrivateIpConfig", + "publicIpAddress": "", + "privateIpAddress": "192.168.12.8", + "instanceName": "nva_1" + } + ], + "privateIpAddress": "192.168.12.9" + } + } + }, + "201": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + }, + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "latest" + }, + "inboundSecurityRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/InboundSecurityRules/rule1" + } + ], + "provisioningState": "Updating", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "nvaInterfaceConfigurations": [ + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "type": [ + "PrivateNic" + ], + "name": "dataInterface" + }, + { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet2" + }, + "type": [ + "PublicNic" + ], + "name": "managementInterface" + } + ], + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "type": "PublicNic", + "properties": { + "ipConfigurations": [ + { + "name": "myPrimaryPublicIpConfig", + "properties": { + "primary": true + } + }, + { + "name": "myNonPrimaryPublicIpConfig", + "properties": { + "primary": false + } + } + ] + } + }, + { + "type": "PrivateNic", + "properties": { + "ipConfigurations": [ + { + "name": "myPrimaryPrivateIpConfig", + "properties": { + "primary": true + } + }, + { + "name": "myNonPrimaryPrivateIpConfig", + "properties": { + "primary": false + } + } + ] + } + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherAvailableProvidersListGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherAvailableProvidersListGet.json new file mode 100644 index 000000000000..626b93cbb074 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherAvailableProvidersListGet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "azureLocations": [ + "West US" + ], + "country": "United States", + "state": "washington", + "city": "seattle" + } + }, + "responses": { + "200": { + "body": { + "countries": [ + { + "countryName": "United States", + "states": [ + { + "stateName": "washington", + "cities": [ + { + "cityName": "seattle", + "providers": [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/availableProvidersList?api-version=2025-03-01" + }, + "body": { + "countries": [ + { + "countryName": "United States", + "states": [ + { + "stateName": "washington", + "cities": [ + { + "cityName": "seattle", + "providers": [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherAzureReachabilityReportGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherAzureReachabilityReportGet.json new file mode 100644 index 000000000000..3578cee87a47 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherAzureReachabilityReportGet.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "providers": [ + "Frontier Communications of America, Inc. - ASN 5650" + ], + "azureLocations": [ + "West US" + ], + "startTime": "2017-09-07T00:00:00Z", + "endTime": "2017-09-10T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "aggregationLevel": "State", + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "reachabilityReport": [ + { + "provider": "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/azureReachabilityReport?api-version=2025-03-01" + }, + "body": { + "aggregationLevel": "State", + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "reachabilityReport": [ + { + "provider": "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorCreate.json new file mode 100644 index 000000000000..bb4bc847b426 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorCreate.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "parameters": { + "location": "eastus", + "properties": { + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "provisioningState": "Updating", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json new file mode 100644 index 000000000000..64ff2aacfac6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "location": "centraluseuap", + "parameters": { + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/9cece3e3-0f7d-47ca-af0e-9772773f90b7/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/TESTVM", + "type": "AzureVM" + }, + { + "name": "bing", + "address": "bing.com", + "type": "ExternalAddress" + }, + { + "name": "google", + "address": "google.com", + "type": "ExternalAddress" + }, + { + "name": "ArcBasedNetwork", + "type": "AzureArcNetwork", + "subscriptionId": "9cece3e3-0f7d-47ca-af0e-9772773f90b7", + "locationDetails": { + "region": "eastus" + }, + "scope": { + "include": [ + { + "address": "172.21.128.0/20" + } + ] + } + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "ArcBasedNetwork" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/9cece3e3-0f7d-47ca-af0e-9772773f90b7/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/TESTVM" + }, + { + "name": "ArcBasedNetwork", + "type": "AzureArcNetwork", + "subscriptionId": "9cece3e3-0f7d-47ca-af0e-9772773f90b7", + "locationDetails": { + "region": "eastus" + }, + "scope": { + "include": [ + { + "address": "172.21.128.0/20" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "ArcBasedNetwork" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/9cece3e3-0f7d-47ca-af0e-9772773f90b7/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/TESTVM" + }, + { + "name": "ArcBasedNetwork", + "type": "AzureArcNetwork", + "subscriptionId": "9cece3e3-0f7d-47ca-af0e-9772773f90b7", + "locationDetails": { + "region": "eastus" + }, + "scope": { + "include": [ + { + "address": "172.21.128.0/20" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "ArcBasedNetwork" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorDelete.json new file mode 100644 index 000000000000..0e5419e125d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorGet.json new file mode 100644 index 000000000000..89cb8a929b9d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorList.json new file mode 100644 index 000000000000..fa1c79b3f20c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorList.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct1" + }, + { + "name": "destination", + "address": "bing.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + }, + { + "name": "cm2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "endpoints": [ + { + "name": "source", + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/ct2" + }, + { + "name": "destination", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "tcp", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80 + } + } + ], + "testGroups": [ + { + "name": "tg", + "testConfigurations": [ + "tcp" + ], + "sources": [ + "source" + ], + "destinations": [ + "destination" + ] + } + ] + }, + "location": "eastus", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorStop.json new file mode 100644 index 000000000000..eaa8fc0dad68 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json new file mode 100644 index 000000000000..def919214df4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/`/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2019-09-04T02:48:10.6797393Z", + "monitoringStatus": "Running" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/networkWatchers/connectionMonitors", + "location": "westcentralus" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorV2Create.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorV2Create.json new file mode 100644 index 000000000000..357da3104505 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectionMonitorV2Create.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "location": "centraluseuap", + "parameters": { + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectivityCheck.json new file mode 100644 index 000000000000..2bdb4e8232bc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherConnectivityCheck.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination": { + "address": "192.168.100.4", + "port": 3389 + }, + "preferredIPVersion": "IPv4" + } + }, + "responses": { + "200": { + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectivityCheck?api-version=2025-03-01" + }, + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherCreate.json new file mode 100644 index 000000000000..479eb10de0e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherDelete.json new file mode 100644 index 000000000000..306b56aa3f8f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogConfigure.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogConfigure.json new file mode 100644 index 000000000000..60d62ff2a047 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogConfigure.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/configureFlowLog?api-version=2025-03-01" + }, + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogCreate.json new file mode 100644 index 000000000000..a577aa2c420c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogCreate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "fl", + "parameters": { + "location": "centraluseuap", + "properties": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "format": { + "type": "JSON", + "version": 1 + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + }, + "location": "centraluseuap" + } + }, + "201": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + }, + "location": "centraluseuap" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogDelete.json new file mode 100644 index 000000000000..4553b338edfa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "fl" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogGet.json new file mode 100644 index 000000000000..9174806fae3a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "flowLog1" + }, + "responses": { + "200": { + "body": { + "name": "flowLog1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "flowAnalyticsConfiguration": { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "-", + "workspaceRegion": "-", + "trafficAnalyticsInterval": 60 + } + }, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogList.json new file mode 100644 index 000000000000..1c057a1c59f1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogList.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "flowLog1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "flowAnalyticsConfiguration": { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "-", + "workspaceRegion": "-", + "trafficAnalyticsInterval": 60 + } + }, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + }, + { + "name": "flowLog2", + "id": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_centraluseuap/FlowLogs/flowLog2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/DSCP-test-vm1-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/iraflowlogtest2diag", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centraluseuap", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogStatusQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogStatusQuery.json new file mode 100644 index 000000000000..ea2aa89a48b9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogStatusQuery.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryFlowLogStatus?api-version=2025-03-01" + }, + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogUpdateTags.json new file mode 100644 index 000000000000..11e6deaed0bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherFlowLogUpdateTags.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw", + "flowLogName": "fl", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabledFilteringCriteria": "srcIP=158.255.7.8 || dstPort=56891", + "recordTypes": "B,E", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centralus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": { + "clientId": "c16d15e1-f60a-40e4-8a05-df3d3f655c14", + "principalId": "e3858881-e40c-43bd-9cde-88da39c05023" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherGet.json new file mode 100644 index 000000000000..0c855de36a50 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherIpFlowVerify.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherIpFlowVerify.json new file mode 100644 index 000000000000..73dda91c3cb6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherIpFlowVerify.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "direction": "Outbound", + "protocol": "TCP", + "localPort": "80", + "remotePort": "80", + "localIPAddress": "10.2.0.4", + "remoteIPAddress": "121.10.1.1" + } + }, + "responses": { + "200": { + "body": { + "access": "Allow", + "ruleName": "Rule1" + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/ipFlowVerify?api-version=2025-03-01" + }, + "body": { + "access": "Allow", + "ruleName": "Rule1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherList.json new file mode 100644 index 000000000000..289c040558bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherListAll.json new file mode 100644 index 000000000000..44e5e6ea061c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json new file mode 100644 index 000000000000..d44ef9d2aa93 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "profiles": [ + { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + } + ] + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/networkConfigurationDiagnostic?api-version=2025-03-01" + }, + "body": { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherNextHopGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherNextHopGet.json new file mode 100644 index 000000000000..9d85c505da55 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherNextHopGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "sourceIPAddress": "10.0.0.5", + "destinationIPAddress": "10.0.0.10", + "targetNicResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "responses": { + "200": { + "body": { + "nextHopType": "VnetLocal", + "nextHopIpAddress": "10.0.0.1", + "routeTableId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/nextHop?api-version=2025-03-01" + }, + "body": { + "nextHopType": "VnetLocal", + "nextHopIpAddress": "10.0.0.1", + "routeTableId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureCreate.json new file mode 100644 index 000000000000..eeacee8c4cd2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1", + "parameters": { + "properties": { + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureDelete.json new file mode 100644 index 000000000000..25dafd4e0a7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureGet.json new file mode 100644 index 000000000000..017284ac3936 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureQueryStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureQueryStatus.json new file mode 100644 index 000000000000..4a3b33f18daf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureQueryStatus.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime": "2016-09-07T12:35:24Z", + "packetCaptureStatus": "Stopped", + "stopReason": "TimeExceeded", + "packetCaptureError": [] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/troubleshoot?api-version=2025-03-01" + }, + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime": "2016-09-07T12:35:24Z", + "packetCaptureStatus": "Stopped", + "stopReason": "TimeExceeded", + "packetCaptureError": [] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureStop.json new file mode 100644 index 000000000000..cd0b14b54684 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCaptureStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/operationresults/000000000000000000000==?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCapturesList.json new file mode 100644 index 000000000000..152625eafdac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherPacketCapturesList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + }, + { + "name": "pc2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", + "filePath": "D:\\capture\\pc2.cap" + }, + "filters": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherSecurityGroupViewGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherSecurityGroupViewGet.json new file mode 100644 index 000000000000..a15d173467ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherSecurityGroupViewGet.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses": { + "200": { + "body": { + "networkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations": { + "subnetAssociation": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules": [ + { + "name": "fe_rule", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow Frontend", + "protocol": "Tcp", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "10.1.0.0/24", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 100, + "direction": "Inbound" + } + } + ] + }, + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + } + ], + "effectiveSecurityRules": [ + { + "name": "DefaultOutboundDenyAll", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + ] + } + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryStatus?api-version=2025-03-01" + }, + "body": { + "networkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations": { + "subnetAssociation": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules": [ + { + "name": "fe_rule", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow Frontend", + "protocol": "Tcp", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "10.1.0.0/24", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 100, + "direction": "Inbound" + } + } + ] + }, + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + } + ], + "effectiveSecurityRules": [ + { + "name": "DefaultOutboundDenyAll", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTopologyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTopologyGet.json new file mode 100644 index 000000000000..cd12e1dabd55 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTopologyGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceGroupName": "rg2" + } + }, + "responses": { + "200": { + "body": { + "id": "ce592f46-8164-4bf2-ad36-b8e4acf6fb68", + "createdDateTime": "2017-08-02T19:31:55.9461781Z", + "lastModified": "2017-05-27T00:00:13.2005337Z", + "resources": [ + { + "name": "MultiTierApp0", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/MultiTierApp0", + "location": "westus", + "associations": [ + { + "name": "appNic0", + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic0", + "associationType": "Contains" + }, + { + "name": "appNic10", + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic10", + "associationType": "Contains" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTroubleshootGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTroubleshootGet.json new file mode 100644 index 000000000000..1fe1babc4518 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTroubleshootGet.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "storagePath": "https://st1.blob.core.windows.net/cn1" + } + } + }, + "responses": { + "200": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/troubleshoot?api-version=2025-03-01" + }, + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTroubleshootResultQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTroubleshootResultQuery.json new file mode 100644 index 000000000000..b671e6942810 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherTroubleshootResultQuery.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses": { + "200": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202": { + "headers": { + "Location": "https:/management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/queryTroubleshootResult?api-version=2025-03-01" + }, + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherUpdateTags.json new file mode 100644 index 000000000000..eefcc937aa2e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NetworkWatcherUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleDelete.json new file mode 100644 index 000000000000..3ccc272700b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleDelete.json @@ -0,0 +1,15 @@ +{ + "title": "Delete NSP access rule", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1", + "accessRuleName": "accessRule1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleGet.json new file mode 100644 index 000000000000..a5ce8c5d2e42 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleGet.json @@ -0,0 +1,42 @@ +{ + "title": "Get NSP Access Rule", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1", + "accessRuleName": "accessRule1" + }, + "responses": { + "200": { + "body": { + "name": "accessRule1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules", + "properties": { + "provisioningState": "Succeeded", + "direction": "Outbound", + "addressPrefixes": [], + "fullyQualifiedDomainNames": [ + "paasrp1.contoso.org", + "paasrp2.contoso.org" + ], + "subscriptions": [], + "networkSecurityPerimeters": [], + "emailAddresses": [], + "phoneNumbers": [], + "serviceTags": [] + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleList.json new file mode 100644 index 000000000000..8b2cf7bced1a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleList.json @@ -0,0 +1,73 @@ +{ + "title": "List NSP Access Rules", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "accessRule1", + "id": "/subscriptions/rg1/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules", + "properties": { + "provisioningState": "Succeeded", + "direction": "Inbound", + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "fullyQualifiedDomainNames": [], + "subscriptions": [], + "networkSecurityPerimeters": [], + "emailAddresses": [], + "phoneNumbers": [], + "serviceTags": [] + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + { + "name": "accessRule2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule2", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules", + "properties": { + "provisioningState": "Succeeded", + "direction": "Outbound", + "addressPrefixes": [], + "fullyQualifiedDomainNames": [ + "paasrp1.contoso.org", + "paasrp2.contoso.org" + ], + "subscriptions": [], + "networkSecurityPerimeters": [], + "emailAddresses": [], + "phoneNumbers": [], + "serviceTags": [] + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRulePut.json new file mode 100644 index 000000000000..fb9e63dd4123 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRulePut.json @@ -0,0 +1,80 @@ +{ + "title": "Create/Update NSP access rule", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1", + "accessRuleName": "accessRule1", + "parameters": { + "properties": { + "direction": "Inbound", + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "accessRule1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules", + "properties": { + "provisioningState": "Succeeded", + "direction": "Inbound", + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "fullyQualifiedDomainNames": [], + "subscriptions": [], + "networkSecurityPerimeters": [], + "emailAddresses": [], + "phoneNumbers": [], + "serviceTags": [] + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "201": { + "body": { + "name": "accessRule1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1/accessRules/accessRule1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles/accessRules", + "properties": { + "provisioningState": "Succeeded", + "direction": "Inbound", + "addressPrefixes": [ + "10.11.0.0/16", + "10.10.1.0/24" + ], + "fullyQualifiedDomainNames": [], + "subscriptions": [], + "networkSecurityPerimeters": [], + "emailAddresses": [], + "phoneNumbers": [], + "serviceTags": [] + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleReconcile.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleReconcile.json new file mode 100644 index 000000000000..93dba27b094e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAccessRuleReconcile.json @@ -0,0 +1,19 @@ +{ + "title": "Reconcile NSP access rule", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1", + "accessRuleName": "accessRuleName1", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationDelete.json new file mode 100644 index 000000000000..3ed73e674118 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationDelete.json @@ -0,0 +1,20 @@ +{ + "title": "Delete NSP resource association", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "associationName": "association1", + "operationId": "operationId1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/networkSecurityPerimeterOperationStatuses/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationGet.json new file mode 100644 index 000000000000..bf01c18f1efe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationGet.json @@ -0,0 +1,38 @@ +{ + "title": "Get NSP resource association", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "associationName": "association1" + }, + "responses": { + "200": { + "body": { + "name": "association1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association1", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Enforced", + "hasProvisioningIssues": "no" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationList.json new file mode 100644 index 000000000000..b43bba4f1baf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationList.json @@ -0,0 +1,90 @@ +{ + "title": "List NSP resource associations", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "association1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association1", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Enforced", + "hasProvisioningIssues": "no" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + { + "name": "association2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association2", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Audit", + "hasProvisioningIssues": "no" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + { + "name": "association3", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association3", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Failed", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Learning", + "hasProvisioningIssues": "yes" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationPut.json new file mode 100644 index 000000000000..25cb7cd8bc2f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationPut.json @@ -0,0 +1,104 @@ +{ + "title": "Create/Update NSP association", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "associationName": "association1", + "parameters": { + "properties": { + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Enforced" + } + } + }, + "responses": { + "200": { + "body": { + "name": "association1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association1", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Enforced", + "hasProvisioningIssues": "no" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "201": { + "body": { + "name": "association1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association1", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Succeeded", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Enforced", + "hasProvisioningIssues": "no" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "202": { + "body": { + "name": "association1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association1", + "type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations", + "properties": { + "provisioningState": "Creating", + "privateLinkResource": { + "id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}" + }, + "profile": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}" + }, + "accessMode": "Learning", + "hasProvisioningIssues": "no" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/networkSecurityPerimeterOperationStatuses/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationReconcile.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationReconcile.json new file mode 100644 index 000000000000..8c146e52c23f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspAssociationReconcile.json @@ -0,0 +1,18 @@ +{ + "title": "Reconcile NSP association", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "associationName": "association1", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkDelete.json new file mode 100644 index 000000000000..5bd36f5e9330 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkDelete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete NSP link", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "linkName": "link1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/links/{linkName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkGet.json new file mode 100644 index 000000000000..abfdcd141340 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkGet.json @@ -0,0 +1,47 @@ +{ + "title": "Get NSP Link", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "linkName": "link1" + }, + "responses": { + "200": { + "body": { + "name": "link1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1", + "type": "Microsoft.Network/networkSecurityPerimeters/links", + "properties": { + "provisioningState": "Succeeded", + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "remotePerimeterGuid": "guid", + "remotePerimeterLocation": "westus2", + "localInboundProfiles": [ + "*" + ], + "localOutboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ], + "remoteOutboundProfiles": [ + "*" + ], + "description": "Auto Approved", + "status": "Approved" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkList.json new file mode 100644 index 000000000000..f9e9a47b78d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkList.json @@ -0,0 +1,51 @@ +{ + "title": "List NSP Links", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1", + "type": "Microsoft.Network/networkSecurityPerimeters/links", + "properties": { + "provisioningState": "Succeeded", + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "remotePerimeterGuid": "guid", + "remotePerimeterLocation": "westus2", + "localInboundProfiles": [ + "*" + ], + "localOutboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ], + "remoteOutboundProfiles": [ + "*" + ], + "description": "Auto Approved", + "status": "Approved" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkPut.json new file mode 100644 index 000000000000..41963c2fde1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkPut.json @@ -0,0 +1,93 @@ +{ + "title": "Create/Update NSP link", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "linkName": "link1", + "parameters": { + "properties": { + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "localInboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "link1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1", + "type": "Microsoft.Network/networkSecurityPerimeters/links", + "properties": { + "provisioningState": "Succeeded", + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "remotePerimeterGuid": "guid", + "remotePerimeterLocation": "westus2", + "localInboundProfiles": [ + "*" + ], + "localOutboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ], + "remoteOutboundProfiles": [ + "*" + ], + "description": "Auto Approved", + "status": "Approved" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "201": { + "body": { + "name": "link1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/links/link1", + "type": "Microsoft.Network/networkSecurityPerimeters/links", + "properties": { + "provisioningState": "Succeeded", + "autoApprovedRemotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2", + "remotePerimeterGuid": "guid", + "remotePerimeterLocation": "westus2", + "localInboundProfiles": [ + "*" + ], + "localOutboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ], + "remoteOutboundProfiles": [ + "*" + ], + "description": "Auto Approved", + "status": "Approved" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceDelete.json new file mode 100644 index 000000000000..5e79642cac3b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceDelete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete NSP linkReference", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp2", + "linkReferenceName": "link1-guid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkreferences/{linkReferenceName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceGet.json new file mode 100644 index 000000000000..7d51edc63035 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceGet.json @@ -0,0 +1,47 @@ +{ + "title": "Get NSP LinkReference", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp2", + "linkReferenceName": "link1-guid" + }, + "responses": { + "200": { + "body": { + "name": "link1-guid", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2/linkreferences/link1-guid", + "type": "Microsoft.Network/networkSecurityPerimeters/linkreferences", + "properties": { + "provisioningState": "Succeeded", + "remotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1", + "remotePerimeterGuid": "guid", + "remotePerimeterLocation": "westus2", + "localInboundProfiles": [ + "*" + ], + "localOutboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ], + "remoteOutboundProfiles": [ + "*" + ], + "description": "Auto Approved", + "status": "Approved" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceList.json new file mode 100644 index 000000000000..fe1ea4c1fd45 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLinkReferenceList.json @@ -0,0 +1,51 @@ +{ + "title": "List NSP LinkReferences", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1-guid", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2/linkreferences/link1-guid", + "type": "Microsoft.Network/networkSecurityPerimeters/linkreferences", + "properties": { + "provisioningState": "Succeeded", + "remotePerimeterResourceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1", + "remotePerimeterGuid": "guid", + "remotePerimeterLocation": "westus2", + "localInboundProfiles": [ + "*" + ], + "localOutboundProfiles": [ + "*" + ], + "remoteInboundProfiles": [ + "*" + ], + "remoteOutboundProfiles": [ + "*" + ], + "description": "Auto Approved", + "status": "Approved" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp2/linkreferences?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationDelete.json new file mode 100644 index 000000000000..4034b5080e5e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationDelete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete NSP logging configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "loggingConfigurationName": "instance" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationGet.json new file mode 100644 index 000000000000..fb36665806ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationGet.json @@ -0,0 +1,34 @@ +{ + "title": "Get NSP Logging Configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "loggingConfigurationName": "instance" + }, + "responses": { + "200": { + "body": { + "name": "instance", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/loggingConfigurations/instance", + "type": "Microsoft.Network/networkSecurityPerimeters/loggingConfigurations", + "properties": { + "enabledLogCategories": [ + "NspPublicInboundPerimeterRulesDenied", + "NspPublicOutboundPerimeterRulesDenied" + ], + "version": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationList.json new file mode 100644 index 000000000000..b06cfa61f5e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationList.json @@ -0,0 +1,38 @@ +{ + "title": "List NSP logging configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "instance", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/loggingConfigurations/instance", + "type": "Microsoft.Network/networkSecurityPerimeters/loggingConfigurations", + "properties": { + "enabledLogCategories": [ + "NspPublicInboundPerimeterRulesDenied", + "NspPublicOutboundPerimeterRulesDenied" + ], + "version": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/loggingConfigurations?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationPut.json new file mode 100644 index 000000000000..eda391934c42 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspLoggingConfigurationPut.json @@ -0,0 +1,64 @@ +{ + "title": "Create/Update NSP logging configuration", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "loggingConfigurationName": "instance", + "parameters": { + "properties": { + "enabledLogCategories": [ + "NspPublicInboundPerimeterRulesDenied", + "NspPublicOutboundPerimeterRulesDenied" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "instance", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/loggingConfigurations/instance", + "type": "Microsoft.Network/networkSecurityPerimeters/loggingConfigurations", + "properties": { + "enabledLogCategories": [ + "NspPublicInboundPerimeterRulesDenied", + "NspPublicOutboundPerimeterRulesDenied" + ], + "version": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "201": { + "body": { + "name": "instance", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/loggingConfigurations/instance", + "type": "Microsoft.Network/networkSecurityPerimeters/loggingConfigurations", + "properties": { + "enabledLogCategories": [ + "NspPublicInboundPerimeterRulesDenied", + "NspPublicOutboundPerimeterRulesDenied" + ], + "version": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspOperationStatusGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspOperationStatusGet.json new file mode 100644 index 000000000000..5009f98a7f85 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspOperationStatusGet.json @@ -0,0 +1,20 @@ +{ + "title": "Get Nsp Operation Status", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "location": "location1", + "operationId": "operationId1" + }, + "responses": { + "200": { + "body": { + "name": "operationId1", + "id": "/subscriptions/subId/providers/Microsoft.Network/locations/location1/networkSecurityPerimeterOperationStatuses/operationId1", + "status": "Succeeded", + "startTime": "2025-01-09T10:46:51.0988675Z", + "endTime": "2025-01-09T10:46:55.0948652Z" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileDelete.json new file mode 100644 index 000000000000..3e9042556dcd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileDelete.json @@ -0,0 +1,14 @@ +{ + "title": "Delete NSP profile", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileGet.json new file mode 100644 index 000000000000..ae80f2e18f91 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileGet.json @@ -0,0 +1,31 @@ +{ + "title": "Get NSP Profile", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "name": "nsp1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles", + "properties": { + "accessRulesVersion": "0", + "diagnosticSettingsVersion": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileList.json new file mode 100644 index 000000000000..01f8440b50cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfileList.json @@ -0,0 +1,52 @@ +{ + "title": "List NSP Profiles", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles", + "properties": { + "accessRulesVersion": "0", + "diagnosticSettingsVersion": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile2", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles", + "properties": { + "accessRulesVersion": "0", + "diagnosticSettingsVersion": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + ], + "nextLink": "{baseurl}/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfilePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfilePut.json new file mode 100644 index 000000000000..c49969a92158 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspProfilePut.json @@ -0,0 +1,53 @@ +{ + "title": "Create/Update NSP profile", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "networkSecurityPerimeterName": "nsp1", + "profileName": "profile1", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles", + "properties": { + "accessRulesVersion": "0", + "diagnosticSettingsVersion": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + }, + "201": { + "body": { + "name": "profile1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/profile1", + "type": "Microsoft.Network/networkSecurityPerimeters/profiles", + "properties": { + "accessRulesVersion": "0", + "diagnosticSettingsVersion": "0" + }, + "systemData": { + "createdBy": "user", + "createdByType": "User", + "createdAt": "2024-02-07T18:07:36.3446713Z", + "lastModifiedBy": "user", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-07T18:07:36.3446713Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspServiceTagsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspServiceTagsList.json new file mode 100644 index 000000000000..7c4da7512bb3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/NspServiceTagsList.json @@ -0,0 +1,28 @@ +{ + "title": "List of service tags supported by NSP.", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "serviceTags": [ + "ActionGroup", + "AppConfigurationInternal", + "AzureCloud", + "PRIVATE", + "ApiManagement", + "MicrosoftPublicIPSpace", + "MicrosoftPrivateIPSpace" + ] + } + ], + "nextLink": "{baseurl}/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/nspServiceTags?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/OperationList.json new file mode 100644 index 000000000000..954a6942d1ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/OperationList.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayDelete.json new file mode 100644 index 000000000000..af64e53ca407 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..b80098c27245 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGenerateVpnProfile.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "p2sVpnGateway1", + "parameters": { + "authenticationMethod": "EAPTLS" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "profileUrl": "aaaaaaaaaaaaaaaaaaaaaaaaaaa" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGet.json new file mode 100644 index 000000000000..7a12fdf6f72d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGet.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGetConnectionHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGetConnectionHealth.json new file mode 100644 index 000000000000..80fcf24b3d6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGetConnectionHealth.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json new file mode 100644 index 000000000000..e3d1ccbed2ab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "p2s-vpn-gateway-test", + "gatewayName": "p2svpngateway", + "api-version": "2025-03-01", + "request": { + "vpnUserNamesFilter": [ + "vpnUser1", + "vpnUser2" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/p2sconnectionhealths?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "body": { + "sasUrl": "aaaaaaaaaaaaaaaaaa" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayList.json new file mode 100644 index 000000000000..7de2030f8346 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayList.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": true + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.4.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": true + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "4.4.4.4" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..48c8dd828b02 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayListByResourceGroup.json @@ -0,0 +1,199 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "4.4.4.4" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayPut.json new file mode 100644 index 000000000000..afd736d1e15c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayPut.json @@ -0,0 +1,256 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "isRoutingPreferenceInternet": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + }, + "isRoutingPreferenceInternet": false + } + } + }, + "201": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayReset.json new file mode 100644 index 000000000000..244c212080db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayReset.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayUpdateTags.json new file mode 100644 index 000000000000..1b0cff0ab4c3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2SVpnGatewayUpdateTags.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "configurationPolicyGroupAssociations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/configurationPolicyGroups/policyGroup1" + } + ], + "previousConfigurationPolicyGroupAssociations": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + }, + "enableInternetSecurity": false + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + }, + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json new file mode 100644 index 000000000000..ac3cabf8990e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "p2s-vpn-gateway-test", + "p2sVpnGatewayName": "p2svpngateway", + "api-version": "2025-03-01", + "request": { + "vpnConnectionIds": [ + "vpnconnId1", + "vpnconnId2" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PeerExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PeerExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..e4de06af0f8c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PeerExpressRouteCircuitConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "connectionName": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PeerExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PeerExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..9d456a7e5239 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PeerExpressRouteCircuitConnectionList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + }, + { + "name": "c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitC/peerings/AzurePrivatePeering" + }, + "addressPrefix": "30.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionCentralusEastus", + "authResourceGuid": "64283012-d377-421d-8398-f6aeb2ac7ea0" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PerimeterAssociableResourcesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PerimeterAssociableResourcesList.json new file mode 100644 index 000000000000..cfcf5b063bc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PerimeterAssociableResourcesList.json @@ -0,0 +1,44 @@ +{ + "title": "List of resources onboarded for network security perimeter feature (perimeter associable resources).", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Sql.servers", + "id": "/subscriptions/{subscriptionID}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Sql.servers", + "type": "Microsoft.Network/PerimeterAssociableResourceTypes", + "properties": { + "resourceType": "Microsoft.Sql/servers", + "displayName": "Microsoft.Sql/servers", + "publicDnsZones": [ + "database.windows.net" + ] + } + }, + { + "name": "Microsoft.Storage.accounts", + "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Storage.storageAccounts", + "type": "Microsoft.Network/PerimeterAssociableResourceTypes", + "properties": { + "resourceType": "Microsoft.Storage/accounts", + "displayName": "Microsoft.Storage/accounts", + "publicDnsZones": [ + "blob.core.windows.net", + "table.core.windows.net", + "queue.core.windows.net", + "file.core.windows.net" + ] + } + } + ], + "nextLink": "{baseurl}/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreate.json new file mode 100644 index 000000000000..8b9c607dbea0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreate.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "extendedLocation": { + "type": "EdgeZone", + "name": "edgeZone0" + }, + "parameters": { + "location": "eastus2euap", + "properties": { + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "ipVersionType": "IPv4", + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreateForManualApproval.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreateForManualApproval.json new file mode 100644 index 000000000000..de2af613e5c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreateForManualApproval.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "parameters": { + "location": "eastus", + "properties": { + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/manualPrivateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreateWithASG.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreateWithASG.json new file mode 100644 index 000000000000..1f26772e6e54 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointCreateWithASG.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "extendedLocation": { + "type": "EdgeZone", + "name": "edgeZone0" + }, + "parameters": { + "location": "eastus2euap", + "properties": { + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDelete.json new file mode 100644 index 000000000000..08dc1f95cba2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupCreate.json new file mode 100644 index 000000000000..cdb6001049a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupCreate.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup", + "parameters": { + "properties": { + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupDelete.json new file mode 100644 index 000000000000..c2d7765f92a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupDelete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupGet.json new file mode 100644 index 000000000000..18591f8960e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupGet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup" + }, + "responses": { + "200": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + }, + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone2.com", + "ipAddresses": [ + "10.0.0.6" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone2.com", + "ipAddresses": [ + "10.0.0.7" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupList.json new file mode 100644 index 000000000000..989a97e1a327 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointDnsZoneGroupList.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPdnsgroup1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup1", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + }, + { + "name": "testPdnsgroup2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup2", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc3", + "fqdn": "abc3.zone2.com", + "ipAddresses": [ + "10.0.0.6" + ] + }, + { + "recordType": "A", + "recordSetName": "abc4", + "fqdn": "abc4.zone2.com", + "ipAddresses": [ + "10.0.0.7" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGet.json new file mode 100644 index 000000000000..73e39583f8f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGet.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.6" + } + }, + { + "name": "pestaticconfig2", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.7" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGetForManualApproval.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGetForManualApproval.json new file mode 100644 index 000000000000..9d4492e25783 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGetForManualApproval.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/manualPrivateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.5" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGetWithASG.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGetWithASG.json new file mode 100644 index 000000000000..c6c0667f145e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointGetWithASG.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/applicationSecurityGroup/asg1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointList.json new file mode 100644 index 000000000000..30ff19494777 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointList.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1", + "name": "pe1", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe1.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe1.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.10" + } + }, + { + "name": "pestaticconfig", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.11" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe2", + "name": "pe2", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe2/privateLinkServiceConnections/plsconnection2", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection for pe2.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet2" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe2.nic.zyxw9876" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc3.cosmos1.com", + "ipAddresses": [ + "192.168.0.6" + ] + }, + { + "fqdn": "abc4.cosmos1.com", + "ipAddresses": [ + "192.168.0.7" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig3", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.8" + } + }, + { + "name": "pestaticconfig4", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.9" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointListAll.json new file mode 100644 index 000000000000..7a85bc4d914a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateEndpointListAll.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1", + "name": "pe1", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1/privateLinkServiceConnections/plsconnection1", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe1.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe1.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig1", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.9" + } + }, + { + "name": "pestaticconfig2", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.10" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2", + "name": "pe2", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2/privateLinkServiceConnections/plsconnection2", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection for pe2.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet2" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/pe2.nic.zyxw9876" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc3.cosmos1.com", + "ipAddresses": [ + "192.168.0.5" + ] + }, + { + "fqdn": "abc4.cosmos1.com", + "ipAddresses": [ + "192.168.0.6" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig3", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.11" + } + }, + { + "name": "pestaticconfig4", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.12" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateEndpoints/pe3", + "name": "pe3", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateEndpoints/testPe/privateLinkServiceConnections/plsconnection3", + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateLinkServices/testPls3", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe3.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet3" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg3/provders/Microsoft.Network/networkInterfaces/pe3.nic.efgh5463" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc5.cosmos2.com", + "ipAddresses": [ + "192.168.0.7" + ] + }, + { + "fqdn": "abc6.cosmos2.com", + "ipAddresses": [ + "192.168.0.8" + ] + } + ], + "applicationSecurityGroups": [], + "ipConfigurations": [ + { + "name": "pestaticconfig5", + "properties": { + "groupId": "file", + "memberName": "file", + "privateIPAddress": "192.168.0.13" + } + }, + { + "name": "pestaticconfig6", + "properties": { + "groupId": "file", + "memberName": "file2", + "privateIPAddress": "192.168.0.14" + } + } + ], + "customNetworkInterfaceName": "testPeNic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceCreate.json new file mode 100644 index 000000000000..8b65ee1d7f45 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceCreate.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "extendedLocation": { + "type": "EdgeZone", + "name": "edgeZone0" + }, + "parameters": { + "location": "eastus", + "properties": { + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/ipConfigurations/ipconfig1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + }, + "201": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/ipConfigurations/ipconfig1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceDelete.json new file mode 100644 index 000000000000..a52ae1e322c9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..42384f8e77d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "location": "eastus", + "peConnectionName": "testPlePeConnection" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceGet.json new file mode 100644 index 000000000000..301f70e14b2b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceGet.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/ipConfigurations/ipconfig1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "privateEndpointConnection", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/privateEndpointConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..9732d31b1948 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection" + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceList.json new file mode 100644 index 000000000000..74c2228b76d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceList.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPls1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1/ipConfigurations/ipconfig1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1/privateEndpointConnections/pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234" + } + ] + } + }, + { + "name": "testPls2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2/ipConfigurations/ipconfig2", + "properties": { + "privateIPAddress": "10.0.1.5", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2/privateEndpointConnections/pec2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceListAll.json new file mode 100644 index 000000000000..c67e2c67f5d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceListAll.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPls1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1/ipConfigurations/ipconfig1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1/privateEndpointConnections/pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234" + } + ] + } + }, + { + "name": "testPls2", + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2" + } + ], + "ipConfigurations": [ + { + "name": "ipconfig2", + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2/ipConfigurations/ipconfig2", + "properties": { + "privateIPAddress": "10.0.1.5", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec2", + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2/privateEndpointConnections/pec2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json new file mode 100644 index 000000000000..d538e122d8e6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPlePeConnection1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + }, + { + "name": "testPlePeConnection2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "rejected by some reason." + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..26a69a441f29 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection", + "parameters": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls/privateEndpointConnections/testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateCustomizedValues.json new file mode 100644 index 000000000000..bfb5a2b1e59c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateCustomizedValues.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "zones": [ + "1" + ], + "parameters": { + "properties": { + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "publicIPAddressVersion": "IPv4" + }, + "sku": { + "name": "Standard", + "tier": "Global" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "sku": { + "name": "Standard", + "tier": "Global" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "sku": { + "name": "Standard", + "tier": "Global" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDefaults.json new file mode 100644 index 000000000000..6c56cd253a17 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDefaults.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDefaultsStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDefaultsStandardV2Sku.json new file mode 100644 index 000000000000..b91f8d971f9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDefaultsStandardV2Sku.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "StandardV2" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "StandardV2" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDns.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDns.json new file mode 100644 index 000000000000..f93a9c858654 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDns.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "fqdn": "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "fqdn": "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json new file mode 100644 index 000000000000..50bfa83683d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl", + "domainNameLabelScope": "TenantReuse" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "dnslbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressDelete.json new file mode 100644 index 000000000000..9e70f44654cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressDisassociateCloudServiceReservedPublicIp.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressDisassociateCloudServiceReservedPublicIp.json new file mode 100644 index 000000000000..f4ba7cd47a62 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressDisassociateCloudServiceReservedPublicIp.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "pip1", + "parameters": { + "publicIpArmId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/publicIpAddresses/pip2" + } + }, + "responses": { + "200": { + "body": { + "name": "pip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGet.json new file mode 100644 index 000000000000..503b404e1809 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "Enabled", + "ddosProtectionPlan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + } + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGetDdosProtectionStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGetDdosProtectionStatus.json new file mode 100644 index 000000000000..e4a52cc55597 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGetDdosProtectionStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-pip" + }, + "responses": { + "200": { + "body": { + "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip", + "publicIpAddress": "10.0.1.5", + "isWorkloadProtected": "True", + "ddosProtectionPlanId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SampleRG/providers/Microsoft.Network/locations/tempLocation/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGetStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGetStandardV2Sku.json new file mode 100644 index 000000000000..ececd4eeb523 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressGetStandardV2Sku.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "sku": { + "name": "StandardV2" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "Enabled", + "ddosProtectionPlan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + } + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressList.json new file mode 100644 index 000000000000..ccacd6e8548f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.247", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "fqdn": "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip04", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip04", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.248", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "testlbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressListAll.json new file mode 100644 index 000000000000..88e82e5766da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressListAll.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip01", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.247", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "fqdn": "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip02", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip02", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.248", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "domainNameLabelScope": "TenantReuse", + "fqdn": "testlbl.hxdwgjcdfgbhgebs.eastus.sysgen.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressReserve.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressReserve.json new file mode 100644 index 000000000000..28248121714a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressReserve.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "isRollback": "false" + } + }, + "responses": { + "200": { + "body": { + "name": "test-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-01-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-01-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressUpdateTags.json new file mode 100644 index 000000000000..3b8b885d568e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpAddressUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ddosSettings": { + "protectionMode": "VirtualNetworkInherited" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateCustomizedValues.json new file mode 100644 index 000000000000..614429962798 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateCustomizedValues.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "zones": [ + "1" + ], + "parameters": { + "location": "westus", + "properties": { + "publicIPAddressVersion": "IPv4", + "prefixLength": 30 + }, + "sku": { + "name": "Standard", + "tier": "Regional" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard", + "tier": "Regional" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard", + "tier": "Regional" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateDefaults.json new file mode 100644 index 000000000000..e6a28108d36b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateDefaults.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "location": "westus", + "properties": { + "prefixLength": 30 + }, + "sku": { + "name": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateDefaultsStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateDefaultsStandardV2Sku.json new file mode 100644 index 000000000000..fe0912134ac7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixCreateDefaultsStandardV2Sku.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "location": "westus", + "properties": { + "prefixLength": 30 + }, + "sku": { + "name": "StandardV2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "StandardV2" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "StandardV2" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixDelete.json new file mode 100644 index 000000000000..f7f146430e2b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixGet.json new file mode 100644 index 000000000000..65e95a2f0d92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixGetStandardV2Sku.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixGetStandardV2Sku.json new file mode 100644 index 000000000000..92cb69bf6186 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixGetStandardV2Sku.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "StandardV2" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixList.json new file mode 100644 index 000000000000..5b8da6414f6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "40.85.154.2/30", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "ipprefix03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 31, + "ipPrefix": "40.85.153.2/31", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixListAll.json new file mode 100644 index 000000000000..c13a8794f8ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixListAll.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "41.85.154.247/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "ipprefix01", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "ipPrefix": "40.85.154.247/30", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "pfx", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/publicIPPrefixes/pfx", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/publicIPPrefixes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "ipPrefix": "25.101.84.16/30", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipTags": [], + "loadBalancerFrontendIpConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/loadBalancers/lb-pfx/frontendIPConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixUpdateTags.json new file mode 100644 index 000000000000..d961c4fbfd01 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/PublicIpPrefixUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "ipPrefix": "40.85.154.247/30", + "prefixLength": 30, + "ipTags": [] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/QueryInboundNatRulePortMapping.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/QueryInboundNatRulePortMapping.json new file mode 100644 index 000000000000..f2dc1b6b22b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/QueryInboundNatRulePortMapping.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "groupName": "rg1", + "loadBalancerName": "lb1", + "backendPoolName": "bp1", + "parameters": { + "ipAddress": "10.0.0.4" + } + }, + "responses": { + "200": { + "body": { + "inboundNatRulePortMappings": [ + { + "inboundNatRuleName": "natRule", + "protocol": "Tcp", + "frontendPort": 3389, + "backendPort": 3389 + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bp1/queryInboundNatRulePortMapping?api-version=2025-03-01" + }, + "body": { + "inboundNatRulePortMappings": [ + { + "inboundNatRuleName": "natRule", + "protocol": "Tcp", + "frontendPort": 3389, + "backendPort": 3389 + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentDelete.json new file mode 100644 index 000000000000..076529495310 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "reachabilityAnalysisIntentName": "testAnalysisIntent" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentGet.json new file mode 100644 index 000000000000..a0035c28c462 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "reachabilityAnalysisIntentName": "testAnalysisIntentName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace/reachabilityAnalysisIntents/testAnalysisIntentName", + "name": "testAnalysisIntentName", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisIntents", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "provisioningState": "Succeeded", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentList.json new file mode 100644 index 000000000000..7d33564c7902 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testVerifierWorkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1", + "name": "testReachabilityAnalysisIntenant1", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisIntents", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "provisioningState": "Succeeded", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/subId/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentPut.json new file mode 100644 index 000000000000..757ec8d346f1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisIntentPut.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "reachabilityAnalysisIntentName": "testAnalysisIntentName", + "body": { + "properties": { + "description": "A sample reachability analysis intent", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace/reachabilityAnalysisIntents/testAnalysisIntentName", + "name": "testAnalysisIntentName", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisIntents", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "provisioningState": "Succeeded", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace/reachabilityAnalysisIntents/testAnalysisIntentName", + "name": "testAnalysisIntentName", + "type": "Microsoft.Network/networkManagers/reachabilityAnalysisIntents", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "provisioningState": "Succeeded", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunDelete.json new file mode 100644 index 000000000000..00dcd7e0bb31 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "reachabilityAnalysisRunName": "testAnalysisRun" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/verifierWorkspaceOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunGet.json new file mode 100644 index 000000000000..79e0042fab75 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "reachabilityAnalysisRunName": "testAnalysisRunName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace/reachabilityAnalysisRuns/testAnalysisRunName", + "name": "testAnalysisRunName", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisRuns", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "intentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1", + "provisioningState": "Succeeded", + "intentContent": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + }, + "analysisResult": "{\"resultOutcome\":\"NoPacketsReached\",\"unreachedTrace\":\"[{\\\"name\\\":\\\"testVmSrc\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc\\\",\\\"resourceType\\\":\\\"Microsoft.Compute/virtualMachines\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"0\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\",\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet has source IP address matching one of the network interface IPs.\\\",\\\"explanationCode\\\":\\\"MATCHED_NETWORK_INTERFACE_IP_SOURCE\\\",\\\"matchedNetworkInterfaceAddress\\\":{\\\"networkInterface\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface\\\",\\\"ipAddress\\\":\\\"10.5.0.4\\\"}}},{\\\"name\\\":\\\"testNetworkInterface\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface\\\",\\\"resourceType\\\":\\\"Microsoft.Network/networkInterfaces\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"0\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\",\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet has source IP address matching one of the network interface IPs.\\\",\\\"explanationCode\\\":\\\"MATCHED_NETWORK_INTERFACE_IP_SOURCE\\\",\\\"matchedNetworkInterfaceAddress\\\":{\\\"networkInterface\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface\\\",\\\"ipAddress\\\":\\\"10.5.0.4\\\"}}},{\\\"name\\\":\\\"testNetworkManager\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager\\\",\\\"resourceType\\\":\\\"Microsoft.Network/networkManagers\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"0\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\",\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet matched an admin security rule.\\\",\\\"explanationCode\\\":\\\"MATCHED_ADMIN_SECURITY_RULE\\\",\\\"matchedSecurityRule\\\":{\\\"name\\\":\\\"AllowAllOutbound\\\",\\\"action\\\":\\\"Allow\\\",\\\"destinationAddress\\\":\\\"*\\\",\\\"sourceAddress\\\":\\\"*\\\",\\\"destinationPort\\\":\\\"1-65535\\\",\\\"sourcePort\\\":\\\"1-65535\\\",\\\"protocol\\\":\\\"Any\\\"}}},{\\\"name\\\":\\\"testnsg\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg-eus2\\\",\\\"resourceType\\\":\\\"Microsoft.Network/networkSecurityGroups\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"0\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\",\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet matched a network security rule.\\\",\\\"explanationCode\\\":\\\"MATCHED_NETWORK_SECURITY_RULE\\\",\\\"matchedSecurityRule\\\":{\\\"name\\\":\\\"defaultSecurityRules/AllowVnetOutBound\\\",\\\"action\\\":\\\"allow\\\",\\\"destinationAddress\\\":\\\"VirtualNetwork\\\",\\\"sourceAddress\\\":\\\"VirtualNetwork\\\",\\\"destinationPort\\\":\\\"0-65535\\\",\\\"sourcePort\\\":\\\"0-65535\\\",\\\"protocol\\\":\\\"All\\\"}}},{\\\"name\\\":\\\"default\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/default\\\",\\\"resourceType\\\":\\\"Microsoft.Network/virtualNetworks/subnets\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"0\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\",\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet matched a system route.\\\",\\\"explanationCode\\\":\\\"MATCHED_SYSTEM_ROUTE\\\",\\\"matchedSubnetRoute\\\":{\\\"source\\\":\\\"Default\\\",\\\"addressPrefix\\\":\\\"10.1.0.0/16\\\",\\\"nextHopIpAddress\\\":[],\\\"nextHopType\\\":\\\"ConnectedGroup\\\"}}},{\\\"name\\\":\\\"testvnet1\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/testvnet1\\\",\\\"resourceType\\\":\\\"Microsoft.Network/virtualNetworks\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"0\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\",\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet destination IP is destined to subnet prefix.\\\",\\\"explanationCode\\\":\\\"MATCHED_SUBNET_PREFIX\\\",\\\"matchedSubnetPrefix\\\":{\\\"subnet\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/testvnet-1/subnets/default\\\",\\\"subnetPrefix\\\":\\\"10.1.0.0/24\\\"}}},{\\\"name\\\":\\\"default\\\",\\\"resourceId\\\":\\\"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/testvnet1/subnets/default\\\",\\\"resourceType\\\":\\\"Microsoft.Network/virtualNetworks/subnets\\\",\\\"packet\\\":{\\\"destinationAddress\\\":\\\"10.1.0.4\\\",\\\"destinationPort\\\":\\\"443\\\",\\\"sourceAddress\\\":\\\"10.5.0.4\\\",\\\"sourcePort\\\":\\\"0\\\"\\\"protocol\\\":\\\"TCP\\\"},\\\"explanation\\\":{\\\"description\\\":\\\"Packet denied due to VM not currently running.\\\",\\\"explanationCode\\\":\\\"VM_TURNED_OFF\\\"}}]\"}", + "errorMessage": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunList.json new file mode 100644 index 000000000000..428fd13edb03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testVerifierWorkspace1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns/testReachabilityAnalysisRun1", + "name": "testReachabilityAnalysisRun1", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisRuns", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "intentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1", + "provisioningState": "Succeeded", + "intentContent": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisRuns?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunPut.json new file mode 100644 index 000000000000..2e2c12d5116e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ReachabilityAnalysisRunPut.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "reachabilityAnalysisRunName": "testAnalysisRunName", + "body": { + "properties": { + "description": "A sample reachability analysis run", + "intentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace/reachabilityAnalysisRuns/testAnalysisRunName", + "name": "testAnalysisRunName", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisRuns", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "intentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1", + "provisioningState": "Succeeded", + "intentContent": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManager/testNetworkManager/verifierWorkspaces/testWorkspace/reachabilityAnalysisRuns/testAnalysisRunName", + "name": "testAnalysisRunName", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces/reachabilityAnalysisRuns", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample reachability analysis intent", + "intentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1/reachabilityAnalysisIntents/testReachabilityAnalysisIntenant1", + "provisioningState": "Succeeded", + "intentContent": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmSrc", + "destinationResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/testVmDest", + "ipTraffic": { + "sourceIps": [ + "10.4.0.0" + ], + "destinationIps": [ + "10.4.0.1" + ], + "sourcePorts": [ + "0" + ], + "destinationPorts": [ + "0" + ], + "protocols": [ + "Any" + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterCreate.json new file mode 100644 index 000000000000..2028d0e96fb4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterCreate.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterDelete.json new file mode 100644 index 000000000000..e95a116afb58 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterGet.json new file mode 100644 index 000000000000..bc3a195c9b83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterList.json new file mode 100644 index 000000000000..db209ab4f37b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterListByResourceGroup.json new file mode 100644 index 000000000000..5c2109420bc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleCreate.json new file mode 100644 index 000000000000..b553a9b08ebe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleDelete.json new file mode 100644 index 000000000000..a8fdbc3fc6cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleGet.json new file mode 100644 index 000000000000..0b18abd7f846 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "ruleName": "filterName", + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleListByRouteFilter.json new file mode 100644 index 000000000000..cb2d9d0199bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterRuleListByRouteFilter.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "routeFilterName": "filterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterUpdateTags.json new file mode 100644 index 000000000000..d04f45a72f39 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteFilterUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapDelete.json new file mode 100644 index 000000000000..8851c0f385ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "routeMapName": "routeMap1", + "api-version": "2025-03-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapGet.json new file mode 100644 index 000000000000..818a2ecb0ac6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "routeMapName": "routeMap1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\"e203e953-7ba7-4302-a246-aa2ec03f6edf\"", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapList.json new file mode 100644 index 000000000000..b9a7674bfbbe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapPut.json new file mode 100644 index 000000000000..04f5086d9b1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteMapPut.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "routeMapName": "routeMap1", + "api-version": "2025-03-01", + "routeMapParameters": { + "properties": { + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + }, + "201": { + "body": { + "name": "routeMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1", + "etag": "W/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "name": "rule1", + "matchCriteria": [ + { + "matchCondition": "Contains", + "routePrefix": [ + "10.0.0.0/8" + ], + "community": [], + "asPath": [] + } + ], + "actions": [ + { + "type": "Add", + "parameters": [ + { + "routePrefix": [], + "community": [], + "asPath": [ + "22334" + ] + } + ] + } + ], + "nextStepIfMatched": "Continue" + } + ], + "associatedInboundConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/exrGateway1/expressRouteConnections/exrConn1" + ], + "associatedOutboundConnections": [] + }, + "type": "Microsoft.Network/virtualHubs/routeMaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableCreate.json new file mode 100644 index 000000000000..c472531a138f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [], + "disableBgpRoutePropagation": true + } + } + }, + "201": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableCreateWithRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableCreateWithRoute.json new file mode 100644 index 000000000000..ae3f227df59a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableCreateWithRoute.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "properties": { + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableDelete.json new file mode 100644 index 000000000000..efd655f09c4b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableGet.json new file mode 100644 index 000000000000..6cd376d9c5fc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": false, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableList.json new file mode 100644 index 000000000000..dd94af697e50 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "disableBgpRoutePropagation": true, + "provisioningState": "Succeeded", + "routes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableListAll.json new file mode 100644 index 000000000000..dcfc15938c75 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableListAll.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteCreate.json new file mode 100644 index 000000000000..24483e07388c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1", + "routeParameters": { + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteDelete.json new file mode 100644 index 000000000000..0a150f8dfeb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/westus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteGet.json new file mode 100644 index 000000000000..a0eac1d83b2a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteList.json new file mode 100644 index 000000000000..1d0f8f28030f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableRouteList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + }, + { + "name": "route2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.2.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableUpdateTags.json new file mode 100644 index 000000000000..5129bb8205bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RouteTableUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentDelete.json new file mode 100644 index 000000000000..fb88494d38dd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "routingIntentName": "Intent1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentGet.json new file mode 100644 index 000000000000..90c64cc04e83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "routingIntentName": "Intent1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentList.json new file mode 100644 index 000000000000..f92a7cbe55df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentPut.json new file mode 100644 index 000000000000..da2e87def400 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/RoutingIntentPut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "routingIntentName": "Intent1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "routingIntentParameters": { + "properties": { + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + }, + "201": { + "body": { + "name": "Intent1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routingIntent/Intent1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routingPolicies": [ + { + "name": "InternetTraffic", + "destinations": [ + "Internet" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + }, + { + "name": "PrivateTrafficPolicy", + "destinations": [ + "PrivateTraffic" + ], + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfw1" + } + ] + }, + "type": "Microsoft.Network/virtualHubs/routingIntent" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderDelete.json new file mode 100644 index 000000000000..902e82f6c873 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderGet.json new file mode 100644 index 000000000000..11637cc780af --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider" + }, + "responses": { + "200": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderListByResourceGroup.json new file mode 100644 index 000000000000..45a830953da3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderListByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderListBySubscription.json new file mode 100644 index 000000000000..b278f9516ea6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderListBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderPut.json new file mode 100644 index 000000000000..c40dcd6bb0cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderPut.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + }, + "201": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderUpdateTags.json new file mode 100644 index 000000000000..16efab771475 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SecurityPartnerProviderUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "fw1", + "id": "/subscriptions/subid/resourceGroups/azfwtest/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceCommunityList.json new file mode 100644 index 000000000000..081f285bddf2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceCommunityList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/skype", + "name": "skype", + "type": "Microsoft.Network/bgpServiceCommunities", + "properties": { + "serviceName": "skype", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Skype For Business Online", + "communityValue": "12076:5030", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup": "O365" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/exchange", + "name": "exchange", + "type": "Microsoft.Network/bgpServiceCommunities", + "properties": { + "serviceName": "exchange", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Exchange Online", + "communityValue": "12076:5040", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup": "O365" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyCreate.json new file mode 100644 index 000000000000..fbff1925701d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyCreateWithDefinition.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyCreateWithDefinition.json new file mode 100644 index 000000000000..a9c0c3b7eae8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyCreateWithDefinition.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "parameters": { + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition", + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition", + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionCreate.json new file mode 100644 index 000000000000..834ac1214970 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition", + "ServiceEndpointPolicyDefinitions": { + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDefinition", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionDelete.json new file mode 100644 index 000000000000..89f7eb7cd5b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionGet.json new file mode 100644 index 000000000000..5adf7409ce27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses": { + "200": { + "body": { + "name": "testDefinition", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionList.json new file mode 100644 index 000000000000..cb75bc470454 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDefinitionList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDef", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDef", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDelete.json new file mode 100644 index 000000000000..e20c2123ae09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "serviceEndpointPolicy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyGet.json new file mode 100644 index 000000000000..b5a9e7fb7268 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy" + }, + "responses": { + "200": { + "body": { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition", + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyList.json new file mode 100644 index 000000000000..39c97b530b7a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition", + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testServiceEndpointPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy1", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy1/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition1", + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyListAll.json new file mode 100644 index 000000000000..6ad92a7c6940 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyListAll.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition1", + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy2", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy1/serviceEndpointPolicyDefinitions/StorageServiceEndpointPolicyDefinition2", + "name": "StorageServiceEndpointPolicyDefinition2", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyUpdateTags.json new file mode 100644 index 000000000000..43e14456352b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceEndpointPolicyUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResult.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResult.json new file mode 100644 index 000000000000..fecf54242186 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResult.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westeurope", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "20.36.106.68/31", + "20.36.107.176/28" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json new file mode 100644 index 000000000000..9db04053a18c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResultWithNoAddressPrefixes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westeurope", + "subscriptionId": "subid", + "noAddressPrefixes": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResultWithTagname.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResultWithTagname.json new file mode 100644 index 000000000000..f45813874e9b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagInformationListResultWithTagname.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westeurope", + "subscriptionId": "subid", + "tagName": "ApiManagement" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagsList.json new file mode 100644 index 000000000000..bf60a7469ab8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/ServiceTagsList.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "name": "public", + "id": "/subscriptions/subId/providers/Microsoft.Network/serviceTags/public", + "type": "Microsoft.Network/serviceTags", + "changeNumber": "63", + "cloud": "Public", + "values": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "20.36.106.68/31", + "20.36.107.176/28" + ] + } + }, + { + "name": "AppService", + "id": "AppService", + "properties": { + "changeNumber": "13", + "region": "", + "systemService": "AzureAppService", + "addressPrefixes": [ + "13.64.73.110/32", + "191.235.208.12/32", + "191.235.215.184/32" + ] + } + }, + { + "name": "ServiceBus", + "id": "ServiceBus", + "properties": { + "changeNumber": "10", + "region": "", + "systemService": "AzureServiceBus", + "addressPrefixes": [ + "23.98.82.96/29", + "40.68.127.68/32", + "40.70.146.64/29" + ] + } + }, + { + "name": "ServiceBus.EastUS2", + "id": "ServiceBus.EastUS2", + "properties": { + "changeNumber": "1", + "region": "eastus2", + "systemService": "AzureServiceBus", + "addressPrefixes": [ + "13.68.110.36/32", + "40.70.146.64/29" + ] + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/serviceTags?api-version=2020-06-01&changenumber=changenumber&$skipToken={skipToken}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Create.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Create.json new file mode 100644 index 000000000000..6fa534643400 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Create.json @@ -0,0 +1,65 @@ +{ + "title": "Create a StaticCidr Resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool", + "staticCidrName": "TestStaticCidr", + "parameters": { + "description": "test description", + "addressPrefixes": [ + "10.0.0.0/24" + ] + } + }, + "responses": { + "200": { + "body": { + "name": "OnPremResources", + "type": "Microsoft.Network/networkManagers/ipamPools/TestStaticCidr", + "properties": { + "description": "test description", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "numberOfIPAddressesToAllocate": "", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool/staticCidrs/TestStaticCidr", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + }, + "201": { + "body": { + "name": "OnPremResources", + "type": "Microsoft.Network/networkManagers/ipamPools/TestStaticCidr", + "properties": { + "description": "test description", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "numberOfIPAddressesToAllocate": "", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool/staticCidrs/TestStaticCidr", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Delete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Delete.json new file mode 100644 index 000000000000..a8dcd0b7ca2b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Delete.json @@ -0,0 +1,19 @@ +{ + "title": "Delete the StaticCidr resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool", + "staticCidrName": "TestStaticCidr" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/SampleRG/providers/Microsoft.Network/networkManagers/TestNM/ipamPools/TestPool/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Get.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Get.json new file mode 100644 index 000000000000..216b0e8deeb3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_Get.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the specific StaticCidr resource", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool", + "staticCidrName": "TestStaticCidr" + }, + "responses": { + "200": { + "body": { + "name": "TestStaticCidr", + "type": "Microsoft.Network/networkManagers/ipamPools/staticCidrs", + "properties": { + "description": "test description", + "numberOfIPAddressesToAllocate": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "totalNumberOfIPAddresses": "256", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool/staticCidrs/TestStaticCidr", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_List.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_List.json new file mode 100644 index 000000000000..5f3d4145670c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/StaticCidrs_List.json @@ -0,0 +1,41 @@ +{ + "title": "Gets list of StaticCidr resources at Pool level", + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "11111111-1111-1111-1111-111111111111", + "resourceGroupName": "rg1", + "networkManagerName": "TestNetworkManager", + "poolName": "TestPool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TestStaticCidr", + "type": "Microsoft.Network/networkManagers/ipamPools/staticCidrs", + "properties": { + "description": "test description", + "numberOfIPAddressesToAllocate": "", + "addressPrefixes": [ + "10.0.0.0/24" + ], + "totalNumberOfIPAddresses": "256", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools/TestPool/staticCidrs/TestStaticCidr", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/TestNetworkManager/ipamPools?api-version=2025-03-01&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreate.json new file mode 100644 index 000000000000..cc629943bad8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateServiceEndpoint.json new file mode 100644 index 000000000000..94eac622720e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateServiceEndpoint.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json new file mode 100644 index 000000000000..bfe0d0c084d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateServiceEndpointNetworkIdentifier.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "networkIdentifier": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "networkIdentifier": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "networkIdentifier": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateWithDelegation.json new file mode 100644 index 000000000000..5da1bad75e6c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateWithDelegation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subId", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateWithSharingScope.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateWithSharingScope.json new file mode 100644 index 000000000000..2d303468e7a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetCreateWithSharingScope.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "sharingScope": "Tenant", + "defaultOutboundAccess": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "sharingScope": "Tenant", + "defaultOutboundAccess": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetDelete.json new file mode 100644 index 000000000000..341962a4394e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGet.json new file mode 100644 index 000000000000..5f8b8d81b3ab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGetWithDelegation.json new file mode 100644 index 000000000000..860d149407f6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGetWithDelegation.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGetWithSharingScope.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGetWithSharingScope.json new file mode 100644 index 000000000000..9acd777cacbf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetGetWithSharingScope.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "sharingScope": "Tenant", + "defaultOutboundAccess": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetList.json new file mode 100644 index 000000000000..a86876d7df36 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", + "name": "subnet2", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetPrepareNetworkPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetPrepareNetworkPolicies.json new file mode 100644 index 000000000000..22ee13de820b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetPrepareNetworkPolicies.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "subnetName": "subnet1", + "prepareNetworkPoliciesRequestParameters": { + "serviceName": "Microsoft.Sql/managedInstances" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/PrepareNetworkPolicies?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetUnprepareNetworkPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetUnprepareNetworkPolicies.json new file mode 100644 index 000000000000..c2466eb0890f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/SubnetUnprepareNetworkPolicies.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "subnetName": "subnet1", + "unprepareNetworkPoliciesRequestParameters": { + "serviceName": "Microsoft.Sql/managedInstances" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/UnprepareNetworkPolicies?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/UsageList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/UsageList.json new file mode 100644 index 000000000000..984fd359c7c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/UsageList.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", + "limit": 350.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", + "limit": 10.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", + "limit": 4096.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", + "limit": 10.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 200.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/outboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "outboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/UsageListSpacedLocation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/UsageListSpacedLocation.json new file mode 100644 index 000000000000..d046abe8c985 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/UsageListSpacedLocation.json @@ -0,0 +1,335 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIpPrefixes", + "limit": 2147483647.0, + "name": { + "localizedValue": "Public Ip Prefixes", + "value": "PublicIpPrefixes" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkInterfaces", + "limit": 24000.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 5.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PacketCaptures", + "limit": 100.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationSecurityGroups", + "limit": 500.0, + "name": { + "localizedValue": "Application Security Groups.", + "value": "ApplicationSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DdosProtectionPlans", + "limit": 1.0, + "name": { + "localizedValue": "DDoS Protection Plans.", + "value": "DdosProtectionPlans" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ServiceEndpointPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Service Endpoint Policies", + "value": "ServiceEndpointPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkIntentPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Network Intent Policies", + "value": "NetworkIntentPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/IPConfigurationsPerVirtualNetwork", + "limit": 16384.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PeeringsPerVirtualNetwork", + "limit": 50.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 1000.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Security rules per Network Intent Policy", + "value": "SecurityRulesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Network Intent Policy", + "value": "RoutesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/OutboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "OutboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerRouteTable", + "limit": 400.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceDelete.json new file mode 100644 index 000000000000..01cc33c03a50 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/eastus/verifierWorkspaceOperationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceGet.json new file mode 100644 index 000000000000..07603faf6052 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "verifierWorkspace": { + "properties": { + "description": "A sample workspace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace", + "name": "testWorkspace", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces", + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample workspace", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceList.json new file mode 100644 index 000000000000..cde43720d3c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspaceList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testVerifierWorkspace1", + "name": "testVerifierWorkspace1", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces", + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample verfier workspace", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces?api-version=2024-04-01-preview&$skipToken=10" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspacePatch.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspacePatch.json new file mode 100644 index 000000000000..90020a3ce045 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspacePatch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "verifierWorkspace": { + "tags": { + "color": "blue" + }, + "properties": { + "description": "A sample workspace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace", + "name": "testWorkspace", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces", + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "tags": { + "color": "blue" + }, + "properties": { + "description": "A sample workspace", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspacePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspacePut.json new file mode 100644 index 000000000000..5d589e4ca942 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VerifierWorkspacePut.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg1", + "networkManagerName": "testNetworkManager", + "workspaceName": "testWorkspace", + "body": { + "location": "eastus", + "properties": { + "description": "A sample workspace" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace", + "name": "testWorkspace", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces", + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample workspace", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace", + "name": "testWorkspace", + "type": "Microsoft.Network/networkManagers/verifierWorkspaces", + "location": "eastus", + "etag": "\"00000000-0000-0000-0000-000000000000\"", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "createdByType": "User", + "createdAt": "2021-01-11T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef5", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-11T18:52:27Z" + }, + "properties": { + "description": "A sample workspace", + "provisioningState": "Succeeded" + } + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/verifierWorkspaces/testWorkspace?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionDelete.json new file mode 100644 index 000000000000..d5d9377e9cfd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionGet.json new file mode 100644 index 000000000000..a720dd2e5d72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionList.json new file mode 100644 index 000000000000..7952673ed27e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionPut.json new file mode 100644 index 000000000000..d0008b7df039 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubBgpConnectionPut.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "parameters": { + "properties": { + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + }, + "201": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected", + "hubVirtualNetworkConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/hubVnetConn1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubDelete.json new file mode 100644 index 000000000000..d999c7cdba86 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubGet.json new file mode 100644 index 000000000000..4c80b5feea36 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationDelete.json new file mode 100644 index 000000000000..e16d7ce9075c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "ipConfigName": "ipconfig1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationGet.json new file mode 100644 index 000000000000..d98544c3c789 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "ipConfigName": "ipconfig1" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationList.json new file mode 100644 index 000000000000..8a4281e6962d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationPut.json new file mode 100644 index 000000000000..acc43ad610ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubIpConfigurationPut.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "ipConfigName": "ipconfig1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "parameters": { + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + }, + "201": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubList.json new file mode 100644 index 000000000000..876bc2bd3d07 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubList.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "210.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubListByResourceGroup.json new file mode 100644 index 000000000000..3bf73fb41fe7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubListByResourceGroup.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "210.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubPut.json new file mode 100644 index 000000000000..cec9eafcadec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubPut.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "addressPrefix": "10.168.0.0/24", + "sku": "Basic" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "preferredRoutingGateway": "ExpressRoute", + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Delete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Delete.json new file mode 100644 index 000000000000..fb87419952ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Get.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Get.json new file mode 100644 index 000000000000..07f3b6ea731d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2List.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2List.json new file mode 100644 index 000000000000..8d239f62496c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2List.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "virtualHubRouteTable1a", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + }, + { + "name": "virtualHubRouteTable1b", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1b", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.30.0.0/16", + "20.40.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Branches" + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Put.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Put.json new file mode 100644 index 000000000000..ea6cb18f6e53 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubRouteTableV2Put.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "virtualHubRouteTableV2Parameters": { + "properties": { + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubUpdateTags.json new file mode 100644 index 000000000000..90f1f9f6bdb7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualHubUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ], + "allowBranchToBranchTraffic": false, + "hubRoutingPreference": "ExpressRoute", + "virtualRouterAutoScaleConfiguration": { + "minCapacity": 2 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCheckIPAddressAvailability.json new file mode 100644 index 000000000000..d06ef262884a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "ipAddress": "10.0.1.4" + }, + "responses": { + "200": { + "body": { + "available": false, + "availableIPAddresses": [ + "10.0.1.5", + "10.0.1.6", + "10.0.1.7", + "10.0.1.8", + "10.0.1.9" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreate.json new file mode 100644 index 000000000000..83ffae6ef467 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "flowTimeoutInMinutes": 10 + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "flowTimeoutInMinutes": 10, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "flowTimeoutInMinutes": 10, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json new file mode 100644 index 000000000000..2300b39a010c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "vnetTest", + "virtualNetworkName": "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ] + } + } + ] + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateServiceEndpoints.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateServiceEndpoints.json new file mode 100644 index 000000000000..1c2d01b70627 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateServiceEndpoints.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "vnetTest", + "virtualNetworkName": "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnet.json new file mode 100644 index 000000000000..475cc6ad7fef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json new file mode 100644 index 000000000000..45d2b7d5da29 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.1.0.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnetWithDelegation.json new file mode 100644 index 000000000000..587be14ba164 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateSubnetWithDelegation.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "delegations": [ + { + "name": "myDelegation", + "properties": { + "serviceName": "Microsoft.Sql/managedInstances" + } + } + ] + } + } + ] + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Sql/managedInstances", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Sql/managedInstances", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithBgpCommunities.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithBgpCommunities.json new file mode 100644 index 000000000000..2aaedcf8226c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithBgpCommunities.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:20000" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:20000", + "regionalCommunity": "12076:50004" + }, + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:20000", + "regionalCommunity": "12076:50004" + }, + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithEncryption.json new file mode 100644 index 000000000000..65bc1a54b823 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithEncryption.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ], + "encryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "encryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "encryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithIpamPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithIpamPool.json new file mode 100644 index 000000000000..8eebcb947421 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkCreateWithIpamPool.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "ipamPoolPrefixAllocations": [ + { + "numberOfIpAddresses": "65536", + "pool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1/ipamPools/testIpamPool" + } + } + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "ipamPoolPrefixAllocations": [ + { + "pool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1/ipamPools/testIpamPool" + }, + "numberOfIpAddresses": "80" + } + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/22" + ], + "ipamPoolPrefixAllocations": [ + { + "numberOfIpAddresses": "800", + "pool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1/ipamPools/testIpamPool" + }, + "allocatedAddressPrefixes": [ + "10.0.0.0/22" + ] + } + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Updating", + "addressPrefixes": [ + "10.0.0.0/26", + "10.0.0.64/28" + ], + "ipamPoolPrefixAllocations": [ + { + "numberOfIpAddresses": "80", + "pool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1/ipamPools/testIpamPool" + }, + "allocatedAddressPrefixes": [ + "10.0.0.0/26", + "10.0.0.64/28" + ] + } + ] + } + } + ] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Updating", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/22" + ], + "ipamPoolPrefixAllocations": [ + { + "numberOfIpAddresses": "800", + "pool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1/ipamPools/testIpamPool" + }, + "allocatedAddressPrefixes": [ + "10.0.0.0/22" + ] + } + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Updating", + "addressPrefixes": [ + "10.0.0.0/26", + "10.0.0.64/28" + ], + "ipamPoolPrefixAllocations": [ + { + "numberOfIpAddresses": "80", + "pool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkManagers/nm1/ipamPools/testIpamPool" + }, + "allocatedAddressPrefixes": [ + "10.0.0.0/26", + "10.0.0.64/28" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkDelete.json new file mode 100644 index 000000000000..c248d3683ba7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayAbortMigration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayAbortMigration.json new file mode 100644 index 000000000000..21623127c575 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayAbortMigration.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayCommitMigration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayCommitMigration.json new file mode 100644 index 000000000000..21623127c575 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayCommitMigration.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionCreate.json new file mode 100644 index 000000000000..db71bf741837 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionCreate.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S", + "parameters": { + "properties": { + "virtualNetworkGateway1": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1" + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus", + "tags": {} + }, + "localNetworkGateway2": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "location": "centralus", + "tags": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionMode": "Default", + "authenticationType": "Certificate", + "certificateAuthentication": { + "outboundAuthCertificate": "https://customerKv.vault.azure.net/Certificates/outBoundcert/Version", + "inboundAuthCertificateChain": [ + "MIIC+TCCAeGgAwIBAgIQFOJUqDaxV5xJcKpTKO...", + "MIIC+TCCAeGgAwIBAgIQPJerInitNblK7yBgkqh..." + ], + "inboundAuthCertificateSubjectName": "CN=rootCert.com" + }, + "tunnelProperties": [ + { + "tunnelIpAddress": "10.78.1.5", + "bgpPeeringAddress": "10.78.1.17" + }, + { + "tunnelIpAddress": "10.78.1.7", + "bgpPeeringAddress": "10.78.1.20" + } + ] + }, + "location": "centralus" + } + }, + "responses": { + "201": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "enableBgp": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default", + "authenticationType": "Certificate", + "certificateAuthentication": { + "outboundAuthCertificate": "https://customerKv.vault.azure.net/Certificates/outBoundcert/Version", + "inboundAuthCertificateChain": [ + "MIIC+TCCAeGgAwIBAgIQFOJUqDaxV5xJcKpTKO...", + "MIIC+TCCAeGgAwIBAgIQPJerInitNblK7yBgkqh..." + ], + "inboundAuthCertificateSubjectName": "CN=rootCert.com" + }, + "tunnelProperties": [ + { + "tunnelIpAddress": "10.78.1.5", + "bgpPeeringAddress": "10.78.1.17" + }, + { + "tunnelIpAddress": "10.78.1.7", + "bgpPeeringAddress": "10.78.1.20" + } + ] + } + } + }, + "200": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default", + "authenticationType": "Certificate", + "certificateAuthentication": { + "outboundAuthCertificate": "https://customerKv.vault.azure.net/Certificates/outBoundcert/Version", + "inboundAuthCertificateChain": [ + "MIIC+TCCAeGgAwIBAgIQFOJUqDaxV5xJcKpTKO...", + "MIIC+TCCAeGgAwIBAgIQPJerInitNblK7yBgkqh..." + ], + "inboundAuthCertificateSubjectName": "CN=rootCert.com" + }, + "tunnelProperties": [ + { + "tunnelIpAddress": "10.78.1.5", + "bgpPeeringAddress": "10.78.1.17" + }, + { + "tunnelIpAddress": "10.78.1.7", + "bgpPeeringAddress": "10.78.1.20" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionDelete.json new file mode 100644 index 000000000000..da4598b71f58 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGet.json new file mode 100644 index 000000000000..baec63134a20 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGet.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S" + }, + "responses": { + "200": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionStatus": "Connecting", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default", + "authenticationType": "Certificate", + "certificateAuthentication": { + "outboundAuthCertificate": "https://customerKv.vault.azure.net/Certificates/outBoundcert/Version", + "inboundAuthCertificateChain": [ + "MIIC+TCCAeGgAwIBAgIQFOJUqDaxV5xJcKpTKO...", + "MIIC+TCCAeGgAwIBAgIQPJerInitNblK7yBgkqh..." + ], + "inboundAuthCertificateSubjectName": "CN=rootCert.com" + }, + "tunnelProperties": [ + { + "tunnelIpAddress": "10.78.1.5", + "bgpPeeringAddress": "10.78.1.17" + }, + { + "tunnelIpAddress": "10.78.1.7", + "bgpPeeringAddress": "10.78.1.20" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json new file mode 100644 index 000000000000..1e7d5fa4cf5e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGetIkeSas.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/westus/operationResults/{operationId}?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json new file mode 100644 index 000000000000..aad915def9c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S" + }, + "responses": { + "200": { + "body": { + "id": "", + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionReset.json new file mode 100644 index 000000000000..015bdbb09aa6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionReset.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json new file mode 100644 index 000000000000..4419c3f801d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1", + "parameters": { + "keyLength": 128 + } + }, + "responses": { + "200": { + "body": { + "keyLength": 128 + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json new file mode 100644 index 000000000000..2394ec7f925f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S", + "parameters": { + "value": "AzureAbc123" + } + }, + "responses": { + "200": { + "body": { + "id": "", + "value": "AzureAbc123" + } + }, + "201": { + "body": { + "id": "", + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json new file mode 100644 index 000000000000..fd42cbcfe39f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..453ab4bca282 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json new file mode 100644 index 000000000000..7bbfec061969 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json new file mode 100644 index 000000000000..311bb6a4b5f7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "routingWeight": 0, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionsList.json new file mode 100644 index 000000000000..bd890487449a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayConnectionsList.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "properties": {} + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv1", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.3" + } + ], + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + }, + { + "name": "conn2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "properties": {} + }, + "localNetworkGateway2": { + "properties": {}, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2" + }, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule1" + } + ], + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule2" + } + ], + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 20, + "enableBgp": false, + "gatewayCustomBgpIpAddresses": [ + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "customBgpIpAddress": "169.254.21.4" + }, + { + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/ActiveActive", + "customBgpIpAddress": "169.254.21.6" + } + ], + "useLocalAzureIpAddress": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "connectionMode": "Default" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayDelete.json new file mode 100644 index 000000000000..5392db9ca7c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayExecuteMigration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayExecuteMigration.json new file mode 100644 index 000000000000..21623127c575 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayExecuteMigration.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json new file mode 100644 index 000000000000..fb14cd9d9084 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": {} + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..4cae3aa7dc7e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": {} + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGet.json new file mode 100644 index 000000000000..a9b48071cc79 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGet.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGatewayMigrationStatus": { + "state": "", + "phase": "", + "errorMessage": "" + }, + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "enableHighBandwidthVpnGateway": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.1.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json new file mode 100644 index 000000000000..d3087a7e14dd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "peer": "test" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json new file mode 100644 index 000000000000..994a4459ccf3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.json new file mode 100644 index 000000000000..39033433adf1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw", + "type": "SingleSiteFailover", + "fetchLatest": "true" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": [] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json new file mode 100644 index 000000000000..467cab7003f6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw", + "peeringLocation": "Vancouver", + "failoverTestId": "fe458ae8-d2ae-4520-a104-44bc233bde7e" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": [] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetResiliencyInformation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetResiliencyInformation.json new file mode 100644 index 000000000000..006f4cf38959 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetResiliencyInformation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "attemptRefresh": true + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetRoutesInformation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetRoutesInformation.json new file mode 100644 index 000000000000..8ce8aa2ee97c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetRoutesInformation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "attemptRefresh": false + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..006e8a8a419a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json new file mode 100644 index 000000000000..bfb02f61a47d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json new file mode 100644 index 000000000000..fb2a546c8196 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceGroupName": "p2s-vnet-test", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "virtualNetworkGatewayName": "vpnp2sgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vpnConnectionId": "IKEv2_1e1cfe59-5c7c-4315-a876-b11fbfdfeed4", + "vpnConnectionDuration": 900, + "vpnConnectionTime": "2019-05-02T22:26:22", + "publicIpAddress": "167.220.2.232:45522", + "privateIpAddress": "192.168.210.2", + "vpnUserName": "gwp2schildcert", + "maxBandwidth": 240000000, + "egressPacketsTransferred": 557, + "egressBytesTransferred": 33420, + "ingressPacketsTransferred": 557, + "ingressBytesTransferred": 33420, + "maxPacketsPerSecond": 4 + }, + { + "vpnConnectionId": "IKEv2_571cfe59-2c7d-1415-e813-c51fbfdfea16", + "vpnConnectionDuration": 800, + "vpnConnectionTime": "2019-05-01T21:06:12", + "publicIpAddress": "167.220.2.232:45213", + "privateIpAddress": "192.168.210.1", + "vpnUserName": "gwp2schildcert", + "maxBandwidth": 220000000, + "egressPacketsTransferred": 357, + "egressBytesTransferred": 23420, + "ingressPacketsTransferred": 357, + "ingressBytesTransferred": 23420, + "maxPacketsPerSecond": 4 + } + ] + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayLearnedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayLearnedRoutes.json new file mode 100644 index 000000000000..994a4459ccf3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayLearnedRoutes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayList.json new file mode 100644 index 000000000000..dae2a2bab21b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayList.json @@ -0,0 +1,234 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpngw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGatewayMigrationStatus": { + "state": "", + "phase": "", + "errorMessage": "" + }, + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw1-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.14", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + }, + { + "name": "vpngw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc2", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGatewayMigrationStatus": { + "state": "", + "phase": "", + "errorMessage": "" + }, + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddress": "10.1.0.7", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw2-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule1", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/natRules/natRule2", + "etag": "W/\"00ae2b69-88e7-4b3a-b66a-cfa2244e0801\"", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "IngressSnat", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": true, + "activeActive": false, + "disableIPSecReplayProtection": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.1.0.46", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleDelete.json new file mode 100644 index 000000000000..c69f4362b7fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "virtualNetworkGatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleGet.json new file mode 100644 index 000000000000..082855f286fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkGatewayName": "gateway1", + "natRuleName": "natRule1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "100-100" + } + ], + "externalMappings": [ + { + "addressSpace": "50.4.0.0/24", + "portRange": "200-200" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleList.json new file mode 100644 index 000000000000..0e5a7e5fa67a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRuleList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualNetworkGatewayName": "gateway1", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24" + } + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRulePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRulePut.json new file mode 100644 index 000000000000..8535c63bad29 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayNatRulePut.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "natRuleName": "natRule1", + "virtualNetworkGatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "NatRuleParameters": { + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "200-300" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24", + "portRange": "300-400" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "200-300" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24", + "portRange": "300-400" + } + ] + } + } + }, + "201": { + "body": { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/natRules/natRule1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/gateway1/ipConfigurations/default", + "internalMappings": [ + { + "addressSpace": "10.4.0.0/24", + "portRange": "200-300" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.21.0/24", + "portRange": "300-400" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayPrepareMigration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayPrepareMigration.json new file mode 100644 index 000000000000..cc96db98b8c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayPrepareMigration.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "migrationParams": { + "migrationType": "UpgradeDeploymentToStandardIP", + "resourceUrl": "testUrl" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayReset.json new file mode 100644 index 000000000000..5c52dcd1e477 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayReset.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json new file mode 100644 index 000000000000..caddaeb6c251 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..806f73ea933e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "vpnclientIpsecParams": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartPacketCapture.json new file mode 100644 index 000000000000..35a32ce38289 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartPacketCapture.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..2539680b6d97 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartSiteFailoverSimulation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartSiteFailoverSimulation.json new file mode 100644 index 000000000000..b4183a60da93 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStartSiteFailoverSimulation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw", + "peeringLocation": "Vancouver" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStopPacketCapture.json new file mode 100644 index 000000000000..813fb65ba381 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStopPacketCapture.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStopSiteFailoverSimulation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStopSiteFailoverSimulation.json new file mode 100644 index 000000000000..24b3421fceae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayStopSiteFailoverSimulation.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw", + "stopParameters": { + "peeringLocation": "Vancouver", + "wasSimulationSuccessful": true, + "details": [ + { + "failoverConnectionName": "conn1", + "failoverLocation": "Denver", + "isVerified": false + }, + { + "failoverConnectionName": "conn2", + "failoverLocation": "Amsterdam", + "isVerified": true + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json new file mode 100644 index 000000000000..aa1bb4c092d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayUpdate.json new file mode 100644 index 000000000000..3c0aade96580 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayUpdate.json @@ -0,0 +1,373 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "enableHighBandwidthVpnGateway": false, + "disableIPSecReplayProtection": false, + "enableDnsForwarding": true, + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1" + }, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20, + "radiusServerSecret": "radiusServerSecret" + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "enableHighBandwidthVpnGateway": false, + "disableIPSecReplayProtection": false, + "enableDnsForwarding": true, + "inboundDnsForwardingEndpoint": "10.0.1.14", + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + }, + "201": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [ + { + "name": "natRule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule1", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "10.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "50.0.0.0/24" + } + ] + } + }, + { + "name": "natRule2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/natRules/natRule2", + "properties": { + "type": "Static", + "mode": "IngressSnat", + "ipConfigurationId": "", + "internalMappings": [ + { + "addressSpace": "20.10.0.0/24" + } + ], + "externalMappings": [ + { + "addressSpace": "30.0.0.0/24" + } + ] + } + } + ], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "enableHighBandwidthVpnGateway": false, + "disableIPSecReplayProtection": false, + "enableDnsForwarding": true, + "enablePrivateIpAddress": false, + "inboundDnsForwardingEndpoint": "10.0.1.14", + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..2dd1616574f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "natRules": [], + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + }, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json new file mode 100644 index 000000000000..36da30d398dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngw", + "parameters": { + "vendor": "Cisco", + "deviceFamily": "ISR", + "firmwareVersion": "IOS 15.1 (Preview)" + } + }, + "responses": { + "200": { + "body": "! Microsoft Corporation\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Sample VPN tunnel configuration template for IOS-based devices\r\n!\r\n! This configuration template applies to Cisco VPN devices running IOS 15.1 or beyond (ISR or ASR)\r\n!\r\n\r\n\r\n\t\t\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! ACL rules\r\n!\r\n! Some VPN devices require explicit ACL rules to allow cross-premises traffic:\r\n!\r\n! 1. Allow traffic between on premises address ranges and VNet address ranges\r\n! 2. Allow IKE traffic (UDP:500) between on premises VPN devices and Azure VPN gateway\r\n! 3. Allow IPsec traffic (Proto:ESP) between on premises VPN devices and Azure VPN gateway\r\n!\r\n\t\t\r\naccess-list 101 permit ip 10.1.0.0 0.0.255.255 10.0.0.0 0.0.255.255\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Internet Key Exchange (IKE) configuration\r\n!\r\n! This section specifies the authentication, encryption, hashing, and Diffie-Hellman group parameters for IKE\r\n! main mode or phase 1\r\n!\r\n\r\ncrypto ikev2 proposal SwaggerS2S-proposal\r\n encryption DES3\r\n integrity SHA384\r\n group DHGroup24\r\n lifetime 3600\r\n exit\r\n\r\ncrypto ikev2 policy SwaggerS2S-policy\r\n proposal SwaggerS2S-proposal\r\n exit\r\n\r\ncrypto ikev2 keyring SwaggerBranch-keyring\r\n\t\t\r\n\t\tpeer 52.173.199.254\r\n\t\taddress 52.173.199.254\r\n\t\tpre-shared-key lALEHuppeopJmA94exRNiRr2QzuZ6lOsvzu5IlJUEA6LthbTc8g5MTT86MCsGNMzGkTAaLuLnEJoD1Cn4cIlr94qKZm9drsgllzWvsPNezS71stAkaW1Bb7h6GBnDlDP\r\n exit\r\n\r\ncrypto ikev2 profile SwaggerS2S-profile\r\n match address local 10.3.0.0\r\n\tmatch identity remote address 52.173.199.254 255.255.255.255\r\n\t\t\r\n authentication remote pre-share\r\n authentication local pre-share\r\n keyring SwaggerBranch-keyring\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! IPsec configuration\r\n!\r\n! This section specifies encryption, authentication, tunnel mode properties for the Phase 2 negotiation\r\n!\r\ncrypto ipsec transform-set SwaggerS2S-TransformSet DES3 DES3\r\n mode tunnel\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Crypto map configuration\r\n!\r\n! This section defines a crypto profile that binds the cross-premises network traffic to the IPsec and IKE\r\n! policy profiles for this connection. Then defines the VTI (virtual tunnel interface) with the crypto\r\n! profile. A random interface number (tunnel 1) was used with a random link local address (169.254.0.1/28)\r\n! for the tunnel interface. If either selection is already used in the VPN device, please select another\r\n! interface number or address. The only requirement is that they must not overlap with another interface\r\n! on the same VPN device.\r\n!\r\ncrypto ipsec profile SwaggerS2S-IPsecProfile\r\n set transform-set SwaggerS2S-TransformSet\r\n set ikev2-profile SwaggerS2S-profile\r\n set pfs None\r\n set security-association lifetime 3600\r\n exit\r\n\r\n\r\nint tunnel 52.173.199.254\r\n ip address 169.254.0.1 255.255.255.252\r\n ip tcp adjust-mss 1350\r\n tunnel source 10.3.0.0\r\n tunnel mode ipsec ipv4\r\n tunnel destination 52.173.199.254\r\n tunnel protection ipsec profile SwaggerS2S-IPsecProfile\r\n exit\r\n\r\n\tip route 10.0.0.0 255.255.0.0 tunnel 52.173.199.254 " + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json new file mode 100644 index 000000000000..46d629fef64c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "vpn-gateway-test", + "virtualNetworkGatewayName": "vpngateway", + "api-version": "2025-03-01", + "request": { + "vpnConnectionIds": [ + "vpnconnId1", + "vpnconnId2" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/locations/eastus/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaysListConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaysListConnections.json new file mode 100644 index 000000000000..086684778c7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGatewaysListConnections.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "virtualNetworkGatewayName": "test-vpn-gateway-1", + "api-version": "2025-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vpn-connection", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1" + }, + "virtualNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2" + }, + "connectionType": "Vnet2Vnet", + "routingWeight": 22, + "enableBgp": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGet.json new file mode 100644 index 000000000000..22ba95ac98ae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ] + } + } + ], + "virtualNetworkPeerings": [], + "defaultPublicNatGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-ngw" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetDdosProtectionStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetDdosProtectionStatus.json new file mode 100644 index 000000000000..cc1c139b0dca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetDdosProtectionStatus.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "top": 75 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip", + "publicIpAddress": "10.0.1.5", + "isWorkloadProtected": "True", + "ddosProtectionPlanId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan" + }, + { + "publicIpAddressId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-pip2", + "publicIpAddress": "10.0.1.6", + "isWorkloadProtected": "False" + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/ddosProtectionStatus?api-version=2025-03-01" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetResourceNavigationLinks.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetResourceNavigationLinks.json new file mode 100644 index 000000000000..0ecd109dc292 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetResourceNavigationLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "vnet", + "subnetName": "subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "redisCache_redis-tester", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/resourceNavigationLinks/redisCache_redis-tester", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworks/subnets/resourceNavigationLinks", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Cache/redis", + "link": "/subscriptions/subid/resourceGroups/another-rg/providers/Microsoft.Cache/Redis/redis-tester" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetServiceAssociationLinks.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetServiceAssociationLinks.json new file mode 100644 index 000000000000..1ac961a406b2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetServiceAssociationLinks.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "vnet", + "subnetName": "subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "acisal", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/serviceAssociationLinks/acisal", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.ContainerInstance/containerGroups", + "allowDelete": true, + "locations": [ + "westus" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetWithServiceAssociationLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetWithServiceAssociationLink.json new file mode 100644 index 000000000000..246b1a2b2871 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetWithServiceAssociationLink.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.214.0/24", + "ipConfigurationProfiles": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1" + } + ], + "serviceAssociationLinks": [ + { + "name": "serviceAssociationLink1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/serviceAssociationLinks/serviceAssociationLink1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Provider/resourceType" + } + } + ], + "serviceEndpoints": [], + "delegations": [ + { + "name": "aciDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/aciDelegation", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/virtualNetworks/subnets/action" + ] + } + } + ] + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetWithSubnetDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetWithSubnetDelegation.json new file mode 100644 index 000000000000..c191e96bc434 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkGetWithSubnetDelegation.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ], + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkList.json new file mode 100644 index 000000000000..f91971ea7364 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkList.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "defaultPublicNatGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-ngw" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "defaultPublicNatGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-ngw" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkListAll.json new file mode 100644 index 000000000000..8e5f42475161 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkListAll.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "defaultPublicNatGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-ngw" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "defaultPublicNatGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-ngw" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkListUsage.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkListUsage.json new file mode 100644 index 000000000000..73c04148da4c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkListUsage.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkName": "vnetName", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": -1.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/GatewaySubnet", + "limit": -1.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/newSubnet", + "limit": 3.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringCreate.json new file mode 100644 index 000000000000..cd050c676f5b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringCreate.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json new file mode 100644 index 000000000000..dbd9c32076fc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..9a77e8ad1de3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringGet.json new file mode 100644 index 000000000000..90c1633dab47 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json new file mode 100644 index 000000000000..62bd21901825 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringList.json new file mode 100644 index 000000000000..3c44699638aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringList.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20003", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json new file mode 100644 index 000000000000..18b7045d83eb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20003", + "regionalCommunity": "12076:50004" + }, + "remoteVirtualNetworkEncryption": { + "enabled": true, + "enforcement": "AllowUnencrypted" + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringSync.json new file mode 100644 index 000000000000..f57a4ae16023 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkPeeringSync.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkScalableGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkScalableGatewayGet.json new file mode 100644 index 000000000000..33d1005514db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkScalableGatewayGet.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw" + }, + "responses": { + "200": { + "body": { + "name": "ergw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "vpnClientConfiguration": null, + "bgpSettings": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false, + "natRules": [], + "virtualNetworkGatewayPolicyGroups": [], + "adminState": "Enabled" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkScalableGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkScalableGatewayUpdate.json new file mode 100644 index 000000000000..3734aecadbf4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkScalableGatewayUpdate.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "ergw", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1" + } + ], + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "vpnClientConfiguration": null, + "bgpSettings": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false, + "natRules": [], + "virtualNetworkGatewayPolicyGroups": [], + "adminState": "Enabled" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "name": "ergw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "vpnClientConfiguration": null, + "bgpSettings": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false, + "natRules": [], + "virtualNetworkGatewayPolicyGroups": [], + "adminState": "Enabled" + } + } + }, + "201": { + "body": { + "name": "ergw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/ergw/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "gatewayType": "ExpressRoute", + "vpnType": "PolicyBased", + "enableBgp": false, + "activeActive": false, + "disableIPSecReplayProtection": false, + "enableBgpRouteTranslationForNat": false, + "sku": { + "name": "ErGwScale", + "tier": "ErGwScale" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2, + "max": 3 + } + }, + "vpnClientConfiguration": null, + "bgpSettings": null, + "allowVirtualWanTraffic": false, + "allowRemoteVnetTraffic": false, + "natRules": [], + "virtualNetworkGatewayPolicyGroups": [], + "adminState": "Enabled" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringCreate.json new file mode 100644 index 000000000000..df9e09cb853c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringCreate.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "13.0.0.0/8", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringGet.json new file mode 100644 index 000000000000..2110be0d1be5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringSync.json new file mode 100644 index 000000000000..d481ffc0a6de --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkSubnetPeeringSync.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "212.0.0.0/16", + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8", + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapCreate.json new file mode 100644 index 000000000000..b52555a6ea00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapCreate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "parameters": { + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/ipconfig1" + } + }, + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + }, + "201": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapDelete.json new file mode 100644 index 000000000000..3c7e1ab327b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/operationResults/00000000-0000-0000-0000-000000000000?api-version=2025-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/locations/centraluseuap/operations/00000000-0000-0000-0000-000000000000?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapGet.json new file mode 100644 index 000000000000..fc92beeeeb73 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "testvtap" + }, + "responses": { + "200": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapList.json new file mode 100644 index 000000000000..683f72a63442 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapListAll.json new file mode 100644 index 000000000000..e80a65b8a07e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapListAll.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapUpdateTags.json new file mode 100644 index 000000000000..0b366d1c31a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkTapUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "tapParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/test-vtap", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + }, + "type": "Microsoft.Network/virtualNetworkTaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkUpdateTags.json new file mode 100644 index 000000000000..93275f10a817 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkUpdateTags.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringCreate.json new file mode 100644 index 000000000000..a9e201be0204 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringCreate.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1", + "Subnet4" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002::/64", + "2003::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringGet.json new file mode 100644 index 000000000000..ae8a959463b2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringSync.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringSync.json new file mode 100644 index 000000000000..46a2cca86d9b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualNetworkV6SubnetPeeringSync.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "syncRemoteAddressSpace": "true", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "peerCompleteVnets": false, + "enableOnlyIPv6Peering": true, + "localSubnetNames": [ + "Subnet1" + ], + "remoteSubnetNames": [ + "Subnet2" + ], + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "localAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "localVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2002:2002::/64" + ] + }, + "remoteVirtualNetworkAddressSpace": { + "addressPrefixes": [ + "2001:2001::/64" + ] + }, + "remoteBgpCommunities": { + "virtualNetworkCommunity": "12076:20002", + "regionalCommunity": "12076:50004" + }, + "peeringState": "Initiated", + "peeringSyncLevel": "FullyInSync", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterDelete.json new file mode 100644 index 000000000000..75140d66552b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterGet.json new file mode 100644 index 000000000000..82ca3e5306ae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterListByResourceGroup.json new file mode 100644 index 000000000000..f52d1bcaf642 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterListBySubscription.json new file mode 100644 index 000000000000..0676104b56ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterListBySubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeerListAdvertisedRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeerListAdvertisedRoute.json new file mode 100644 index 000000000000..89e60ce82916 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeerListAdvertisedRoute.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "hubName": "virtualRouter1", + "connectionName": "peer1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "RouteServiceRole_IN_0": [ + { + "localAddress": "10.85.3.4", + "network": "10.45.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.85.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.100.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + } + ], + "RouteServiceRole_IN_1": [ + { + "localAddress": "10.85.3.4", + "network": "10.45.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.85.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + }, + { + "localAddress": "10.85.3.4", + "network": "10.100.0.0/16", + "nextHop": "10.85.3.4", + "sourcePeer": "10.85.3.4", + "origin": "Igp", + "asPath": "65515", + "weight": 0 + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeerListLearnedRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeerListLearnedRoute.json new file mode 100644 index 000000000000..a04dd5b24ce7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeerListLearnedRoute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "hubName": "virtualRouter1", + "connectionName": "peer1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "RouteServiceRole_IN_0": [ + { + "localAddress": "10.85.3.4", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + }, + { + "localAddress": "10.85.3.5", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + } + ], + "RouteServiceRole_IN_1": [ + { + "localAddress": "10.85.3.4", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + }, + { + "localAddress": "10.85.3.5", + "network": "10.101.0.0/16", + "nextHop": "10.85.4.4", + "sourcePeer": "10.85.4.4", + "origin": "EBgp", + "asPath": "65002-65001", + "weight": 32768 + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringDelete.json new file mode 100644 index 000000000000..85a2b7f523a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringGet.json new file mode 100644 index 000000000000..a0058a38ef9e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringList.json new file mode 100644 index 000000000000..2455de021dcd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringPut.json new file mode 100644 index 000000000000..e23ad9e65a45 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPeeringPut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter", + "parameters": { + "properties": { + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "responses": { + "200": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "201": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPut.json new file mode 100644 index 000000000000..289c01001fbc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualRouterPut.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + }, + "201": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANDelete.json new file mode 100644 index 000000000000..562a67217e23 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "VirtualWANName": "virtualWan1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWANs/{virtualWanName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANGet.json new file mode 100644 index 000000000000..9e4d631790e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + } + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANList.json new file mode 100644 index 000000000000..2630b90b30b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANList.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + } + ], + "type": "Basic" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub2" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + } + ], + "type": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANListByResourceGroup.json new file mode 100644 index 000000000000..2ec3add52519 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + } + ], + "type": "Basic" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub3" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub4" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite3" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite4" + } + ], + "type": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANPut.json new file mode 100644 index 000000000000..be75aa1c5971 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANPut.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "WANParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "disableVpnEncryption": false, + "type": "Basic" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + } + ], + "type": "Basic" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + } + ], + "vpnSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + } + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANUpdateTags.json new file mode 100644 index 000000000000..b818fbdfcd24 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWANUpdateTags.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "WANParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWanSupportedSecurityProviders.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWanSupportedSecurityProviders.json new file mode 100644 index 000000000000..b71c4f451824 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VirtualWanSupportedSecurityProviders.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "supportedProviders": [ + { + "name": "AzureFirewall", + "url": "", + "type": "Native" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceGet.json new file mode 100644 index 000000000000..146f80e3d7f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses": { + "200": { + "body": { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "dns.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceIpConfigGet.json new file mode 100644 index 000000000000..5b7c23b7b56b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceIpConfigList.json new file mode 100644 index 000000000000..e14de4e82a72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceList.json new file mode 100644 index 000000000000..0ec937148391 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssNetworkInterfaceList.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssPublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssPublicIpGet.json new file mode 100644 index 000000000000..229c15712a0d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssPublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssPublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssPublicIpListAll.json new file mode 100644 index 000000000000..605e0b831869 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssPublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssVmNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssVmNetworkInterfaceList.json new file mode 100644 index 000000000000..e4f1cbf14ebf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssVmNetworkInterfaceList.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssVmPublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssVmPublicIpList.json new file mode 100644 index 000000000000..d21f5d40ed03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VmssVmPublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionDelete.json new file mode 100644 index 000000000000..e1d6806bc954 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionGet.json new file mode 100644 index 000000000000..2d0206d2b016 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionGet.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "trafficSelectorPolicies": [], + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "ResponderOnly" + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "InitiatorOnly" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionList.json new file mode 100644 index 000000000000..19f938194240 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionList.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "trafficSelectorPolicies": [], + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionPut.json new file mode 100644 index 000000000000..64467a390bec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionPut.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VpnConnectionParameters": { + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "properties": { + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "vpnLinkConnectionMode": "Default", + "usePolicyBasedTrafficSelectors": false + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "trafficSelectorPolicies": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "trafficSelectorPolicies": [] + } + } + }, + "201": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "vpnLinkConnectionMode": "Default" + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "inboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap1" + }, + "outboundRouteMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeMaps/routeMap2" + } + }, + "trafficSelectorPolicies": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStartPacketCapture.json new file mode 100644 index 000000000000..d69d139fba5f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStartPacketCapture.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "vpnConnectionName": "vpnConnection1", + "parameters": { + "linkConnectionNames": [ + "siteLink1", + "siteLink2" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..01a860e1d51a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStartPacketCaptureFilterData.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "vpnConnectionName": "vpnConnection1", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}", + "linkConnectionNames": [ + "siteLink1", + "siteLink2" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStopPacketCapture.json new file mode 100644 index 000000000000..f3ca805e6857 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnConnectionStopPacketCapture.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "vpnConnectionName": "vpnConnection1", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D", + "linkConnectionNames": [ + "vpnSiteLink1", + "vpnSiteLink2" + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayDelete.json new file mode 100644 index 000000000000..e582cc5ec62e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayGet.json new file mode 100644 index 000000000000..9f7a99851915 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayGet.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "properties": { + "type": "Dynamic", + "mode": "IgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + }, + { + "name": "nat04", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayList.json new file mode 100644 index 000000000000..4329410d3f7a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayList.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "ingressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "properties": { + "type": "Dynamic", + "mode": "IgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "ingressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + }, + { + "name": "nat04", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat04", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link2" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..35a27b43e4b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayListByResourceGroup.json @@ -0,0 +1,277 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + }, + "type": "Microsoft.Network/vpnGateways/natRules" + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayPut.json new file mode 100644 index 000000000000..67ace68cdc44 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayPut.json @@ -0,0 +1,375 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "location": "westcentralus", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "properties": { + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "customBgpIpAddresses": [ + "169.254.21.5" + ] + }, + { + "ipconfigurationId": "Instance1", + "customBgpIpAddresses": [ + "169.254.21.10" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "ipConfigurationId": "" + } + } + ], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + } + } + ], + "isRoutingPreferenceInternet": false + } + } + }, + "201": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "egressNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03" + } + ] + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [ + { + "name": "nat03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/natRules/nat03", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "type": "Static", + "mode": "EgressSnat", + "internalMappings": [ + { + "addressSpace": "0.0.0.0/26" + } + ], + "externalMappings": [ + { + "addressSpace": "192.168.0.0/26" + } + ], + "egressVpnSiteLinkConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1" + } + ] + } + } + ], + "isRoutingPreferenceInternet": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayReset.json new file mode 100644 index 000000000000..08e93ca5dd89 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayReset.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "gatewayName": "vpngw", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStartPacketCapture.json new file mode 100644 index 000000000000..99202272d398 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStartPacketCapture.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "vpngw" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..b88cd8a11e33 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStartPacketCaptureFilterData.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "vpngw", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStopPacketCapture.json new file mode 100644 index 000000000000..4853bedb9796 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayStopPacketCapture.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "vpngw", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayUpdateTags.json new file mode 100644 index 000000000000..6bbab8df495d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnGatewayUpdateTags.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "enableBgp": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + }, + "natRules": [], + "isRoutingPreferenceInternet": false, + "enableBgpRouteTranslationForNat": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationDelete.json new file mode 100644 index 000000000000..214cc518bf16 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationGet.json new file mode 100644 index 000000000000..9b8ec4d4b4e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationGet.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationList.json new file mode 100644 index 000000000000..39253ded3cb6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationList.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnServerConfiguration2", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationListByResourceGroup.json new file mode 100644 index 000000000000..0b28a0760945 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationListByResourceGroup.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration2", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationPut.json new file mode 100644 index 000000000000..9ace0e0db311 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationPut.json @@ -0,0 +1,304 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VpnServerConfigurationParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25, + "radiusServerSecret": "radiusServerSecret" + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationUpdateTags.json new file mode 100644 index 000000000000..c7198a7072d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnServerConfigurationUpdateTags.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VpnServerConfigurationParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "configurationPolicyGroups": [ + { + "name": "policyGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy1", + "attributeType": "RadiusAzureGroupId", + "attributeValue": "6ad1bd08" + } + ], + "p2SConnectionConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1" + } + ] + } + }, + { + "name": "policyGroup2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1/vpnServerConfigurationPolicyGroups/policyGroup2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "isDefault": true, + "priority": 0, + "policyMembers": [ + { + "name": "policy2", + "attributeType": "CertificateGroupId", + "attributeValue": "red.com" + } + ] + } + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteDelete.json new file mode 100644 index 000000000000..e824dcc65b3c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{siteName}/operationResults/{operationId}?api-version={api-version}" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteGet.json new file mode 100644 index 000000000000..10d23bea2f35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyGet.json new file mode 100644 index 000000000000..24750b91e78f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default", + "type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys", + "properties": { + "sharedKeyLength": 16 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyList.json new file mode 100644 index 000000000000..0834fffeb3c3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default", + "type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys", + "properties": { + "sharedKey": "AzureAbc1234", + "sharedKeyLength": 12 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyPut.json new file mode 100644 index 000000000000..23260ee6c979 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionDefaultSharedKeyPut.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1", + "ConnectionSharedKeyParameters": { + "properties": { + "sharedKey": "ABCDEF123456" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default", + "type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys", + "properties": { + "sharedKeyLength": 12 + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default", + "type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys", + "properties": { + "sharedKeyLength": 12 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionGet.json new file mode 100644 index 000000000000..56aaefd75dce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "vpnGatewayCustomBgpAddresses": [ + { + "ipConfigurationId": "Instance0", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "Instance1", + "customBgpIpAddress": "169.254.21.3" + } + ], + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "dpdTimeoutSeconds": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionGetIkeSas.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionGetIkeSas.json new file mode 100644 index 000000000000..c8bc449c7e0a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionGetIkeSas.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/westus/operationResults/{operationId}?api-version=2025-03-01" + } + }, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionList.json new file mode 100644 index 000000000000..d6591625d6e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "connectionName": "vpnConnection1" + }, + "responses": { + "200": { + "body": [ + { + "name": "Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "vpnGatewayCustomBgpAddresses": [ + { + "ipConfigurationId": "Instance0", + "customBgpIpAddress": "169.254.21.1" + }, + { + "ipConfigurationId": "Instance1", + "customBgpIpAddress": "169.254.21.3" + } + ], + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0, + "dpdTimeoutSeconds": 0 + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionReset.json new file mode 100644 index 000000000000..747c11910921 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionReset.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionSharedKeysGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionSharedKeysGet.json new file mode 100644 index 000000000000..a12986493cfc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkConnectionSharedKeysGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/vpnLinkConnections/Connection-Link1/sharedKeys/default", + "type": "Microsoft.Network/vpnGateways/vpnConnections/vpnLinkConnections/sharedKeys", + "properties": { + "sharedKeyLength": 16 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkGet.json new file mode 100644 index 000000000000..9fa97841c3e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "vpnSiteLinkName": "vpnSiteLink1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkListByVpnSite.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkListByVpnSite.json new file mode 100644 index 000000000000..5dffd6991f40 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteLinkListByVpnSite.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "vpnSiteName": "vpnSite1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 200 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "name": "vpnSiteLink2", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.40.40.46", + "linkProperties": { + "linkSpeedInMbps": 200 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.1", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteList.json new file mode 100644 index 000000000000..71758eeac383 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + }, + "isSecuritySite": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteListByResourceGroup.json new file mode 100644 index 000000000000..6674ebfd6fc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteListByResourceGroup.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSitePut.json new file mode 100644 index 000000000000..f19c0689c529 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSitePut.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "properties": { + "ipAddress": "50.50.50.56", + "fqdn": "link1.vpnsite1.contoso.com", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ], + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": false + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteUpdateTags.json new file mode 100644 index 000000000000..c63544ebdfdd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSiteUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSitesConfigurationDownload.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSitesConfigurationDownload.json new file mode 100644 index 000000000000..ba93944d8929 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/VpnSitesConfigurationDownload.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2025-03-01", + "virtualWANName": "wan1", + "request": { + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/operationResults/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafListAllPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafListAllPolicies.json new file mode 100644 index 000000000000..81bedd0c1414 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafListAllPolicies.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": "*" + } + ] + } + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "computedDisabledRules": [ + { + "ruleGroupName": "General", + "rules": [ + "200003" + ] + } + ] + } + ], + "exceptions": [ + { + "matchVariable": "RequestURI", + "valueMatchOperator": "Contains", + "values": [ + "health", + "account/images", + "default.aspx" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + { + "matchVariable": "RequestHeader", + "selectorMatchOperator": "StartsWith", + "selector": "User-Agent", + "valueMatchOperator": "Contains", + "values": [ + "Mozilla/5.0", + "Chrome/122.0.0.0" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RemoteAddr", + "values": [ + "1.2.3.4", + "10.0.0.1/6" + ], + "valueMatchOperator": "IPMatch", + "exceptionManagedRuleSets": [ + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "BadBots", + "rules": [ + { + "ruleId": "100100" + } + ] + } + ] + } + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafListPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..4e0d4a4a022c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafListPolicies.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "computedDisabledRules": [ + { + "ruleGroupName": "General", + "rules": [ + "200003" + ] + } + ] + } + ], + "exceptions": [ + { + "matchVariable": "RequestURI", + "valueMatchOperator": "Contains", + "values": [ + "health", + "account/images", + "default.aspx" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + { + "matchVariable": "RequestHeader", + "selectorMatchOperator": "StartsWith", + "selector": "User-Agent", + "valueMatchOperator": "Contains", + "values": [ + "Mozilla/5.0", + "Chrome/122.0.0.0" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RemoteAddr", + "values": [ + "1.2.3.4", + "10.0.0.1/6" + ], + "valueMatchOperator": "IPMatch", + "exceptionManagedRuleSets": [ + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "BadBots", + "rules": [ + { + "ruleId": "100100" + } + ] + } + ] + } + ] + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..7e835eac33b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,990 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1", + "parameters": { + "location": "WestUs", + "properties": { + "policySettings": { + "jsChallengeCookieExpirationInMins": 100, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-931-APPLICATION-ATTACK-RFI", + "rules": [ + { + "ruleId": "931120", + "state": "Enabled", + "action": "Log" + }, + { + "ruleId": "931130", + "state": "Disabled", + "action": "AnomalyScoring" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_HTTPDDoSRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "ExcessiveRequests", + "rules": [ + { + "ruleId": "500100", + "state": "Enabled", + "action": "Block", + "sensitivity": "High" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "test" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "test" + } + ], + "exceptions": [ + { + "matchVariable": "RequestURI", + "valueMatchOperator": "Contains", + "values": [ + "health", + "account/images", + "default.aspx" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + { + "matchVariable": "RequestHeader", + "selectorMatchOperator": "StartsWith", + "selector": "User-Agent", + "valueMatchOperator": "Contains", + "values": [ + "Mozilla/5.0", + "Chrome/122.0.0.0" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RemoteAddr", + "values": [ + "1.2.3.4", + "10.0.0.1/6" + ], + "valueMatchOperator": "IPMatch", + "exceptionManagedRuleSets": [ + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "BadBots", + "rules": [ + { + "ruleId": "100100" + } + ] + } + ] + } + ] + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "action": "Block", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ] + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "jsChallengeCookieExpirationInMins": 100, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-931-APPLICATION-ATTACK-RFI", + "rules": [ + { + "ruleId": "931120", + "state": "Enabled", + "action": "Log" + }, + { + "ruleId": "931130", + "state": "Disabled", + "action": "AnomalyScoring" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_HTTPDDoSRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "ExcessiveRequests", + "rules": [ + { + "ruleId": "500100", + "state": "Enabled", + "action": "Block", + "sensitivity": "High" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "test" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "test" + } + ], + "exceptions": [ + { + "matchVariable": "RequestURI", + "valueMatchOperator": "Contains", + "values": [ + "health", + "account/images", + "default.aspx" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + { + "matchVariable": "RequestHeader", + "selectorMatchOperator": "StartsWith", + "selector": "User-Agent", + "valueMatchOperator": "Contains", + "values": [ + "Mozilla/5.0", + "Chrome/122.0.0.0" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RemoteAddr", + "values": [ + "1.2.3.4", + "10.0.0.1/6" + ], + "valueMatchOperator": "IPMatch", + "exceptionManagedRuleSets": [ + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "BadBots", + "rules": [ + { + "ruleId": "100100" + } + ] + } + ] + } + ] + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ] + } + } + }, + "201": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "jsChallengeCookieExpirationInMins": 100 + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-931-APPLICATION-ATTACK-RFI", + "rules": [ + { + "ruleId": "931120", + "state": "Enabled", + "action": "Log" + }, + { + "ruleId": "931130", + "state": "Disabled", + "action": "AnomalyScoring" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_HTTPDDoSRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "ExcessiveRequests", + "rules": [ + { + "ruleId": "500100", + "state": "Enabled", + "action": "Block", + "sensitivity": "High" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "test" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "test" + } + ], + "exceptions": [ + { + "matchVariable": "RequestURI", + "valueMatchOperator": "Contains", + "values": [ + "health", + "account/images", + "default.aspx" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + { + "matchVariable": "RequestHeader", + "selectorMatchOperator": "StartsWith", + "selector": "User-Agent", + "valueMatchOperator": "Contains", + "values": [ + "Mozilla/5.0", + "Chrome/122.0.0.0" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RemoteAddr", + "values": [ + "1.2.3.4", + "10.0.0.1/6" + ], + "valueMatchOperator": "IPMatch", + "exceptionManagedRuleSets": [ + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "BadBots", + "rules": [ + { + "ruleId": "100100" + } + ] + } + ] + } + ] + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..93c5a44ed396 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1?api-version=2025-03-01" + } + }, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..13206d6adea1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/WafPolicyGet.json @@ -0,0 +1,409 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "requestBodyEnforcement": true, + "maxRequestBodySizeInKb": 2000, + "requestBodyInspectLimitInKB": 2000, + "fileUploadEnforcement": true, + "fileUploadLimitInMb": 4000, + "requestBodyCheck": true, + "customBlockResponseStatusCode": 405, + "customBlockResponseBody": "SGVsbG8=", + "jsChallengeCookieExpirationInMins": 100, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "state": "Enabled", + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "Equals", + "selector": "test" + }, + { + "state": "Enabled", + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny" + } + ] + } + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + }, + { + "name": "RateLimitRule3", + "priority": 3, + "rateLimitDuration": "OneMin", + "rateLimitThreshold": 10, + "ruleType": "RateLimitRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "groupByUserSession": [ + { + "groupByVariables": [ + { + "variableName": "ClientAddr" + } + ] + } + ], + "action": "Block" + }, + { + "name": "Rule4", + "priority": 4, + "state": "Enabled", + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Bot" + ] + } + ], + "action": "JSChallenge" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-942-APPLICATION-ATTACK-SQLI", + "rules": [ + { + "ruleId": "942130", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "942110", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "942140", + "state": "Enabled", + "action": "Log" + } + ] + }, + { + "ruleGroupName": "REQUEST-920-PROTOCOL-ENFORCEMENT", + "rules": [ + { + "ruleId": "920100", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "920120", + "state": "Disabled", + "action": "AnomalyScoring" + }, + { + "ruleId": "920130", + "state": "Enabled", + "action": "Block" + } + ] + } + ], + "computedDisabledRules": [ + { + "ruleGroupName": "REQUEST-942-APPLICATION-ATTACK-SQLI", + "rules": [ + "942130", + "942110" + ] + }, + { + "ruleGroupName": "REQUEST-920-PROTOCOL-ENFORCEMENT", + "rules": [ + "920100", + "920120" + ] + }, + { + "ruleGroupName": "General", + "rules": [ + "200003" + ] + } + ] + }, + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "UnknownBots", + "rules": [ + { + "ruleId": "300700", + "state": "Enabled", + "action": "JSChallenge" + } + ] + } + ] + }, + { + "ruleSetType": "Microsoft_HTTPDDoSRuleSet", + "ruleSetVersion": "1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "ExcessiveRequests", + "rules": [ + { + "ruleId": "500100", + "state": "Enabled", + "action": "Block", + "sensitivity": "High" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "testHeader1" + }, + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "StartsWith", + "selector": "testHeader2" + }, + { + "matchVariable": "RequestArgValues", + "selectorMatchOperator": "StartsWith", + "selector": "hello" + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "StartsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-930-APPLICATION-ATTACK-LFI", + "rules": [ + { + "ruleId": "930120" + } + ] + }, + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RequestArgNames", + "selectorMatchOperator": "EndsWith", + "selector": "hello", + "exclusionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.1", + "ruleGroups": [] + } + ] + } + ], + "exceptions": [ + { + "matchVariable": "RequestURI", + "valueMatchOperator": "Contains", + "values": [ + "health", + "account/images", + "default.aspx" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2" + } + ] + }, + { + "matchVariable": "RequestHeader", + "selectorMatchOperator": "StartsWith", + "selector": "User-Agent", + "valueMatchOperator": "Contains", + "values": [ + "Mozilla/5.0", + "Chrome/122.0.0.0" + ], + "exceptionManagedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.2", + "ruleGroups": [ + { + "ruleGroupName": "REQUEST-932-APPLICATION-ATTACK-RCE" + } + ] + } + ] + }, + { + "matchVariable": "RemoteAddr", + "values": [ + "1.2.3.4", + "10.0.0.1/6" + ], + "valueMatchOperator": "IPMatch", + "exceptionManagedRuleSets": [ + { + "ruleSetType": "Microsoft_BotManagerRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "BadBots", + "rules": [ + { + "ruleId": "100100" + } + ] + } + ] + } + ] + } + ] + }, + "applicationGatewayForContainers": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/agc1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/expressRouteProviderPort.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/expressRouteProviderPort.json new file mode 100644 index 000000000000..13ffdbbcc92b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/expressRouteProviderPort.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "locationName": "SiliconValley", + "subscriptionId": "subid", + "providerport": "abc" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1", + "type": "Microsoft.Network/expressRouteProviderPort", + "location": "uswest", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "portPairDescriptor": "bvtazureixpportpair1", + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "peeringLocation": "SiliconValley", + "overprovisionFactor": 4, + "portBandwidthInMbps": 4000, + "usedBandwidthInMbps": 2500, + "remainingBandwidthInMbps": 1500 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/expressRouteProviderPortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/expressRouteProviderPortList.json new file mode 100644 index 000000000000..266bd0076096 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/examples/expressRouteProviderPortList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2025-03-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair1", + "type": "Microsoft.Network/expressRouteProviderPort", + "location": "uswest", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "portPairDescriptor": "bvtazureixpportpair1", + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "peeringLocation": "SiliconValley", + "overprovisionFactor": 4, + "portBandwidthInMbps": 4000, + "usedBandwidthInMbps": 2500, + "remainingBandwidthInMbps": 1500 + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Network/ExpressRoutePortsLocations/SiliconValley/bvtazureixpportpair2", + "type": "Microsoft.Network/expressRouteProviderPort", + "location": "uswest", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "portPairDescriptor": "bvtazureixpportpair2", + "primaryAzurePort": "bvtazureixp02", + "secondaryAzurePort": "bvtazureixp02", + "peeringLocation": "seattle", + "overprovisionFactor": 4, + "portBandwidthInMbps": 4000, + "usedBandwidthInMbps": 1200, + "remainingBandwidthInMbps": 1800 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteCircuit.json new file mode 100644 index 000000000000..bc6a957b4e5c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteCircuit.json @@ -0,0 +1,2572 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "Parameters supplied to the create or update express route circuit authorization operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations": { + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_List", + "description": "Gets all authorizations in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitAuthorization resources.", + "schema": { + "$ref": "#/definitions/AuthorizationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Delete", + "description": "Deletes the specified peering from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Get", + "description": "Gets the specified peering for the express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Peering": { + "$ref": "./examples/ExpressRouteCircuitPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "Parameters supplied to the create or update express route circuit peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_List", + "description": "Gets all peerings in a specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Delete", + "description": "Deletes the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Get", + "description": "Gets the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionGet": { + "$ref": "./examples/ExpressRouteCircuitConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_CreateOrUpdate", + "description": "Creates or updates a Express Route Circuit Connection in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "name": "expressRouteCircuitConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "Parameters supplied to the create or update express route circuit connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionCreate": { + "$ref": "./examples/ExpressRouteCircuitConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections": { + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_List", + "description": "Gets all global reach connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Connection": { + "$ref": "./examples/ExpressRouteCircuitConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}": { + "get": { + "tags": [ + "PeerExpressRouteCircuitConnections" + ], + "operationId": "PeerExpressRouteCircuitConnections_Get", + "description": "Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peer express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Peer Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PeerExpressRouteCircuitConnectionGet": { + "$ref": "./examples/PeerExpressRouteCircuitConnectionGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections": { + "get": { + "tags": [ + "PeerExpressRouteCircuitConnections" + ], + "operationId": "PeerExpressRouteCircuitConnections_List", + "description": "Gets all global reach peer connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PeerExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Peer ExpressRouteCircuit Connection": { + "$ref": "./examples/PeerExpressRouteCircuitConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { + "delete": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Delete", + "description": "Deletes the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Disabling' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Get", + "description": "Gets information about the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_CreateOrUpdate", + "description": "Creates or updates an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "Parameters supplied to the create or update express route circuit operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitCreate.json" + }, + "Create ExpressRouteCircuit on ExpressRoutePort": { + "$ref": "./examples/ExpressRouteCircuitCreateOnExpressRoutePort.json" + } + } + }, + "patch": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_UpdateTags", + "description": "Updates an express route circuit tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route circuit tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Express Route Circuit Tags": { + "$ref": "./examples/ExpressRouteCircuitUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitArpTable" + ], + "operationId": "ExpressRouteCircuits_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsArpTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List ARP Table": { + "$ref": "./examples/ExpressRouteCircuitARPTableList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTable" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRouteTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List Route Tables": { + "$ref": "./examples/ExpressRouteCircuitRouteTableList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTableSummary" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", + "description": "Gets the currently advertised routes table summary associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRoutesTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List Route Table Summary": { + "$ref": "./examples/ExpressRouteCircuitRouteTableSummaryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetStats", + "description": "Gets all the stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Traffic Stats": { + "$ref": "./examples/ExpressRouteCircuitStats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetPeeringStats", + "description": "Gets all stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Peering Traffic Stats": { + "$ref": "./examples/ExpressRouteCircuitPeeringStats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_List", + "description": "Gets all the express route circuits in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a resource group": { + "$ref": "./examples/ExpressRouteCircuitListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_ListAll", + "description": "Gets all the express route circuits in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuit resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a subscription": { + "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders": { + "get": { + "tags": [ + "ExpressRouteServiceProviders" + ], + "operationId": "ExpressRouteServiceProviders_List", + "description": "Gets all the available express route service providers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteServiceProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoute providers": { + "$ref": "./examples/ExpressRouteProviderList.json" + } + } + } + } + }, + "definitions": { + "AuthorizationPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "type": "string", + "description": "The authorization use status.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "AuthorizationUseStatus", + "modelAsString": true + } + }, + "connectionResourceUri": { + "readOnly": true, + "type": "string", + "description": "The reference to the ExpressRoute connection resource using the authorization." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authorization resource." + } + }, + "description": "Properties of ExpressRouteCircuitAuthorization." + }, + "ExpressRouteCircuitAuthorization": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationPropertiesFormat", + "description": "Properties of the express route circuit authorization." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authorization in an ExpressRouteCircuit resource." + }, + "AuthorizationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The authorizations in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit." + }, + "AdvertisedPublicPrefixProperties": { + "type": "object", + "properties": { + "prefix": { + "type": "string", + "description": "Advertised Public Prefix." + }, + "validationId": { + "type": "string", + "description": "Validation string that contains circuit peering info." + }, + "signature": { + "type": "string", + "description": "Signed string generated by encrypting validationId with a private key." + }, + "validationState": { + "readOnly": true, + "type": "string", + "description": "Advertised Public Prefix State that denotes if the prefix is validated or not.", + "enum": [ + "NotConfigured", + "Configuring", + "Configured", + "ValidationNeeded", + "ValidationFailed", + "ManualValidationNeeded", + "AsnValidationFailed", + "CertificateMissingInRoutingRegistry", + "InvalidSignatureEncoding", + "SignatureVerificationFailed" + ], + "x-ms-enum": { + "name": "AdvertisedPublicPrefixPropertiesValidationState", + "modelAsString": true + } + } + }, + "description": "Prefix properties required to perform validation using openssl signature." + }, + "ExpressRouteCircuitPeeringConfig": { + "properties": { + "advertisedPublicPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The reference to AdvertisedPublicPrefixes." + }, + "advertisedCommunities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The communities of bgp peering. Specified for microsoft peering." + }, + "advertisedPublicPrefixesState": { + "readOnly": true, + "type": "string", + "description": "The advertised public prefix state of the Peering resource.", + "enum": [ + "NotConfigured", + "Configuring", + "Configured", + "ValidationNeeded" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", + "modelAsString": true + } + }, + "legacyMode": { + "type": "integer", + "format": "int32", + "description": "The legacy mode of the peering." + }, + "customerASN": { + "type": "integer", + "format": "int32", + "description": "The CustomerASN of the peering." + }, + "routingRegistryName": { + "type": "string", + "description": "The RoutingRegistryName of the configuration." + }, + "advertisedPublicPrefixInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/AdvertisedPublicPrefixProperties" + }, + "x-ms-identifiers": [], + "description": "List of Prefix information required to perform validation." + } + }, + "description": "Specifies the peering configuration." + }, + "Ipv6ExpressRouteCircuitPeeringConfig": { + "properties": { + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "routeFilter": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the RouteFilter resource." + }, + "state": { + "type": "string", + "description": "The state of peering.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringState", + "modelAsString": true + } + } + }, + "description": "Contains IPv6 peering config." + }, + "ExpressRouteCircuitStats": { + "properties": { + "primarybytesIn": { + "type": "integer", + "format": "int64", + "description": "The Primary BytesIn of the peering." + }, + "primarybytesOut": { + "type": "integer", + "format": "int64", + "description": "The primary BytesOut of the peering." + }, + "secondarybytesIn": { + "type": "integer", + "format": "int64", + "description": "The secondary BytesIn of the peering." + }, + "secondarybytesOut": { + "type": "integer", + "format": "int64", + "description": "The secondary BytesOut of the peering." + } + }, + "description": "Contains stats associated with the peering." + }, + "ExpressRouteCircuitPeeringPropertiesFormat": { + "properties": { + "peeringType": { + "$ref": "#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "stats": { + "$ref": "#/definitions/ExpressRouteCircuitStats", + "description": "The peering stats of express route circuit." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit peering resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "readOnly": true, + "type": "string", + "description": "Who was the last to modify the peering." + }, + "routeFilter": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the RouteFilter resource." + }, + "ipv6PeeringConfig": { + "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + }, + "expressRouteConnection": { + "$ref": "./virtualWan.json#/definitions/ExpressRouteConnectionId", + "description": "The ExpressRoute connection." + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The list of circuit connections associated with Azure Private Peering for this circuit." + }, + "peeredConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + }, + "readOnly": true, + "description": "The list of peered circuit connections associated with Azure Private Peering for this circuit." + } + }, + "description": "Properties of the express route circuit peering." + }, + "ExpressRouteCircuitPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat", + "description": "Properties of the express route circuit peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The peerings in an express route circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit." + }, + "ExpressRoutePeeringType": { + "type": "string", + "description": "The peering type.", + "enum": [ + "AzurePublicPeering", + "AzurePrivatePeering", + "MicrosoftPeering" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringType", + "modelAsString": true + } + }, + "ExpressRoutePeeringState": { + "type": "string", + "description": "The state of peering.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringState", + "modelAsString": true + } + }, + "Ipv6CircuitConnectionConfig": { + "description": "IPv6 Circuit Connection properties for global reach.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "/125 IP address space to carve out customer addresses for global reach." + }, + "circuitConnectionStatus": { + "readOnly": true, + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + } + } + }, + "ExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "ipv6CircuitConnectionConfig": { + "$ref": "#/definitions/Ipv6CircuitConnectionConfig", + "description": "IPv6 Address PrefixProperties of the express route circuit connection." + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit connection resource." + } + }, + "description": "Properties of the express route circuit connection." + }, + "ExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the express route circuit connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "ExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The global reach connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, + "PeerExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + }, + "connectionName": { + "type": "string", + "description": "The name of the express route circuit connection resource." + }, + "authResourceGuid": { + "type": "string", + "description": "The resource guid of the authorization used for the express route circuit connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the peer express route circuit connection resource." + } + }, + "description": "Properties of the peer express route circuit connection." + }, + "PeerExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the peer express route circuit connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "PeerExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + }, + "description": "The global reach peer circuit connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeeredConnections API service call retrieves all global reach peer circuit connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, + "ExpressRouteCircuitSku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU." + }, + "tier": { + "type": "string", + "description": "The tier of the SKU.", + "enum": [ + "Standard", + "Premium", + "Basic", + "Local" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuTier", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The family of the SKU.", + "enum": [ + "UnlimitedData", + "MeteredData" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuFamily", + "modelAsString": true + } + } + }, + "description": "Contains SKU in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitServiceProviderProperties": { + "properties": { + "serviceProviderName": { + "type": "string", + "description": "The serviceProviderName." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The BandwidthInMbps." + } + }, + "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPropertiesFormat": { + "properties": { + "allowClassicOperations": { + "type": "boolean", + "description": "Allow classic operations." + }, + "circuitProvisioningState": { + "type": "string", + "description": "The CircuitProvisioningState state of the resource." + }, + "serviceProviderProvisioningState": { + "$ref": "#/definitions/ServiceProviderProvisioningState", + "description": "The ServiceProviderProvisioningState state of the resource." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The list of authorizations." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The list of peerings." + }, + "serviceKey": { + "type": "string", + "description": "The ServiceKey." + }, + "serviceProviderNotes": { + "type": "string", + "description": "The ServiceProviderNotes." + }, + "serviceProviderProperties": { + "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", + "description": "The ServiceProviderProperties." + }, + "expressRoutePort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource." + }, + "bandwidthInGbps": { + "type": "number", + "description": "The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource." + }, + "stag": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The identifier of the circuit traffic. Outer tag for QinQ encapsulation." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "globalReachEnabled": { + "type": "boolean", + "description": "Flag denoting global reach status." + }, + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "authorizationStatus": { + "readOnly": true, + "type": "string", + "description": "The authorization status of the Circuit." + }, + "enableDirectPortRateLimit": { + "type": "boolean", + "description": "Flag denoting rate-limiting status of the ExpressRoute direct-port circuit." + } + }, + "description": "Properties of ExpressRouteCircuit." + }, + "ExpressRouteCircuit": { + "properties": { + "sku": { + "$ref": "#/definitions/ExpressRouteCircuitSku", + "description": "The SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat", + "description": "Properties of the express route circuit." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitArpTable": { + "properties": { + "age": { + "type": "integer", + "format": "int32", + "description": "Entry age in minutes." + }, + "interface": { + "type": "string", + "description": "Interface address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address." + }, + "macAddress": { + "type": "string", + "description": "The MAC address." + } + }, + "description": "The ARP table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsArpTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitArpTable" + }, + "description": "A list of the ARP tables." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListArpTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTable": { + "properties": { + "network": { + "type": "string", + "description": "IP address of a network entity." + }, + "nextHop": { + "type": "string", + "description": "NextHop address." + }, + "locPrf": { + "type": "string", + "description": "Local preference value as set with the set local-preference route-map configuration command." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "Route Weight." + }, + "path": { + "type": "string", + "description": "Autonomous system paths to the destination network." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTable" + }, + "description": "The list of routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of the neighbor." + }, + "v": { + "type": "integer", + "format": "int32", + "description": "BGP version number spoken to the neighbor." + }, + "as": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "statePfxRcd": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "A list of ExpressRouteCircuits in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCircuit API service call." + }, + "ExpressRouteServiceProviderBandwidthsOffered": { + "properties": { + "offerName": { + "type": "string", + "description": "The OfferName." + }, + "valueInMbps": { + "type": "integer", + "format": "int32", + "description": "The ValueInMbps." + } + }, + "description": "Contains bandwidths offered in ExpressRouteServiceProvider resources." + }, + "ExpressRouteServiceProviderPropertiesFormat": { + "properties": { + "peeringLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of peering locations." + }, + "bandwidthsOffered": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProviderBandwidthsOffered" + }, + "description": "A list of bandwidths offered." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route service provider resource." + } + }, + "description": "Properties of ExpressRouteServiceProvider." + }, + "ExpressRouteServiceProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat", + "description": "Properties of the express route service provider." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A ExpressRouteResourceProvider object." + }, + "ExpressRouteServiceProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProvider" + }, + "description": "A list of ExpressRouteResourceProvider resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListExpressRouteServiceProvider API service call." + }, + "CircuitConnectionStatus": { + "type": "string", + "readOnly": true, + "description": "Express Route Circuit connection state.", + "enum": [ + "Connected", + "Connecting", + "Disconnected" + ], + "x-ms-enum": { + "name": "CircuitConnectionStatus", + "modelAsString": true + } + }, + "ServiceProviderProvisioningState": { + "type": "string", + "description": "The ServiceProviderProvisioningState state of the resource.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteCrossConnection.json new file mode 100644 index 000000000000..60b14f55d878 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteCrossConnection.json @@ -0,0 +1,1016 @@ +{ + "swagger": "2.0", + "info": { + "title": "ExpressRouteCrossConnection REST APIs", + "description": "The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit.", + "version": "2025-03-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}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_List", + "description": "Retrieves all the ExpressRouteCrossConnections in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=name eq '{circuitServiceKey}'.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionList": { + "$ref": "./examples/ExpressRouteCrossConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_ListByResourceGroup", + "description": "Retrieves all the ExpressRouteCrossConnections in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionListByResourceGroup": { + "$ref": "./examples/ExpressRouteCrossConnectionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_Get", + "description": "Gets details about the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group (peering location of the circuit)." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection (service key of the circuit)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_CreateOrUpdate", + "description": "Update the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "Parameters supplied to the update express route crossConnection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_UpdateTags", + "description": "Updates an express route cross connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cross connection." + }, + { + "name": "crossConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route cross connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnectionTags": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_List", + "description": "Gets all peerings in a specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringList": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Delete", + "description": "Deletes the specified peering from the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Get", + "description": "Gets the specified peering for the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "Parameters supplied to the create or update ExpressRouteCrossConnection peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringCreate": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionArpTable" + ], + "operationId": "ExpressRouteCrossConnections_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsArpTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsArpTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsArpTable.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTableSummary" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTableSummary", + "description": "Gets the route table summary associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTableSummary": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTableSummary.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTable" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTable.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ExpressRouteCrossConnectionRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of Neighbor router." + }, + "asn": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "stateOrPrefixesReceived": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCrossConnectionsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Cross Connections." + }, + "ExpressRouteCircuitReference": { + "properties": { + "id": { + "type": "string", + "description": "Corresponding Express Route Circuit Id." + } + }, + "description": "Reference to an express route circuit." + }, + "ExpressRouteCrossConnectionProperties": { + "properties": { + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "sTag": { + "readOnly": true, + "type": "integer", + "description": "The identifier of the circuit traffic." + }, + "peeringLocation": { + "readOnly": true, + "type": "string", + "description": "The peering location of the ExpressRoute circuit." + }, + "bandwidthInMbps": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The circuit bandwidth In Mbps." + }, + "expressRouteCircuit": { + "$ref": "#/definitions/ExpressRouteCircuitReference", + "description": "The ExpressRouteCircuit." + }, + "serviceProviderProvisioningState": { + "$ref": "./expressRouteCircuit.json#/definitions/ServiceProviderProvisioningState", + "description": "The provisioning state of the circuit in the connectivity provider system." + }, + "serviceProviderNotes": { + "type": "string", + "description": "Additional read only notes set by the connectivity provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route cross connection resource." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The list of peerings." + } + }, + "description": "Properties of ExpressRouteCrossConnection." + }, + "ExpressRouteCrossConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionProperties", + "description": "Properties of the express route cross connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCrossConnection resource." + }, + "ExpressRouteCrossConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "A list of ExpressRouteCrossConnection resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCrossConnection API service call." + }, + "ExpressRouteCrossConnectionPeeringProperties": { + "properties": { + "peeringType": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route cross connection peering resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "readOnly": true, + "type": "string", + "description": "Who was the last to modify the peering." + }, + "ipv6PeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + } + }, + "description": "Properties of express route cross connection peering." + }, + "ExpressRouteCrossConnectionPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties", + "description": "Properties of the express route cross connection peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRoute Cross Connection resource." + }, + "ExpressRouteCrossConnectionPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The peerings in an express route cross connection." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRoutePort.json new file mode 100644 index 000000000000..a50c1d05c34d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRoutePort.json @@ -0,0 +1,1330 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/ExpressRoutePortsLocations": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_List", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all ExpressRoutePort peering locations.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortsLocationList": { + "$ref": "./examples/ExpressRoutePortsLocationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_Get", + "description": "Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the requested ExpressRoutePort peering location." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort peering location.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortsLocationGet": { + "$ref": "./examples/ExpressRoutePortsLocationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}": { + "delete": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Delete", + "description": "Deletes the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ExpressRoutePortDelete": { + "$ref": "./examples/ExpressRoutePortDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Get", + "description": "Retrieves the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortGet": { + "$ref": "./examples/ExpressRoutePortGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_CreateOrUpdate", + "description": "Creates or updates the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "Parameters supplied to the create ExpressRoutePort operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ExpressRoutePortCreate": { + "$ref": "./examples/ExpressRoutePortCreate.json" + }, + "ExpressRoutePortUpdateLink": { + "$ref": "./examples/ExpressRoutePortUpdateLink.json" + } + } + }, + "patch": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_UpdateTags", + "description": "Update ExpressRoutePort tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update ExpressRoutePort resource tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortUpdateTags": { + "$ref": "./examples/ExpressRoutePortUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_ListByResourceGroup", + "description": "List all the ExpressRoutePort resources in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortListByResourceGroup": { + "$ref": "./examples/ExpressRoutePortListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_List", + "description": "List all the ExpressRoutePort resources in the specified subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortList": { + "$ref": "./examples/ExpressRoutePortList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_Get", + "description": "Retrieves the specified ExpressRouteLink resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteLink resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRouteLink resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { + "$ref": "./examples/ExpressRouteLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_List", + "description": "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteLink resources. If there are no ExpressRouteLink resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { + "$ref": "./examples/ExpressRouteLinkList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/generateLoa": { + "post": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_GenerateLOA", + "description": "Generate a letter of authorization for the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateExpressRoutePortsLOARequest" + }, + "description": "Request parameters supplied to generate a letter of authorization." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the content as a base64 encoded string.", + "schema": { + "$ref": "#/definitions/GenerateExpressRoutePortsLOAResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateExpressRoutePortLOA": { + "$ref": "./examples/GenerateExpressRoutePortsLOA.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRoutePortAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + }, + "description": "Parameters supplied to the create or update express route port authorization operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePortAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePortAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRoutePorts/{expressRoutePortName}/authorizations": { + "get": { + "tags": [ + "ExpressRoutePortAuthorizations" + ], + "operationId": "ExpressRoutePortAuthorizations_List", + "description": "Gets all authorizations in an express route port.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route port." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePortAuthorization resources.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortAuthorizationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoutePort Authorization": { + "$ref": "./examples/ExpressRoutePortAuthorizationList.json" + } + } + } + } + }, + "definitions": { + "ExpressRoutePortsLocationBandwidths": { + "title": "ExpressRoutePorts Location Bandwidths", + "description": "Real-time inventory of available ExpressRoute port bandwidths.", + "properties": { + "offerName": { + "type": "string", + "readOnly": true, + "description": "Bandwidth descriptive name." + }, + "valueInGbps": { + "type": "integer", + "readOnly": true, + "description": "Bandwidth value in Gbps." + } + } + }, + "ExpressRoutePortsLocationPropertiesFormat": { + "title": "ExpressRoutePorts Location Properties", + "description": "Properties specific to ExpressRoutePorts peering location resources.", + "properties": { + "address": { + "type": "string", + "readOnly": true, + "description": "Address of peering location." + }, + "contact": { + "type": "string", + "readOnly": true, + "description": "Contact details of peering locations." + }, + "availableBandwidths": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocationBandwidths" + }, + "description": "The inventory of available ExpressRoutePort bandwidths." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route port location resource." + } + } + }, + "ExpressRoutePortsLocation": { + "title": "ExpressRoutePorts Peering Location", + "description": "Definition of the ExpressRoutePorts peering location resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortsLocationPropertiesFormat", + "description": "ExpressRoutePort peering location properties." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortsLocationListResult": { + "title": "ExpressRoutePorts Location List Result", + "description": "Response for ListExpressRoutePortsLocations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + }, + "description": "The list of all ExpressRoutePort peering locations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRouteLinkMacSecConfig": { + "description": "ExpressRouteLink Mac Security Configuration.", + "title": "Definition of ExpressRouteLink Mac Security configuration.", + "properties": { + "cknSecretIdentifier": { + "type": "string", + "description": "Keyvault Secret Identifier URL containing Mac security CKN key." + }, + "cakSecretIdentifier": { + "type": "string", + "description": "Keyvault Secret Identifier URL containing Mac security CAK key." + }, + "cipher": { + "type": "string", + "description": "Mac security cipher.", + "enum": [ + "GcmAes256", + "GcmAes128", + "GcmAesXpn128", + "GcmAesXpn256" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkMacSecCipher", + "modelAsString": true + } + }, + "sciState": { + "type": "string", + "description": "Sci mode enabled/disabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkMacSecSciState", + "modelAsString": true + } + } + } + }, + "ExpressRouteLinkPropertiesFormat": { + "title": "ExpressRouteLink Resource Properties", + "description": "Properties specific to ExpressRouteLink resources.", + "properties": { + "routerName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router associated with physical port." + }, + "interfaceName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router interface." + }, + "patchPanelId": { + "readOnly": true, + "type": "string", + "description": "Mapping between physical port to patch panel port." + }, + "rackId": { + "readOnly": true, + "type": "string", + "description": "Mapping of physical patch panel to rack." + }, + "coloLocation": { + "readOnly": true, + "type": "string", + "description": "Cololocation for ExpressRoute Hybrid Direct." + }, + "connectorType": { + "readOnly": true, + "type": "string", + "description": "Physical fiber port type.", + "enum": [ + "LC", + "SC" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkConnectorType", + "modelAsString": true + } + }, + "adminState": { + "type": "string", + "description": "Administrative state of the physical port.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkAdminState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route link resource." + }, + "macSecConfig": { + "$ref": "#/definitions/ExpressRouteLinkMacSecConfig", + "description": "MacSec configuration." + } + } + }, + "ExpressRouteLink": { + "title": "ExpressRouteLink", + "description": "ExpressRouteLink child resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteLinkPropertiesFormat", + "description": "ExpressRouteLink properties." + }, + "name": { + "type": "string", + "description": "Name of child port resource that is unique among child port resources of the parent." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRouteLinkListResult": { + "title": "ExpressRouteLink List Result", + "description": "Response for ListExpressRouteLinks API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + }, + "description": "The list of ExpressRouteLink sub-resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRoutePortPropertiesFormat": { + "title": "ExpressRoutePort Properties", + "description": "Properties specific to ExpressRoutePort resources.", + "properties": { + "peeringLocation": { + "type": "string", + "description": "The name of the peering location that the ExpressRoutePort is mapped to physically." + }, + "bandwidthInGbps": { + "type": "integer", + "description": "Bandwidth of procured ports in Gbps." + }, + "provisionedBandwidthInGbps": { + "readOnly": true, + "type": "number", + "description": "Aggregate Gbps of associated circuit bandwidths." + }, + "mtu": { + "readOnly": true, + "type": "string", + "description": "Maximum transmission unit of the physical port pair(s)." + }, + "encapsulation": { + "type": "string", + "description": "Encapsulation method on physical ports.", + "enum": [ + "Dot1Q", + "QinQ" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsEncapsulation", + "modelAsString": true + } + }, + "etherType": { + "readOnly": true, + "type": "string", + "description": "Ether type of the physical port." + }, + "allocationDate": { + "readOnly": true, + "type": "string", + "description": "Date of the physical port allocation to be used in Letter of Authorization." + }, + "links": { + "title": "ExpressRouteLink Sub-Resources", + "description": "The set of physical links of the ExpressRoutePort resource.", + "readOnly": false, + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "circuits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route port resource." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the express route port resource." + }, + "billingType": { + "type": "string", + "description": "The billing type of the ExpressRoutePort resource.", + "enum": [ + "MeteredData", + "UnlimitedData" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsBillingType", + "modelAsString": true + } + } + } + }, + "ExpressRoutePort": { + "title": "ExpressRoute Port", + "description": "ExpressRoutePort resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortPropertiesFormat", + "description": "ExpressRoutePort properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of ExpressRoutePort, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortListResult": { + "title": "ExpressRoute Port List Result", + "description": "Response for ListExpressRoutePorts API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "A list of ExpressRoutePort resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "GenerateExpressRoutePortsLOARequest": { + "description": "The customer name to be printed on a letter of authorization.", + "properties": { + "customerName": { + "type": "string", + "description": "The customer name." + } + }, + "required": [ + "customerName" + ] + }, + "GenerateExpressRoutePortsLOAResult": { + "description": "Response for GenerateExpressRoutePortsLOA API service call.", + "properties": { + "encodedContent": { + "type": "string", + "description": "The content as a base64 encoded string." + } + } + }, + "ExpressRoutePortAuthorizationPropertiesFormat": { + "type": "object", + "title": "ExpressRoute Port Authorization Properties", + "description": "Properties of ExpressRoutePort Authorization.", + "properties": { + "authorizationKey": { + "readOnly": true, + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "readOnly": true, + "type": "string", + "description": "The authorization use status.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "ExpressRoutePortAuthorizationUseStatus", + "modelAsString": true + } + }, + "circuitResourceUri": { + "readOnly": true, + "type": "string", + "description": "The reference to the ExpressRoute circuit resource using the authorization." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authorization resource." + } + } + }, + "ExpressRoutePortAuthorization": { + "type": "object", + "title": "ExpressRoute Port Authorization", + "description": "ExpressRoutePort Authorization resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortAuthorizationPropertiesFormat", + "description": "ExpressRoutePort properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRoutePortAuthorizationListResult": { + "type": "object", + "title": "ExpressRoute Port Authorization List Result", + "description": "Response for ListExpressRoutePortAuthorizations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortAuthorization" + }, + "description": "The authorizations in an ExpressRoute Port." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteProviderPort.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteProviderPort.json new file mode 100644 index 000000000000..16ec26727410 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/expressRouteProviderPort.json @@ -0,0 +1,225 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/expressRouteProviderPorts": { + "get": { + "tags": [ + "ExpressRouteProviderPorts" + ], + "operationId": "ExpressRouteProviderPortsLocation_List", + "description": "Retrieves all the ExpressRouteProviderPorts in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=location eq '{state}'." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteProviderPort resources at a location. If there are no ports for the provider, an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteProviderPortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteProviderPortList": { + "$ref": "./examples/expressRouteProviderPortList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteProviderPorts/{providerport}": { + "get": { + "tags": [ + "ExpressRouteProviderPorts" + ], + "operationId": "ExpressRouteProviderPort", + "description": "Retrieves detail of a provider port.", + "parameters": [ + { + "name": "providerport", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the provider port." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns detail of individual provider port resources. If there is no port, an empty result is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteProviderPort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteProviderPort": { + "$ref": "./examples/expressRouteProviderPort.json" + } + } + } + } + }, + "definitions": { + "ExpressRouteProviderPortProperties": { + "type": "object", + "properties": { + "portPairDescriptor": { + "readOnly": true, + "type": "string", + "description": "The name of the port pair." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location of the port pair." + }, + "overprovisionFactor": { + "type": "integer", + "format": "int32", + "description": "Overprovisioning factor for the port pair." + }, + "portBandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "Bandwidth of the port in Mbps" + }, + "usedBandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "Used Bandwidth of the port in Mbps" + }, + "remainingBandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "Remaining Bandwidth of the port in Mbps" + } + }, + "description": "Properties of ExpressRouteProviderPort." + }, + "ExpressRouteProviderPort": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteProviderPortProperties", + "description": "Properties of the express route Service Provider Port." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteProviderPort resource." + }, + "ExpressRouteProviderPortListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteProviderPort" + }, + "description": "A list of ExpressRouteProviderPort resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteProviderPort API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/firewallPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/firewallPolicy.json new file mode 100644 index 000000000000..f04f3826ab6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/firewallPolicy.json @@ -0,0 +1,2720 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/firewallPolicies/{firewallPolicyName}": { + "delete": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_Delete", + "description": "Deletes the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Firewall Policy": { + "$ref": "./examples/FirewallPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_Get", + "description": "Gets the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Firewall Policy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get FirewallPolicy": { + "$ref": "./examples/FirewallPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_CreateOrUpdate", + "description": "Creates or updates the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPolicy" + }, + "description": "Parameters supplied to the create or update Firewall Policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create FirewallPolicy": { + "$ref": "./examples/FirewallPolicyPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_UpdateTags", + "description": "Updates tags of a Azure Firewall Policy resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update Azure Firewall Policy tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update FirewallPolicy Tags": { + "$ref": "./examples/FirewallPolicyPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies": { + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_List", + "description": "Lists all Firewall Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicy resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Firewall Policies for a given resource group": { + "$ref": "./examples/FirewallPolicyListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/firewallPolicies": { + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_ListAll", + "description": "Gets all the Firewall Policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicy resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Firewall Policies for a given subscription": { + "$ref": "./examples/FirewallPolicyListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}": { + "delete": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_Delete", + "description": "Deletes the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_Get", + "description": "Gets the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupGet.json" + }, + "Get FirewallPolicyRuleCollectionGroup With IpGroups": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json" + }, + "Get FirewallPolicyNatRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyNatRuleCollectionGroupGet.json" + }, + "Get FirewallPolicyRuleCollectionGroup With Web Categories": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesGet.json" + } + } + }, + "put": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_CreateOrUpdate", + "description": "Creates or updates the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + }, + "description": "Parameters supplied to the create or update FirewallPolicyRuleCollectionGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Firewall Policy Rule Collection Group": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupPut.json" + }, + "Create Firewall Policy Rule Collection Group With IP Groups": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json" + }, + "Create Firewall Policy Nat Rule Collection Group": { + "$ref": "./examples/FirewallPolicyNatRuleCollectionGroupPut.json" + }, + "Create Firewall Policy Rule Collection Group With Web Categories": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesPut.json" + }, + "Create Firewall Policy Rule Collection Group With http header to insert": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithHttpHeadersToInsert.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups": { + "get": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_List", + "description": "Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicyRuleCollectionGroup resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all FirewallPolicyRuleCollectionGroups for a given FirewallPolicy": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupList.json" + }, + "List all FirewallPolicyRuleCollectionGroups with IpGroups for a given FirewallPolicy": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json" + }, + "List all FirewallPolicyRuleCollectionGroup With Web Categories": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithWebCategoriesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/listIdpsSignatures": { + "post": { + "operationId": "FirewallPolicyIdpsSignatures_List", + "description": "Retrieves the current status of IDPS signatures for the relevant policy. Maximal amount of returned signatures is 1000.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IDPSQueryObject" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns an IDPS Query Response", + "schema": { + "$ref": "#/definitions/QueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "query signature overrides": { + "$ref": "./examples/FirewallPolicyQuerySignatureOverrides.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides/default": { + "patch": { + "operationId": "FirewallPolicyIdpsSignaturesOverrides_Patch", + "description": "Will update the status of policy's signature overrides for IDPS", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "description": "Will contain all properties of the object to put", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Will return the policy current signature overrides object", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "patch signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesPatch.json" + } + } + }, + "put": { + "description": "Will override/create a new signature overrides for the policy's IDPS", + "operationId": "FirewallPolicyIdpsSignaturesOverrides_Put", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "description": "Will contain all properties of the object to put", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describes the new state of the signature overrides after the PUT operation", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "put signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesPut.json" + } + } + }, + "get": { + "description": "Returns all signatures overrides for a specific policy.", + "operationId": "FirewallPolicyIdpsSignaturesOverrides_Get", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Will return the policy current signature overrides object", + "schema": { + "$ref": "#/definitions/SignaturesOverrides" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "get signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/listIdpsFilterOptions": { + "post": { + "operationId": "FirewallPolicyIdpsSignaturesFilterValues_List", + "description": "Retrieves the current filter values for the signatures overrides", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SignatureOverridesFilterValuesQuery" + } + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all valid filter values for the requested column", + "schema": { + "$ref": "#/definitions/SignatureOverridesFilterValuesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "query signature overrides": { + "$ref": "./examples/FirewallPolicyQuerySignatureOverridesFilterValues.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/signatureOverrides": { + "get": { + "description": "Returns all signatures overrides objects for a specific policy as a list containing a single value.", + "operationId": "FirewallPolicyIdpsSignaturesOverrides_List", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Will return the policy current signature overrides object inside a list", + "schema": { + "$ref": "#/definitions/SignaturesOverridesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "get signature overrides": { + "$ref": "./examples/FirewallPolicySignatureOverridesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/firewallPolicyDrafts/default": { + "put": { + "description": "Create or update a draft Firewall Policy.", + "operationId": "FirewallPolicyDrafts_CreateOrUpdate", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "pattern": "^[^_\\W][\\w-._]{0,79}(?/." + }, + "privateIPAddressPrefixLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "x-nullable": true, + "description": "The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "Subnet bound to the IP configuration." + }, + "primary": { + "type": "boolean", + "description": "Whether this is a primary customer address on the network interface." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "Public IP address bound to the IP configuration." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the IP configuration is included." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface IP configuration." + }, + "privateLinkConnectionProperties": { + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties", + "description": "PrivateLinkConnection properties for the network interface.", + "readOnly": true + } + }, + "description": "Properties of IP configuration." + }, + "NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties": { + "properties": { + "groupId": { + "type": "string", + "readOnly": true, + "description": "The group ID for current private link connection." + }, + "requiredMemberName": { + "type": "string", + "readOnly": true, + "description": "The required member name for current private link connection." + }, + "fqdns": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "List of FQDNs for current private link connection." + } + }, + "description": "PrivateLinkConnection properties for the network interface." + }, + "NetworkInterfaceIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat", + "description": "Network interface IP configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IPConfiguration in a network interface." + }, + "NetworkInterfaceDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection." + }, + "appliedDnsServers": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs." + }, + "internalDnsNameLabel": { + "type": "string", + "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." + }, + "internalFqdn": { + "readOnly": true, + "type": "string", + "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." + }, + "internalDomainNameSuffix": { + "readOnly": true, + "type": "string", + "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix." + } + }, + "description": "DNS settings of a network interface." + }, + "NetworkInterfacePropertiesFormat": { + "properties": { + "virtualMachine": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to a virtual machine.", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference to the NetworkSecurityGroup resource." + }, + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "A reference to the private endpoint to which the network interface is linked." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of IPConfigurations of the network interface." + }, + "tapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of TapConfigurations of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/NetworkInterfaceDnsSettings", + "description": "The DNS settings in network interface." + }, + "macAddress": { + "readOnly": true, + "type": "string", + "description": "The MAC address of the network interface." + }, + "primary": { + "readOnly": true, + "type": "boolean", + "description": "Whether this is a primary network interface on a virtual machine." + }, + "vnetEncryptionSupported": { + "readOnly": true, + "type": "boolean", + "description": "Whether the virtual machine this nic is attached to supports encryption." + }, + "defaultOutboundConnectivityEnabled": { + "readOnly": true, + "type": "boolean", + "description": "Whether default outbound connectivity for nic was configured or not." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Indicates whether to disable tcp state tracking." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Indicates whether IP forwarding is enabled on this network interface." + }, + "hostedWorkloads": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "A list of references to linked BareMetal resources." + }, + "dscpConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to the dscp configuration to which the network interface is linked.", + "readOnly": true + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network interface resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface resource." + }, + "workloadType": { + "type": "string", + "description": "WorkloadType of the NetworkInterface for BareMetal resources" + }, + "nicType": { + "type": "string", + "description": "Type of Network Interface resource.", + "enum": [ + "Standard", + "Elastic" + ], + "x-ms-enum": { + "name": "NetworkInterfaceNicType", + "modelAsString": true + } + }, + "privateLinkService": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkService", + "description": "Privatelinkservice of the network interface resource." + }, + "migrationPhase": { + "type": "string", + "description": "Migration phase of Network Interface resource.", + "enum": [ + "None", + "Prepare", + "Commit", + "Abort", + "Committed" + ], + "x-ms-enum": { + "name": "NetworkInterfaceMigrationPhase", + "modelAsString": true + } + }, + "auxiliaryMode": { + "type": "string", + "description": "Auxiliary mode of Network Interface resource.", + "enum": [ + "None", + "MaxConnections", + "Floating", + "AcceleratedConnections" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true + } + }, + "auxiliarySku": { + "type": "string", + "description": "Auxiliary sku of Network Interface resource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true + } + } + }, + "description": "NetworkInterface properties." + }, + "NetworkInterface": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the network interface." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfacePropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A network interface in a resource group." + }, + "NetworkInterfaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "A list of network interfaces in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListNetworkInterface API service call." + }, + "NetworkInterfaceTapConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of tap configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list tap configurations API service call." + }, + "NetworkInterfaceIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of ip configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "NetworkInterfaceLoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/LoadBalancer" + }, + "description": "A list of load balancers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "EffectiveNetworkSecurityGroup": { + "properties": { + "networkSecurityGroup": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of network security group that is applied." + }, + "association": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation", + "description": "Associated resources." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "A collection of effective security rules." + }, + "tagMap": { + "type": "string", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of IP Addresses within the tag (key)." + }, + "description": "Mapping of tags to list of IP Addresses included within the tag." + } + }, + "description": "Effective network security group." + }, + "EffectiveNetworkSecurityGroupAssociation": { + "properties": { + "networkManager": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the Azure network manager if assigned." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the subnet if assigned." + }, + "networkInterface": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the network interface if assigned." + } + }, + "description": "The effective network security group association." + }, + "EffectiveNetworkSecurityRule": { + "properties": { + "name": { + "type": "string", + "description": "The name of the security rule specified by the user (if created by the user)." + }, + "protocol": { + "type": "string", + "description": "The network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "All" + ], + "x-ms-enum": { + "name": "EffectiveSecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The source address prefix." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix." + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." + }, + "expandedSourceAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The expanded source address prefix." + }, + "expandedDestinationAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Expanded destination address prefix." + }, + "access": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", + "description": "Whether network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule." + }, + "direction": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleDirection", + "description": "The direction of the rule." + } + }, + "description": "Effective network security rules." + }, + "EffectiveNetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroup" + }, + "description": "A list of effective network security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective network security groups API service call." + }, + "EffectiveRoute": { + "properties": { + "name": { + "type": "string", + "description": "The name of the user defined route. This is optional." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "If true, on-premises routes are not propagated to the network interfaces in the subnet." + }, + "source": { + "type": "string", + "description": "Who created the route.", + "enum": [ + "Unknown", + "User", + "VirtualNetworkGateway", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveRouteSource", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The value of effective route.", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "name": "EffectiveRouteState", + "modelAsString": true + } + }, + "addressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The address prefixes of the effective routes in CIDR notation." + }, + "nextHopIpAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP address of the next hop of the effective route." + }, + "nextHopType": { + "$ref": "./routeTable.json#/definitions/RouteNextHopType", + "description": "The type of Azure hop the packet should be sent to." + } + }, + "description": "Effective Route." + }, + "EffectiveRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRoute" + }, + "description": "A list of effective routes." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective route API service call." + }, + "IPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method.", + "default": "Dynamic" + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration resource." + } + }, + "description": "Properties of IP configuration." + }, + "IPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationPropertiesFormat", + "description": "Properties of the IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManager.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManager.json new file mode 100644 index 000000000000..031c5825dd41 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManager.json @@ -0,0 +1,755 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManager", + "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_Get", + "description": "Gets the specified Network Manager.", + "responses": { + "200": { + "description": "OK - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkManagersGet": { + "$ref": "./examples/NetworkManagerGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_CreateOrUpdate", + "description": "Creates or updates a Network Manager.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManager" + }, + "description": "Parameters supplied to specify which network manager is." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "201": { + "description": "Created - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Put Network Manager": { + "$ref": "./examples/NetworkManagerPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "description": "Deletes a network manager.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkManagersDelete": { + "$ref": "./examples/NetworkManagerDelete.json" + } + } + }, + "patch": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_Patch", + "description": "Patch NetworkManager.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchObject" + }, + "description": "Parameters supplied to specify which network manager is." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the network manager.", + "schema": { + "$ref": "#/definitions/NetworkManager" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkManagesPatch": { + "$ref": "./examples/NetworkManagerPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/commit": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagerCommits_Post", + "description": "Post a Network Manager Commit.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerCommit" + }, + "description": "Parameters supplied to specify which Managed Network commit is." + } + ], + "responses": { + "200": { + "description": "Succeed.", + "schema": { + "$ref": "#/definitions/NetworkManagerCommit" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/NetworkManagerCommit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkManageCommitPost": { + "$ref": "./examples/NetworkManagerCommitPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listDeploymentStatus": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagerDeploymentStatus_List", + "description": "Post to List of Network Manager Deployment Status.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerDeploymentStatusParameter" + }, + "description": "Parameters supplied to specify which Managed Network deployment status is." + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of deployment status.", + "schema": { + "$ref": "#/definitions/NetworkManagerDeploymentStatusListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkManagerDeploymentStatusList": { + "$ref": "./examples/NetworkManagerDeploymentStatusList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagers": { + "get": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_ListBySubscription", + "description": "List all network managers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network managers.", + "schema": { + "$ref": "#/definitions/NetworkManagerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkManagersList": { + "$ref": "./examples/NetworkManagerListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers": { + "get": { + "tags": [ + "NetworkManagers" + ], + "operationId": "NetworkManagers_List", + "description": "List network managers in a resource group.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of network managers.", + "schema": { + "$ref": "#/definitions/NetworkManagerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Network Manager": { + "$ref": "./examples/NetworkManagerList.json" + } + } + } + } + }, + "definitions": { + "NetworkManager": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkManagerProperties", + "description": "The network manager properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "The Managed Network resource" + }, + "NetworkManagerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkManager" + }, + "description": "Gets a page of NetworkManager" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NetworkManager. It contains a list of network managers and a URL link to get the next set of results." + }, + "NetworkManagerProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the network manager." + }, + "networkManagerScopes": { + "type": "object", + "properties": { + "managementGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of management groups." + }, + "subscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of subscriptions." + }, + "crossTenantScopes": { + "readOnly": true, + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/CrossTenantScopes" + }, + "description": "List of cross tenant scopes." + } + }, + "description": "Scope of Network Manager." + }, + "networkManagerScopeAccesses": { + "type": "array", + "items": { + "type": "string", + "$ref": "#/definitions/ConfigurationType" + }, + "description": "Scope Access." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network manager resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "networkManagerScopes" + ], + "description": "Properties of Managed Network" + }, + "CrossTenantScopes": { + "type": "object", + "properties": { + "tenantId": { + "readOnly": true, + "type": "string", + "description": "Tenant ID." + }, + "managementGroups": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of management groups." + }, + "subscriptions": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "List of subscriptions." + } + }, + "description": "Cross tenant scopes." + }, + "NetworkManagerCommit": { + "type": "object", + "properties": { + "commitId": { + "type": "string", + "readOnly": true, + "description": "Commit Id." + }, + "targetLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of target locations." + }, + "configurationIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of configuration ids." + }, + "commitType": { + "type": "string", + "$ref": "#/definitions/ConfigurationType", + "description": "Commit Type." + } + }, + "required": [ + "targetLocations", + "commitType" + ], + "description": "Network Manager Commit." + }, + "PatchObject": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Object for patch operations." + }, + "NetworkManagerDeploymentStatusParameter": { + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of locations." + }, + "deploymentTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationType" + }, + "description": "List of deployment types." + }, + "skipToken": { + "description": "Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.", + "type": "string" + } + }, + "description": "Network Manager Deployment Status Parameter." + }, + "NetworkManagerDeploymentStatusListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/NetworkManagerDeploymentStatus" + }, + "description": "Gets a page of Network Manager Deployment Status" + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "A list of Network Manager Deployment Status" + }, + "NetworkManagerDeploymentStatus": { + "type": "object", + "properties": { + "commitTime": { + "type": "string", + "format": "date-time", + "description": "Commit Time." + }, + "region": { + "type": "string", + "description": "Region Name." + }, + "deploymentStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Deploying", + "Deployed", + "Failed" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + }, + "description": "Deployment Status." + }, + "configurationIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of configuration ids." + }, + "deploymentType": { + "type": "string", + "$ref": "#/definitions/ConfigurationType" + }, + "errorMessage": { + "type": "string", + "description": "Error Message." + } + }, + "description": "Network Manager Deployment Status." + }, + "ConfigurationType": { + "type": "string", + "enum": [ + "SecurityAdmin", + "Connectivity", + "SecurityUser", + "Routing" + ], + "x-ms-enum": { + "name": "ConfigurationType", + "modelAsString": true + }, + "description": "Configuration Deployment Type." + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "OperationResultIdParameter": { + "name": "operationResultId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of operation Result.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerActiveConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerActiveConfiguration.json new file mode 100644 index 000000000000..bf17c9532812 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerActiveConfiguration.json @@ -0,0 +1,345 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagerActiveConfiguration", + "description": "The Microsoft Azure Network Manager Active Configuration API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to list all active configuration by network manager.", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/listActiveConnectivityConfigurations": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerActiveConnectivityConfigurations" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveConfigurationParameter" + }, + "description": "Active Configuration Parameter." + } + ], + "operationId": "ListActiveConnectivityConfigurations", + "description": "Lists active connectivity configurations in a network manager.", + "responses": { + "200": { + "description": "Post successful. The operation returns the specified Managed Network active connectivity configuration resource.", + "schema": { + "$ref": "#/definitions/ActiveConnectivityConfigurationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Active Connectivity Configurations": { + "$ref": "./examples/NetworkManagerActiveConnectivityConfigurationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/listActiveSecurityAdminRules": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerActiveConfigurations" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveConfigurationParameter" + }, + "description": "Active Configuration Parameter." + } + ], + "operationId": "ListActiveSecurityAdminRules", + "description": "Lists active security admin rules in a network manager.", + "responses": { + "200": { + "description": "Post successful. The operation returns the specified Managed Network active security admin rules resource.", + "schema": { + "$ref": "#/definitions/ActiveSecurityAdminRulesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Active Security Admin Rules": { + "$ref": "./examples/NetworkManagerActiveSecurityAdminRulesList.json" + } + } + } + } + }, + "definitions": { + "ActiveConfigurationParameter": { + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "type": "string", + "description": "region Name." + }, + "description": "List of regions." + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Effective Virtual Networks Parameter." + }, + "ActiveConnectivityConfiguration": { + "type": "object", + "properties": { + "commitTime": { + "type": "string", + "description": "Deployment time string.", + "format": "date-time" + }, + "region": { + "type": "string", + "description": "Deployment region." + } + }, + "allOf": [ + { + "$ref": "./networkManagerEffectiveConfiguration.json#/definitions/EffectiveConnectivityConfiguration" + } + ], + "description": "Active connectivity configuration." + }, + "ActiveConnectivityConfigurationsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActiveConnectivityConfiguration" + }, + "description": "Gets a page of active connectivity configurations." + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list active connectivity configurations. It contains a list of active connectivity configurations and a skiptoken to get the next set of results." + }, + "ActiveSecurityAdminRulesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActiveBaseSecurityAdminRule" + }, + "description": "Gets a page of active security admin rules." + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list active security admin rules. It contains a list of active security admin rules and a skiptoken to get the next set of results." + }, + "ActiveBaseSecurityAdminRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "commitTime": { + "type": "string", + "description": "Deployment time string.", + "format": "date-time" + }, + "region": { + "type": "string", + "description": "Deployment region." + }, + "configurationDescription": { + "type": "string", + "description": "A description of the security admin configuration." + }, + "ruleCollectionDescription": { + "type": "string", + "description": "A description of the rule collection." + }, + "ruleCollectionAppliesToGroups": { + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/NetworkManagerSecurityGroupItem" + }, + "description": "Groups for rule collection" + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "./networkManagerEffectiveConfiguration.json#/definitions/ConfigurationGroup" + }, + "description": "Effective configuration groups." + }, + "kind": { + "type": "string", + "description": "Whether the rule is custom or default.", + "enum": [ + "Custom", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveAdminRuleKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ], + "discriminator": "kind", + "description": "Network base admin rule." + }, + "ActiveSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/AdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ActiveBaseSecurityAdminRule" + } + ], + "description": "Network admin rule.", + "x-ms-discriminator-value": "Custom" + }, + "ActiveDefaultSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/DefaultAdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the default security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ActiveBaseSecurityAdminRule" + } + ], + "description": "Network default admin rule.", + "x-ms-discriminator-value": "Default" + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerConnection.json new file mode 100644 index 000000000000..3d8c294ed599 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerConnection.json @@ -0,0 +1,426 @@ +{ + "swagger": "2.0", + "info": { + "title": "ScopeConnections", + "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2025-03-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}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/NetworkManagerConnectionNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "put": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_CreateOrUpdate", + "description": "Create a network manager connection on this subscription.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + }, + "description": "Network manager connection to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "201": { + "description": "Created - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionPut.json" + } + } + }, + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_Get", + "description": "Get a specified connection created by this subscription.", + "responses": { + "200": { + "description": "OK - Returns the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_Delete", + "description": "Delete specified connection created by this subscription.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkManagerConnections": { + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "SubscriptionNetworkManagerConnections_List", + "description": "List all network manager connections created by this subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListTopParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network manager connection(s).", + "schema": { + "$ref": "#/definitions/NetworkManagerConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Subscription Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionSubscriptionList.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections/{networkManagerConnectionName}": { + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/NetworkManagerConnectionNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "put": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_CreateOrUpdate", + "description": "Create a network manager connection on this management group.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + }, + "description": "Network manager connection to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "201": { + "description": "Created - Returns information about the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupPut.json" + } + } + }, + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_Get", + "description": "Get a specified connection created by this management group.", + "responses": { + "200": { + "description": "OK - Returns the connection.", + "schema": { + "$ref": "#/definitions/NetworkManagerConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_Delete", + "description": "Delete specified pending connection created by this management group.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupDelete.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Network/networkManagerConnections": { + "get": { + "tags": [ + "NetworkManagerConnections" + ], + "operationId": "ManagementGroupNetworkManagerConnections_List", + "description": "List all network manager connections created by this management group.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListTopParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network manager connection(s).", + "schema": { + "$ref": "#/definitions/NetworkManagerConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Management Group Network Manager Connection": { + "$ref": "./examples/NetworkManagerConnectionManagementGroupList.json" + } + } + } + } + }, + "definitions": { + "NetworkManagerConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkManagerConnectionProperties", + "description": "The scope connection properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The Network Manager Connection resource" + }, + "NetworkManagerConnectionProperties": { + "type": "object", + "properties": { + "networkManagerId": { + "type": "string", + "description": "Network Manager Id." + }, + "connectionState": { + "x-ms-client-flatten": true, + "$ref": "./networkManagerScopeConnection.json#/definitions/ConnectionState", + "description": "Connection state." + }, + "description": { + "type": "string", + "description": "A description of the network manager connection." + } + }, + "description": "Information about the network manager connection." + }, + "NetworkManagerConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkManagerConnection" + }, + "description": "List of network manager connections." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "List of network manager connections." + } + }, + "parameters": { + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group Id which uniquely identify the Microsoft Azure management group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerConnectionNameParameter": { + "name": "networkManagerConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name for the network manager connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerConnectivityConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerConnectivityConfiguration.json new file mode 100644 index 000000000000..c0e41808a8ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerConnectivityConfiguration.json @@ -0,0 +1,538 @@ +{ + "swagger": "2.0", + "info": { + "title": "ConnectivityConfiguration", + "description": "The Microsoft Azure Virtual Network Manager Connectivity Configuration API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/connectivityConfigurations/{configurationName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ConnectivityConfigurationNameParameter" + } + ], + "get": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_Get", + "description": "Gets a Network Connectivity Configuration, specified by the resource group, network manager name, and connectivity Configuration name", + "responses": { + "200": { + "description": "Get successful. The operation returns the specified Managed Network Connectivity Configuration resource.", + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ConnectivityConfigurationsGet": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_CreateOrUpdate", + "description": "Creates/Updates a new network manager connectivity configuration", + "parameters": [ + { + "name": "connectivityConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + }, + "description": "Parameters supplied to create/update a network manager connectivity configuration" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network manager connectivity configuration.", + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network manager connectivity configuration.", + "schema": { + "$ref": "#/definitions/ConnectivityConfiguration" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ConnectivityConfigurationsPut": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationPut.json" + } + } + }, + "delete": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_Delete", + "description": "Deletes a network manager connectivity configuration, specified by the resource group, network manager name, and connectivity configuration name", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ConnectivityConfigurationsDelete": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/connectivityConfigurations": { + "get": { + "tags": [ + "ConnectivityConfigurations" + ], + "operationId": "ConnectivityConfigurations_List", + "description": "Lists all the network manager connectivity configuration in a specified network manager.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all network manager connectivity configuration resources in the specified network manager, in a paginated format", + "schema": { + "$ref": "#/definitions/ConnectivityConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectivityConfigurationsList": { + "$ref": "./examples/NetworkManagerConnectivityConfigurationList.json" + } + } + } + } + }, + "definitions": { + "ConnectivityConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityConfiguration" + }, + "description": "Gets a page of Connectivity Configurations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list network manager connectivity configurations. It contains a list of configurations and a link to get the next set of results." + }, + "ConnectivityConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectivityConfigurationProperties", + "description": "Properties of a network manager connectivity configuration" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The network manager connectivity configuration resource" + }, + "ConnectivityConfigurationProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the connectivity configuration." + }, + "connectivityTopology": { + "type": "string", + "enum": [ + "HubAndSpoke", + "Mesh" + ], + "x-ms-enum": { + "name": "ConnectivityTopology", + "modelAsString": true + }, + "description": "Connectivity topology type." + }, + "hubs": { + "type": "array", + "x-ms-identifiers": [ + "resourceId" + ], + "items": { + "$ref": "#/definitions/Hub" + }, + "description": "List of hubItems" + }, + "isGlobal": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "IsGlobal", + "modelAsString": true + }, + "description": "Flag if global mesh is supported." + }, + "connectivityCapabilities": { + "type": "object", + "description": "Collection of additional settings to enhance specific topology behaviors of the connectivity configuration resource.", + "properties": { + "connectedGroupPrivateEndpointsScale": { + "type": "string", + "enum": [ + "Standard", + "HighScale" + ], + "x-ms-enum": { + "name": "ConnectedGroupPrivateEndpointsScale", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Default. Allows for up to 2K private endpoints in the connected group." + }, + { + "value": "HighScale", + "description": "Allows for up to 20K private endpoints in the connected group." + } + ] + }, + "description": "Option indicating the scale of private endpoints allowed in the connected group of the connectivity configuration.", + "default": "Standard" + }, + "connectedGroupAddressOverlap": { + "type": "string", + "enum": [ + "Allowed", + "Disallowed" + ], + "x-ms-enum": { + "name": "ConnectedGroupAddressOverlap", + "modelAsString": true, + "values": [ + { + "value": "Allowed", + "description": "Default. Allows connected group members to have overlapping IP address space." + }, + { + "value": "Disallowed", + "description": "Strictly disallows connected group members from having overlapping IP address space. Prevents the addition of a virtual network with overlapping address to the connected group, blocks peering between a virtual network and a connected group member if any connected group member has an overlapping range, and restricts address space modifications that would introduce overlap." + } + ] + }, + "description": "Behavior to handle overlapped IP address space among members of the connected group of the connectivity configuration.", + "default": "Allowed" + }, + "peeringEnforcement": { + "type": "string", + "enum": [ + "Unenforced", + "Enforced" + ], + "x-ms-enum": { + "name": "PeeringEnforcement", + "modelAsString": true, + "values": [ + { + "value": "Unenforced", + "description": "Default. Peerings created by the connectivity configuration may be modified or deleted outside of the network manager." + }, + { + "value": "Enforced", + "description": "Peerings created by the connectivity configuration will not be modifiable or deletable outside of the network manager." + } + ] + }, + "description": "Option indicating enforcement of peerings created by the connectivity configuration.", + "default": "Unenforced" + } + }, + "required": [ + "connectedGroupPrivateEndpointsScale", + "connectedGroupAddressOverlap", + "peeringEnforcement" + ] + }, + "appliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "#/definitions/connectivityGroupItem" + }, + "description": "Groups for configuration" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the connectivity configuration resource." + }, + "deleteExistingPeering": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "DeleteExistingPeering", + "modelAsString": true + }, + "description": "Flag if need to remove current existing peerings." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "connectivityTopology", + "appliesToGroups" + ], + "description": "Properties of network manager connectivity configuration" + }, + "Hub": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id." + }, + "resourceType": { + "type": "string", + "description": "Resource Type." + } + }, + "description": "Hub Item." + }, + "connectivityGroupItem": { + "type": "object", + "properties": { + "networkGroupId": { + "type": "string", + "description": "Network group Id." + }, + "useHubGateway": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "UseHubGateway", + "modelAsString": true + }, + "description": "Flag if need to use hub gateway." + }, + "isGlobal": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "IsGlobal", + "modelAsString": true + }, + "description": "Flag if global is supported." + }, + "groupConnectivity": { + "type": "string", + "enum": [ + "None", + "DirectlyConnected" + ], + "x-ms-enum": { + "name": "GroupConnectivity", + "modelAsString": true + }, + "description": "Group connectivity type." + } + }, + "description": "Connectivity group item.", + "required": [ + "networkGroupId", + "groupConnectivity" + ] + } + }, + "parameters": { + "ConnectivityConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager connectivity configuration.", + "x-ms-parameter-location": "method" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerEffectiveConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerEffectiveConfiguration.json new file mode 100644 index 000000000000..bf6381f1a7b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerEffectiveConfiguration.json @@ -0,0 +1,337 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagerEffectiveConfiguration", + "description": "The Microsoft Azure Network Manager effective configuration API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/virtualNetworks/{virtualNetworkName}/listNetworkManagerEffectiveConnectivityConfigurations": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerEffectiveConnectivityConfiguration" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./networkManagerGroup.json#/definitions/QueryRequestOptions" + }, + "description": "Parameters supplied to list correct page." + } + ], + "operationId": "ListNetworkManagerEffectiveConnectivityConfigurations", + "description": "List all effective connectivity configurations applied on a virtual network.", + "responses": { + "200": { + "description": "OK - Returns information about the configurations.", + "schema": { + "$ref": "#/definitions/NetworkManagerEffectiveConnectivityConfigurationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List effective connectivity configuration": { + "$ref": "./examples/NetworkManagerEffectiveConnectivityConfigurationsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listNetworkManagerEffectiveSecurityAdminRules": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + } + ], + "post": { + "tags": [ + "NetworkManagerEffectiveSecurityAdminRules" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./networkManagerGroup.json#/definitions/QueryRequestOptions" + }, + "description": "Parameters supplied to list correct page." + } + ], + "operationId": "ListNetworkManagerEffectiveSecurityAdminRules", + "description": "List all effective security admin rules applied on a virtual network.", + "responses": { + "200": { + "description": "OK - Returns information about the configurations.", + "schema": { + "$ref": "#/definitions/NetworkManagerEffectiveSecurityAdminRulesListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List effective security admin rules": { + "$ref": "./examples/NetworkManagerEffectiveSecurityAdminRulesList.json" + } + } + } + } + }, + "definitions": { + "NetworkManagerEffectiveConnectivityConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveConnectivityConfiguration" + }, + "description": "Gets a page of NetworkManagerEffectiveConnectivityConfiguration" + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list networkManagerEffectiveConnectivityConfiguration. It contains a list of groups and a skiptoken to get the next set of results." + }, + "NetworkManagerEffectiveSecurityAdminRulesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveBaseSecurityAdminRule" + }, + "description": "Gets a page of NetworkManagerEffectiveSecurityAdminRules" + }, + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Result of the request to list networkManagerEffectiveSecurityAdminRules. It contains a list of groups and a skiptoken to get the next set of results." + }, + "EffectiveConnectivityConfiguration": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Connectivity configuration ID." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./networkManagerConnectivityConfiguration.json#/definitions/ConnectivityConfigurationProperties", + "description": "Properties of a network manager connectivity configuration" + }, + "configurationGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationGroup" + }, + "description": "Effective configuration groups." + } + }, + "description": "The network manager effective connectivity configuration" + }, + "EffectiveBaseSecurityAdminRule": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "configurationDescription": { + "type": "string", + "description": "A description of the security admin configuration." + }, + "ruleCollectionDescription": { + "type": "string", + "description": "A description of the rule collection." + }, + "ruleCollectionAppliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/NetworkManagerSecurityGroupItem" + }, + "description": "Groups for rule collection" + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationGroup" + }, + "description": "Effective configuration groups." + }, + "kind": { + "type": "string", + "description": "Whether the rule is custom or default.", + "enum": [ + "Custom", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveAdminRuleKind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ], + "discriminator": "kind", + "description": "Network base admin rule." + }, + "EffectiveSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/AdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EffectiveBaseSecurityAdminRule" + } + ], + "description": "Network admin rule.", + "x-ms-discriminator-value": "Custom" + }, + "EffectiveDefaultSecurityAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/DefaultAdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the default security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/EffectiveBaseSecurityAdminRule" + } + ], + "description": "Network default admin rule.", + "x-ms-discriminator-value": "Default" + }, + "ConfigurationGroup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Network group ID." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "./networkManagerGroup.json#/definitions/NetworkGroupProperties", + "description": "The network configuration group properties" + } + }, + "description": "The network configuration group resource" + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerGroup.json new file mode 100644 index 000000000000..7ff9e268e416 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerGroup.json @@ -0,0 +1,617 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkGroup", + "description": "The Microsoft Azure Network Group API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_Get", + "description": "Gets the specified network group.", + "responses": { + "200": { + "description": "OK - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkGroupsGet": { + "$ref": "./examples/NetworkManagerGroupGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_CreateOrUpdate", + "description": "Creates or updates a network group.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkGroup" + }, + "description": "Parameters supplied to the specify which network group need to create" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroup" + }, + "headers": { + "ETag": { + "description": "The current entity tag.", + "type": "string" + } + } + }, + "201": { + "description": "Created - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroup" + }, + "headers": { + "ETag": { + "description": "The current entity tag.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkGroupsPut": { + "$ref": "./examples/NetworkManagerGroupPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_Delete", + "description": "Deletes a network group.", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkGroupsDelete": { + "$ref": "./examples/NetworkManagerGroupDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups": { + "get": { + "tags": [ + "NetworkGroups" + ], + "operationId": "NetworkGroups_List", + "description": "Lists the specified network group.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the network group.", + "schema": { + "$ref": "#/definitions/NetworkGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkGroupsList": { + "$ref": "./examples/NetworkManagerGroupList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkGroupNameParameter" + }, + { + "$ref": "#/parameters/StaticMemberNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_Get", + "description": "Gets the specified static member.", + "responses": { + "200": { + "description": "OK - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMembersGet": { + "$ref": "./examples/NetworkManagerStaticMemberGet.json" + } + } + }, + "put": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_CreateOrUpdate", + "description": "Creates or updates a static member.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StaticMember" + }, + "description": "Parameters supplied to the specify the static member to create" + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMember" + } + }, + "201": { + "description": "Created - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMemberPut": { + "$ref": "./examples/NetworkManagerStaticMemberPut.json" + } + } + }, + "delete": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_Delete", + "description": "Deletes a static member.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMembersDelete": { + "$ref": "./examples/NetworkManagerStaticMemberDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers": { + "get": { + "tags": [ + "StaticMembers" + ], + "operationId": "StaticMembers_List", + "description": "Lists the specified static member.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the static member.", + "schema": { + "$ref": "#/definitions/StaticMemberListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StaticMembersList": { + "$ref": "./examples/NetworkManagerStaticMemberList.json" + } + } + } + } + }, + "definitions": { + "NetworkGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkGroupProperties", + "description": "The Network Group properties" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The network group resource" + }, + "NetworkGroupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkGroup" + }, + "description": "Gets a page of NetworkGroup" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Result of the request to list NetworkGroup. It contains a list of groups and a URL link to get the next set of results." + }, + "NetworkGroupProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the network group." + }, + "memberType": { + "$ref": "#/definitions/GroupMemberType", + "description": "The type of the group member." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the scope assignment resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Properties of network group" + }, + "GroupMemberType": { + "type": "string", + "description": "Network Group member type", + "enum": [ + "VirtualNetwork", + "Subnet" + ], + "x-ms-enum": { + "name": "GroupMemberType", + "modelAsString": true + } + }, + "StaticMember": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StaticMemberProperties", + "description": "The Static Member properties" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "StaticMember Item." + }, + "StaticMemberListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StaticMember" + }, + "description": "Gets a page of StaticMember" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Result of the request to list StaticMember. It contains a list of groups and a URL link to get the next set of results." + }, + "StaticMemberProperties": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "description": "Resource Id." + }, + "region": { + "readOnly": true, + "type": "string", + "description": "Resource region." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the scope assignment resource." + } + }, + "description": "Properties of static member." + }, + "QueryRequestOptions": { + "type": "object", + "properties": { + "skipToken": { + "description": "When present, the value can be passed to a subsequent query call (together with the same query and scopes used in the current request) to retrieve the next page of data.", + "type": "string" + } + }, + "description": "Query Request Options" + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "x-ms-parameter-location": "method" + }, + "NetworkGroupNameParameter": { + "name": "networkGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network group.", + "x-ms-parameter-location": "method" + }, + "StaticMemberNameParameter": { + "name": "staticMemberName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the static member.", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerRoutingConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerRoutingConfiguration.json new file mode 100644 index 000000000000..6d7a25e94187 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerRoutingConfiguration.json @@ -0,0 +1,1036 @@ +{ + "swagger": "2.0", + "info": { + "title": "RoutingConfiguration", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/routingConfigurations": { + "get": { + "tags": [ + "NetworkManagerRoutingConfigurations" + ], + "operationId": "NetworkManagerRoutingConfigurations_List", + "description": "Lists all the network manager routing configurations in a network manager, in a paginated format.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all routing configuration resources in the specified network manager, in a paginated format", + "schema": { + "$ref": "#/definitions/NetworkManagerRoutingConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routing configurations in a network manager": { + "$ref": "./examples/NetworkManagerRoutingConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerRoutingConfigurationParameter" + } + ], + "get": { + "tags": [ + "NetworkManagerRoutingConfigurations" + ], + "description": "Retrieves a network manager routing configuration.", + "operationId": "NetworkManagerRoutingConfigurations_Get", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/NetworkManagerRoutingConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get routing configurations": { + "$ref": "./examples/NetworkManagerRoutingConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkManagerRoutingConfigurations" + ], + "description": "Creates or updates a network manager routing configuration.", + "operationId": "NetworkManagerRoutingConfigurations_CreateOrUpdate", + "parameters": [ + { + "name": "routingConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkManagerRoutingConfiguration" + }, + "description": "The routing configuration to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Routing Configuration", + "schema": { + "$ref": "#/definitions/NetworkManagerRoutingConfiguration" + } + }, + "201": { + "description": "Created Routing Configuration", + "schema": { + "$ref": "#/definitions/NetworkManagerRoutingConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network manager routing configuration": { + "$ref": "./examples/NetworkManagerRoutingConfigurationPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkManagerRoutingConfigurations" + ], + "description": "Deletes a network manager routing configuration.", + "operationId": "NetworkManagerRoutingConfigurations_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete network manager routing configuration": { + "$ref": "./examples/NetworkManagerRoutingConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections": { + "get": { + "tags": [ + "RoutingRuleCollections" + ], + "operationId": "RoutingRuleCollections_List", + "description": "Lists all the rule collections in a routing configuration, in a paginated format.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerRoutingConfigurationParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all ruleCollections in the specified routing configuration, in a paginated format", + "schema": { + "$ref": "#/definitions/RoutingRuleCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routing rule collections": { + "$ref": "./examples/NetworkManagerRoutingRuleCollectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerRoutingConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + } + ], + "get": { + "tags": [ + "RoutingRuleCollections" + ], + "description": "Gets a network manager routing configuration rule collection.", + "operationId": "RoutingRuleCollections_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/RoutingRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets routing rule collection": { + "$ref": "./examples/NetworkManagerRoutingRuleCollectionGet.json" + } + } + }, + "put": { + "tags": [ + "RoutingRuleCollections" + ], + "description": "Creates or updates a routing rule collection.", + "operationId": "RoutingRuleCollections_CreateOrUpdate", + "parameters": [ + { + "name": "ruleCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoutingRuleCollection" + }, + "description": "The Rule Collection to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Rule Collection", + "schema": { + "$ref": "#/definitions/RoutingRuleCollection" + } + }, + "201": { + "description": "Created Rule Collection", + "schema": { + "$ref": "#/definitions/RoutingRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update a routing rule collection": { + "$ref": "./examples/NetworkManagerRoutingRuleCollectionPut.json" + } + } + }, + "delete": { + "tags": [ + "RoutingRuleCollections" + ], + "description": "Deletes an routing rule collection.", + "operationId": "RoutingRuleCollections_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes an routing rule collection": { + "$ref": "./examples/NetworkManagerRoutingRuleCollectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerRoutingConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "get": { + "tags": [ + "RoutingRules" + ], + "description": "List all network manager routing configuration routing rules.", + "operationId": "RoutingRules_List", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/RoutingRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List routing rules": { + "$ref": "./examples/NetworkManagerRoutingRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerRoutingConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/NetworkManagerRoutingConfigurationsRuleParameter" + } + ], + "get": { + "tags": [ + "RoutingRules" + ], + "description": "Gets a network manager routing configuration routing rule.", + "operationId": "RoutingRules_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/RoutingRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets routing rule": { + "$ref": "./examples/NetworkManagerRoutingRuleGet.json" + } + } + }, + "put": { + "tags": [ + "RoutingRules" + ], + "description": "Creates or updates an routing rule.", + "operationId": "RoutingRules_CreateOrUpdate", + "parameters": [ + { + "name": "routingRule", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoutingRule" + }, + "description": "The routing rule to create or update" + } + ], + "responses": { + "200": { + "description": "Updated rule", + "schema": { + "$ref": "#/definitions/RoutingRule" + } + }, + "201": { + "description": "Created rule", + "schema": { + "$ref": "#/definitions/RoutingRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create an routing rule": { + "$ref": "./examples/NetworkManagerRoutingRulePut.json" + }, + "Create a default routing rule": { + "$ref": "./examples/NetworkManagerRoutingRulePut.json" + } + } + }, + "delete": { + "tags": [ + "RoutingRules" + ], + "description": "Deletes a routing rule.", + "operationId": "RoutingRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes a routing rule": { + "$ref": "./examples/NetworkManagerRoutingRuleDelete.json" + } + } + } + } + }, + "definitions": { + "NetworkManagerRoutingConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkManagerRoutingConfigurationPropertiesFormat", + "description": "Indicates the properties for the network manager routing configuration." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the routing configuration" + }, + "NetworkManagerRoutingConfigurationPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the routing configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + }, + "routeTableUsageMode": { + "type": "string", + "enum": [ + "ManagedOnly", + "UseExisting" + ], + "default": "ManagedOnly", + "x-ms-enum": { + "name": "RouteTableUsageMode", + "modelAsString": true, + "values": [ + { + "name": "ManagedOnly", + "value": "ManagedOnly", + "description": "Only route tables managed by the routing configuration will be used." + }, + { + "name": "UseExisting", + "value": "UseExisting", + "description": "Use existing user-defined route tables already associated with resources." + } + ] + }, + "description": "Route table usage mode defines which route table will be used by the configuration. If not defined, this will default to 'ManagedOnly'." + } + }, + "description": "Defines the routing configuration properties." + }, + "NetworkManagerRoutingConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkManagerRoutingConfiguration" + }, + "description": "Gets a page of routing configurations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "A list of network manager routing configurations" + }, + "RoutingRuleCollection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutingRuleCollectionPropertiesFormat", + "description": "Indicates the properties for the network manager routing rule collection." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the routing rule collection." + }, + "RoutingRuleCollectionPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the routing rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + }, + "appliesTo": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "#/definitions/NetworkManagerRoutingGroupItem" + }, + "description": "Groups for configuration" + }, + "disableBgpRoutePropagation": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "DisableBgpRoutePropagation", + "modelAsString": true, + "values": [ + { + "name": "False", + "value": "False", + "description": "BGP route propagation is enabled." + }, + { + "name": "True", + "value": "True", + "description": "BGP route propagation is disabled." + } + ] + }, + "description": "Determines whether BGP route propagation is enabled. Defaults to true." + } + }, + "required": [ + "appliesTo" + ], + "description": "Defines the routing rule collection properties." + }, + "NetworkManagerRoutingGroupItem": { + "type": "object", + "properties": { + "networkGroupId": { + "type": "string", + "description": "Network manager group Id." + } + }, + "required": [ + "networkGroupId" + ], + "description": "Network manager routing group item." + }, + "RoutingRuleCollectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingRuleCollection" + }, + "description": "A list of network manager routing configuration rule collections" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Routing configuration rule collection list result." + }, + "RoutingRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RoutingRulePropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the routing rule" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Network routing rule." + }, + "RoutingRulePropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + }, + "destination": { + "$ref": "#/definitions/RoutingRuleRouteDestination", + "description": "Indicates the destination for this particular rule." + }, + "nextHop": { + "$ref": "#/definitions/RoutingRuleNextHop", + "description": "Indicates the next hop for this particular rule." + } + }, + "required": [ + "destination", + "nextHop" + ], + "description": "Routing rule resource." + }, + "RoutingRuleRouteDestination": { + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/RoutingRuleDestinationType", + "description": "Destination type." + }, + "destinationAddress": { + "type": "string", + "description": "Destination address." + } + }, + "required": [ + "type", + "destinationAddress" + ], + "description": "Route destination." + }, + "RoutingRuleNextHop": { + "type": "object", + "properties": { + "nextHopType": { + "$ref": "#/definitions/RoutingRuleNextHopType", + "description": "Next hop type." + }, + "nextHopAddress": { + "type": "string", + "description": "Next hop address. Only required if the next hop type is VirtualAppliance." + } + }, + "required": [ + "nextHopType" + ], + "description": "Next hop." + }, + "RoutingRuleNextHopType": { + "type": "string", + "description": "Routing rule next hop type.", + "enum": [ + "Internet", + "NoNextHop", + "VirtualAppliance", + "VirtualNetworkGateway", + "VnetLocal" + ], + "x-ms-enum": { + "name": "RoutingRuleNextHopType", + "modelAsString": true, + "values": [ + { + "name": "Internet", + "value": "Internet", + "description": "Forward traffic to the Internet." + }, + { + "name": "NoNextHop", + "value": "NoNextHop", + "description": "No next hop will be used." + }, + { + "name": "VirtualAppliance", + "value": "VirtualAppliance", + "description": "Forward traffic to a specified virtual appliance IP address." + }, + { + "name": "VirtualNetworkGateway", + "value": "VirtualNetworkGateway", + "description": "Forward traffic to the virtual network gateway." + }, + { + "name": "VnetLocal", + "value": "VnetLocal", + "description": "Keep traffic within the local virtual network" + } + ] + } + }, + "RoutingRuleDestinationType": { + "type": "string", + "description": "Routing rule destination type.", + "enum": [ + "AddressPrefix", + "ServiceTag" + ], + "x-ms-enum": { + "name": "RoutingRuleDestinationType", + "modelAsString": true, + "values": [ + { + "name": "AddressPrefix", + "value": "AddressPrefix", + "description": "Destination specified as an IP address prefix (CIDR)." + }, + { + "name": "ServiceTag", + "value": "ServiceTag", + "description": "Destination specified as an Azure service tag." + } + ] + } + }, + "RoutingRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingRule" + }, + "description": "A list of routing rules." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Routing configuration rule list result." + } + }, + "parameters": { + "NetworkManagerRoutingConfigurationParameter": { + "name": "configurationName", + "in": "path", + "description": "The name of the network manager Routing Configuration.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleCollectionParameter": { + "name": "ruleCollectionName", + "in": "path", + "description": "The name of the network manager routing Configuration rule collection.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NetworkManagerRoutingConfigurationsRuleParameter": { + "name": "ruleName", + "in": "path", + "description": "The name of the rule.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerScopeConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerScopeConnection.json new file mode 100644 index 000000000000..fe18761a9ffe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerScopeConnection.json @@ -0,0 +1,297 @@ +{ + "swagger": "2.0", + "info": { + "title": "ScopeConnections", + "description": "The Microsoft Azure Virtual Network Manager API provides a RESTful set of web services that interact with Microsoft Azure Network Manager service to manage your network resources.", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/scopeConnections/{scopeConnectionName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ScopeConnectionName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "put": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_CreateOrUpdate", + "description": "Creates or updates scope connection from Network Manager", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopeConnection" + }, + "description": "Scope connection to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Returns information about the updates scope connection.", + "schema": { + "$ref": "#/definitions/ScopeConnection" + } + }, + "201": { + "description": "Created - Returns information about the new scope connection.", + "schema": { + "$ref": "#/definitions/ScopeConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionPut.json" + } + } + }, + "get": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_Get", + "description": "Get specified scope connection created by this Network Manager.", + "responses": { + "200": { + "description": "OK - Returns the resource", + "schema": { + "$ref": "#/definitions/ScopeConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionGet.json" + } + } + }, + "delete": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_Delete", + "description": "Delete the pending scope connection created by this network manager.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/scopeConnections": { + "get": { + "tags": [ + "ScopeConnections" + ], + "operationId": "ScopeConnections_List", + "description": "List all scope connections created by this network manager.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListTopParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the scope connection(s).", + "schema": { + "$ref": "#/definitions/ScopeConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Network Manager Scope Connection": { + "$ref": "./examples/NetworkManagerScopeConnectionList.json" + } + } + } + } + }, + "definitions": { + "ScopeConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScopeConnectionProperties", + "description": "The scope connection properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "The Scope Connections resource" + }, + "ScopeConnectionProperties": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Tenant ID." + }, + "resourceId": { + "type": "string", + "description": "Resource ID." + }, + "connectionState": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionState", + "description": "Connection State" + }, + "description": { + "type": "string", + "description": "A description of the scope connection." + } + }, + "description": "Scope connection." + }, + "ScopeConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ScopeConnection" + }, + "description": "List of scope connections." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "List of scope connections." + }, + "ConnectionState": { + "type": "string", + "readOnly": true, + "description": "The current scope connection state.", + "enum": [ + "Connected", + "Pending", + "Conflict", + "Revoked", + "Rejected" + ], + "x-ms-enum": { + "name": "ScopeConnectionState", + "modelAsString": true + } + } + }, + "parameters": { + "ScopeConnectionName": { + "name": "scopeConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name for the cross-tenant connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerSecurityAdminConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerSecurityAdminConfiguration.json new file mode 100644 index 000000000000..617c8f9f5dfd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerSecurityAdminConfiguration.json @@ -0,0 +1,1180 @@ +{ + "swagger": "2.0", + "info": { + "title": "SecurityAdminConfiguration", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/securityAdminConfigurations": { + "get": { + "tags": [ + "SecurityAdminConfigurations" + ], + "operationId": "SecurityAdminConfigurations_List", + "description": "Lists all the network manager security admin configurations in a network manager, in a paginated format.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all security admin configuration resources in the specified network manager, in a paginated format", + "schema": { + "$ref": "#/definitions/SecurityAdminConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List security admin configurations in a network manager": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + } + ], + "get": { + "tags": [ + "SecurityAdminConfigurations" + ], + "description": "Retrieves a network manager security admin configuration.", + "operationId": "SecurityAdminConfigurations_Get", + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "Get security admin configurations": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityAdminConfigurations" + ], + "description": "Creates or updates a network manager security admin configuration.", + "operationId": "SecurityAdminConfigurations_CreateOrUpdate", + "parameters": [ + { + "name": "securityAdminConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + }, + "description": "The security admin configuration to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Admin Configuration", + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + } + }, + "201": { + "description": "Created Admin Configuration", + "schema": { + "$ref": "#/definitions/SecurityAdminConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network manager security admin configuration": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationPut.json" + }, + "Create manual-mode security admin configuration": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationPut_ManualAggregation.json" + } + } + }, + "delete": { + "tags": [ + "SecurityAdminConfigurations" + ], + "description": "Deletes a network manager security admin configuration.", + "operationId": "SecurityAdminConfigurations_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete network manager security admin configuration": { + "$ref": "./examples/NetworkManagerSecurityAdminConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections": { + "get": { + "tags": [ + "AdminRuleCollections" + ], + "operationId": "AdminRuleCollections_List", + "description": "Lists all the rule collections in a security admin configuration, in a paginated format.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all ruleCollections in the specified security configuration, in a paginated format", + "schema": { + "$ref": "#/definitions/AdminRuleCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List security admin rule collections": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + } + ], + "get": { + "tags": [ + "AdminRuleCollections" + ], + "description": "Gets a network manager security admin configuration rule collection.", + "operationId": "AdminRuleCollections_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets security admin rule collection": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionGet.json" + } + } + }, + "put": { + "tags": [ + "AdminRuleCollections" + ], + "description": "Creates or updates an admin rule collection.", + "operationId": "AdminRuleCollections_CreateOrUpdate", + "parameters": [ + { + "name": "ruleCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + }, + "description": "The Rule Collection to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Rule Collection", + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + } + }, + "201": { + "description": "Created Rule Collection", + "schema": { + "$ref": "#/definitions/AdminRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update an admin rule collection": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionPut.json" + } + } + }, + "delete": { + "tags": [ + "AdminRuleCollections" + ], + "description": "Deletes an admin rule collection.", + "operationId": "AdminRuleCollections_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes an admin rule collection": { + "$ref": "./examples/NetworkManagerAdminRuleCollectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "get": { + "tags": [ + "AdminRules" + ], + "description": "List all network manager security configuration admin rules.", + "operationId": "AdminRules_List", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/AdminRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "List security admin rules": { + "$ref": "./examples/NetworkManagerAdminRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityAdminConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationsRuleParameter" + } + ], + "get": { + "tags": [ + "AdminRules" + ], + "description": "Gets a network manager security configuration admin rule.", + "operationId": "AdminRules_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/BaseAdminRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets security admin rule": { + "$ref": "./examples/NetworkManagerAdminRuleGet.json" + }, + "Gets security default admin rule": { + "$ref": "./examples/NetworkManagerDefaultAdminRuleGet.json" + } + } + }, + "put": { + "tags": [ + "AdminRules" + ], + "description": "Creates or updates an admin rule.", + "operationId": "AdminRules_CreateOrUpdate", + "parameters": [ + { + "name": "adminRule", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BaseAdminRule" + }, + "description": "The admin rule to create or update" + } + ], + "responses": { + "200": { + "description": "Updated rule", + "schema": { + "$ref": "#/definitions/BaseAdminRule" + } + }, + "201": { + "description": "Created rule", + "schema": { + "$ref": "#/definitions/BaseAdminRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "Create an admin rule": { + "$ref": "./examples/NetworkManagerAdminRulePut.json" + }, + "Create a admin rule with network group as source or destination": { + "$ref": "./examples/NetworkManagerAdminRulePut_NetworkGroupSource.json" + } + } + }, + "delete": { + "tags": [ + "AdminRules" + ], + "description": "Deletes an admin rule.", + "operationId": "AdminRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes an admin rule": { + "$ref": "./examples/NetworkManagerAdminRuleDelete.json" + } + } + } + } + }, + "definitions": { + "SecurityAdminConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityAdminConfigurationPropertiesFormat", + "description": "Indicates the properties for the network manager security admin configuration." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the security admin configuration" + }, + "SecurityAdminConfigurationPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the security configuration." + }, + "applyOnNetworkIntentPolicyBasedServices": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkIntentPolicyBasedService" + }, + "description": "Enum list of network intent policy based services." + }, + "networkGroupAddressSpaceAggregationOption": { + "type": "string", + "$ref": "#/definitions/AddressSpaceAggregationOption", + "description": "Determine update behavior for changes to network groups referenced within the rules in this configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Defines the security admin configuration properties." + }, + "SecurityAdminConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityAdminConfiguration" + }, + "description": "Gets a page of security admin configurations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "A list of network manager security admin configurations" + }, + "AdminRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BaseAdminRule" + }, + "description": "A list of admin rules" + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "security configuration admin rule list result." + }, + "AdminRuleCollectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AdminRuleCollection" + }, + "description": "A list of network manager security admin configuration rule collections" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Security admin configuration rule collection list result." + }, + "AdminRuleCollection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AdminRuleCollectionPropertiesFormat", + "description": "Indicates the properties for the network manager admin rule collection." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the admin rule collection." + }, + "AdminRuleCollectionPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the admin rule collection." + }, + "appliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "#/definitions/NetworkManagerSecurityGroupItem" + }, + "description": "Groups for configuration" + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "appliesToGroups" + ], + "description": "Defines the admin rule collection properties." + }, + "BaseAdminRule": { + "type": "object", + "properties": { + "kind": { + "type": "string", + "description": "Whether the rule is custom or default.", + "enum": [ + "Custom", + "Default" + ], + "x-ms-enum": { + "name": "AdminRuleKind", + "modelAsString": true + } + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "required": [ + "kind" + ], + "discriminator": "kind", + "description": "Network base admin rule." + }, + "AdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseAdminRule" + } + ], + "description": "Network admin rule.", + "x-ms-discriminator-value": "Custom" + }, + "AdminPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "$ref": "#/definitions/RuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sources": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The CIDR or source IP ranges." + }, + "destinations": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityConfigurationRuleAccess", + "description": "Indicates the access allowed for this particular rule" + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 4096, + "description": "The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityConfigurationRuleDirection", + "description": "Indicates if the traffic matched against the rule in inbound or outbound." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "protocol", + "access", + "direction", + "priority" + ], + "description": "Security admin rule resource." + }, + "DefaultAdminRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DefaultAdminPropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security admin rule" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BaseAdminRule" + } + ], + "description": "Network default admin rule.", + "x-ms-discriminator-value": "Default" + }, + "DefaultAdminPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "readOnly": true, + "description": "A description for this rule. Restricted to 140 chars." + }, + "flag": { + "type": "string", + "description": "Default rule flag." + }, + "protocol": { + "type": "string", + "readOnly": true, + "$ref": "#/definitions/RuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sources": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "readOnly": true, + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The CIDR or source IP ranges." + }, + "destinations": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "readOnly": true, + "items": { + "$ref": "#/definitions/AddressPrefixItem" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "readOnly": true, + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityConfigurationRuleAccess", + "readOnly": true, + "description": "Indicates the access allowed for this particular rule" + }, + "priority": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityConfigurationRuleDirection", + "readOnly": true, + "description": "Indicates if the traffic matched against the rule in inbound or outbound." + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Security default admin rule resource." + }, + "ProvisioningState": { + "description": "Provisioning states of a resource.", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "SecurityConfigurationRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny", + "AlwaysAllow" + ], + "x-ms-enum": { + "name": "SecurityConfigurationRuleAccess", + "modelAsString": true + } + }, + "SecurityConfigurationRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if the rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityConfigurationRuleDirection", + "modelAsString": true + } + }, + "RuleProtocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "Esp", + "Any", + "Ah" + ], + "x-ms-enum": { + "name": "SecurityConfigurationRuleProtocol", + "modelAsString": true + } + }, + "NetworkManagerSecurityGroupItem": { + "type": "object", + "properties": { + "networkGroupId": { + "type": "string", + "description": "Network manager group Id." + } + }, + "required": [ + "networkGroupId" + ], + "description": "Network manager security group item." + }, + "AddressPrefixItem": { + "type": "object", + "properties": { + "addressPrefix": { + "type": "string", + "description": "Address prefix." + }, + "addressPrefixType": { + "type": "string", + "description": "Address prefix type.", + "enum": [ + "IPPrefix", + "ServiceTag", + "NetworkGroup" + ], + "x-ms-enum": { + "name": "AddressPrefixType", + "modelAsString": true + } + } + }, + "description": "Address prefix item." + }, + "NetworkIntentPolicyBasedService": { + "type": "string", + "description": "Network intent policy based services.", + "enum": [ + "None", + "All", + "AllowRulesOnly" + ], + "x-ms-enum": { + "name": "NetworkIntentPolicyBasedService", + "modelAsString": true + } + }, + "AddressSpaceAggregationOption": { + "type": "string", + "description": "Option indicating the update behavior of a resource's address prefixes referenced within a network manager configuration.", + "enum": [ + "None", + "Manual" + ], + "x-ms-enum": { + "name": "AddressSpaceAggregationOption", + "modelAsString": true + } + } + }, + "parameters": { + "SecurityConfigurationParameter": { + "name": "configurationName", + "in": "path", + "description": "The name of the network manager Security Configuration.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleCollectionParameter": { + "name": "ruleCollectionName", + "in": "path", + "description": "The name of the network manager security Configuration rule collection.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SecurityConfigurationsRuleParameter": { + "name": "ruleName", + "in": "path", + "description": "The name of the rule.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerSecurityUserConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerSecurityUserConfiguration.json new file mode 100644 index 000000000000..7728355fa761 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkManagerSecurityUserConfiguration.json @@ -0,0 +1,920 @@ +{ + "swagger": "2.0", + "info": { + "title": "SecurityUserConfiguration", + "version": "2025-03-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.Network/networkManagers/{networkManagerName}/securityUserConfigurations": { + "get": { + "tags": [ + "SecurityUserConfigurations" + ], + "operationId": "SecurityUserConfigurations_List", + "description": "Lists all the network manager security user configurations in a network manager, in a paginated format.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all security user configurations in the specified network manager, in a paginated format", + "schema": { + "$ref": "#/definitions/SecurityUserConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List security user configurations in a network manager": { + "$ref": "./examples/NetworkManagerSecurityUserConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + } + ], + "get": { + "tags": [ + "SecurityUserConfigurations" + ], + "description": "Retrieves a network manager security user configuration.", + "operationId": "SecurityUserConfigurations_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/SecurityUserConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get security user configurations": { + "$ref": "./examples/NetworkManagerSecurityUserConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityUserConfigurations" + ], + "description": "Creates or updates a network manager security user configuration.", + "operationId": "SecurityUserConfigurations_CreateOrUpdate", + "parameters": [ + { + "name": "securityUserConfiguration", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityUserConfiguration" + }, + "description": "The security user configuration to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Configuration", + "schema": { + "$ref": "#/definitions/SecurityUserConfiguration" + } + }, + "201": { + "description": "Created Configuration", + "schema": { + "$ref": "#/definitions/SecurityUserConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network manager security user configuration": { + "$ref": "./examples/NetworkManagerSecurityUserConfigurationPut.json" + } + } + }, + "delete": { + "tags": [ + "SecurityUserConfigurations" + ], + "description": "Deletes a network manager security user configuration.", + "operationId": "SecurityUserConfigurations_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete network manager security user configuration": { + "$ref": "./examples/NetworkManagerSecurityUserConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections": { + "get": { + "tags": [ + "SecurityUserRuleCollections" + ], + "operationId": "SecurityUserRuleCollections_List", + "description": "Lists all the security user rule collections in a security configuration, in a paginated format.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Get successful. The operation returns all ruleCollections in the specified security configuration, in a paginated format", + "schema": { + "$ref": "#/definitions/SecurityUserRuleCollectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List rule collections in a security configuration": { + "$ref": "./examples/NetworkManagerSecurityUserRuleCollectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + } + ], + "get": { + "tags": [ + "SecurityUserRuleCollections" + ], + "description": "Gets a network manager security user configuration rule collection.", + "operationId": "SecurityUserRuleCollections_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/SecurityUserRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets security user rule collection": { + "$ref": "./examples/NetworkManagerSecurityUserRuleCollectionGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityUserRuleCollections" + ], + "description": "Creates or updates a security user rule collection.", + "operationId": "SecurityUserRuleCollections_CreateOrUpdate", + "parameters": [ + { + "name": "securityUserRuleCollection", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityUserRuleCollection" + }, + "description": "The Security User Rule Collection to create or update" + } + ], + "responses": { + "200": { + "description": "Updated Security User Rule Collection", + "schema": { + "$ref": "#/definitions/SecurityUserRuleCollection" + } + }, + "201": { + "description": "Created Security User Rule Collection", + "schema": { + "$ref": "#/definitions/SecurityUserRuleCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update a Security User Rule Collection": { + "$ref": "./examples/NetworkManagerSecurityUserRuleCollectionPut.json" + } + } + }, + "delete": { + "tags": [ + "SecurityUserRuleCollections" + ], + "description": "Deletes a Security User Rule collection.", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "operationId": "SecurityUserRuleCollections_Delete", + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Deletes a Security User Rule collection": { + "$ref": "./examples/NetworkManagerSecurityUserRuleCollectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "get": { + "tags": [ + "SecurityUserRules" + ], + "description": "Lists all Security User Rules in a rule collection.", + "operationId": "SecurityUserRules_List", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/SecurityUserRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List security user rules": { + "$ref": "./examples/NetworkManagerSecurityUserRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/securityUserConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkManagerNameParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationParameter" + }, + { + "$ref": "#/parameters/RuleCollectionParameter" + }, + { + "$ref": "#/parameters/SecurityConfigurationsRuleParameter" + } + ], + "get": { + "tags": [ + "SecurityUserRules" + ], + "description": "Gets a security user rule.", + "operationId": "SecurityUserRules_Get", + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/SecurityUserRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Gets a security user rule": { + "$ref": "./examples/NetworkManagerSecurityUserRuleGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityUserRules" + ], + "description": "Creates or updates a security user rule.", + "operationId": "SecurityUserRules_CreateOrUpdate", + "parameters": [ + { + "name": "securityUserRule", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityUserRule" + }, + "description": "The security user rule to create or update" + } + ], + "responses": { + "200": { + "description": "Updated security user rule", + "schema": { + "$ref": "#/definitions/SecurityUserRule" + } + }, + "201": { + "description": "Created rule", + "schema": { + "$ref": "#/definitions/SecurityUserRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a security user rule": { + "$ref": "./examples/NetworkManagerSecurityUserRulePut.json" + } + } + }, + "delete": { + "tags": [ + "SecurityUserRules" + ], + "description": "Deletes a security user rule.", + "operationId": "SecurityUserRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete a security user rule": { + "$ref": "./examples/NetworkManagerSecurityUserRuleDelete.json" + } + } + } + } + }, + "definitions": { + "SecurityUserConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityUserConfigurationPropertiesFormat", + "description": "Indicates the properties for the network manager security user configuration." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the security user configuration" + }, + "SecurityUserConfigurationPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the security user configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "description": "Defines the security user configuration properties." + }, + "SecurityUserConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityUserConfiguration" + }, + "description": "Gets a page of security user configurations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "A list of network manager security user configurations" + }, + "SecurityUserRuleCollectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityUserRuleCollection" + }, + "description": "A list of network manager security user configuration rule collections" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next set of results." + } + }, + "description": "Security user configuration rule collection list result." + }, + "SecurityUserRuleCollection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityUserRuleCollectionPropertiesFormat", + "description": "Indicates the properties for the network manager security user rule collection." + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Defines the security user rule collection." + }, + "SecurityUserRuleCollectionPropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of the security user rule collection." + }, + "appliesToGroups": { + "type": "array", + "x-ms-identifiers": [ + "networkGroupId" + ], + "items": { + "$ref": "#/definitions/SecurityUserGroupItem" + }, + "description": "Groups for configuration" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "appliesToGroups" + ], + "description": "Defines the security user rule collection properties." + }, + "SecurityUserGroupItem": { + "type": "object", + "properties": { + "networkGroupId": { + "type": "string", + "description": "Network manager group Id." + } + }, + "required": [ + "networkGroupId" + ], + "description": "Network manager security user group item." + }, + "SecurityUserRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityUserRule" + }, + "description": "A list of security user rules" + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "security user rule list result." + }, + "SecurityUserRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityUserRulePropertiesFormat", + "x-ms-client-flatten": true, + "description": "Indicates the properties of the security user rule" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/ChildResource" + } + ], + "description": "Network security user rule." + }, + "SecurityUserRulePropertiesFormat": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule." + }, + "protocol": { + "type": "string", + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/RuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sources": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "items": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/AddressPrefixItem" + }, + "description": "The CIDR or source IP ranges." + }, + "destinations": { + "type": "array", + "x-ms-identifiers": [ + "addressPrefix" + ], + "items": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/AddressPrefixItem" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "direction": { + "$ref": "./networkManagerSecurityAdminConfiguration.json#/definitions/SecurityConfigurationRuleDirection", + "description": "Indicates if the traffic matched against the rule in inbound or outbound." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the security configuration user rule resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "Unique identifier for this resource." + } + }, + "required": [ + "protocol", + "direction" + ], + "description": "Security rule resource." + } + }, + "parameters": { + "SecurityConfigurationParameter": { + "name": "configurationName", + "in": "path", + "description": "The name of the network manager Security Configuration.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleCollectionParameter": { + "name": "ruleCollectionName", + "in": "path", + "description": "The name of the network manager security Configuration rule collection.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SecurityConfigurationsRuleParameter": { + "name": "ruleName", + "in": "path", + "description": "The name of the rule.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NetworkManagerNameParameter": { + "name": "networkManagerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network manager.", + "pattern": "^[a-zA-Z0-9_.-]*$", + "x-ms-parameter-location": "method" + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "force", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkProfile.json new file mode 100644 index 000000000000..fe658abfa210 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkProfile.json @@ -0,0 +1,622 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/networkProfiles/{networkProfileName}": { + "delete": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Delete", + "description": "Deletes the specified network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NetworkProfile." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network profile": { + "$ref": "./examples/NetworkProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Get", + "description": "Gets the specified network profile in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network profile": { + "$ref": "./examples/NetworkProfileGetConfigOnly.json" + }, + "Get network profile with container network interfaces": { + "$ref": "./examples/NetworkProfileGetWithContainerNic.json" + } + } + }, + "put": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_CreateOrUpdate", + "description": "Creates or updates a network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "Parameters supplied to the create or update network profile operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network profile defaults": { + "$ref": "./examples/NetworkProfileCreateConfigOnly.json" + } + }, + "x-ms-long-running-operation": false + }, + "patch": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_UpdateTags", + "description": "Updates network profile tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network profile tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network profile tags": { + "$ref": "./examples/NetworkProfileUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_ListAll", + "description": "Gets all the network profiles in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network profiles": { + "$ref": "./examples/NetworkProfileListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_List", + "description": "Gets all network profiles in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group network profiles": { + "$ref": "./examples/NetworkProfileList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkProfilePropertiesFormat": { + "properties": { + "containerNetworkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterface" + }, + "description": "List of child container network interfaces." + }, + "containerNetworkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration" + }, + "description": "List of chid container network interface configurations." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network profile resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network profile resource." + } + }, + "description": "Network profile properties." + }, + "NetworkProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProfilePropertiesFormat", + "description": "Network profile properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network profile resource." + }, + "NetworkProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "A list of network profiles that exist in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkProfiles API service call." + }, + "ContainerNetworkInterfacePropertiesFormat": { + "properties": { + "containerNetworkInterfaceConfiguration": { + "readOnly": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration", + "description": "Container network interface configuration from which this container network interface is created." + }, + "container": { + "$ref": "#/definitions/Container", + "description": "Reference to the container to which this container network interface is attached." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfiguration" + }, + "description": "Reference to the ip configuration on this container nic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface resource." + } + }, + "description": "Properties of container network interface." + }, + "ContainerNetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfacePropertiesFormat", + "description": "Container network interface properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface child resource." + }, + "ContainerNetworkInterfaceConfigurationPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationProfile" + }, + "description": "A list of ip configurations of the container network interface configuration." + }, + "containerNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A list of container network interfaces created from this container network interface configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface configuration resource." + } + }, + "description": "Container network interface configuration properties." + }, + "ContainerNetworkInterfaceConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfigurationPropertiesFormat", + "description": "Container network interface configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface configuration child resource." + }, + "IPConfigurationProfilePropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource to create a container network interface ip configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration profile resource." + } + }, + "description": "IP configuration profile properties." + }, + "IPConfigurationProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationProfilePropertiesFormat", + "description": "Properties of the IP configuration profile." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration profile child resource." + }, + "Container": { + "properties": {}, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Reference to container resource in remote resource provider." + }, + "ContainerNetworkInterfaceIpConfigurationPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface IP configuration resource." + } + }, + "description": "Properties of the container network interface IP configuration." + }, + "ContainerNetworkInterfaceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", + "description": "Properties of the container network interface IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "The ip configuration for a container network interface." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkSecurityGroup.json new file mode 100644 index 000000000000..e5f977908ae8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkSecurityGroup.json @@ -0,0 +1,991 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/networkSecurityGroups/{networkSecurityGroupName}": { + "delete": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Delete", + "description": "Deletes the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network security group": { + "$ref": "./examples/NetworkSecurityGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Get", + "description": "Gets the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroupGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "description": "Creates or updates a network security group in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "Parameters supplied to the create or update network security group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network security group": { + "$ref": "./examples/NetworkSecurityGroupCreate.json" + }, + "Create network security group with rule": { + "$ref": "./examples/NetworkSecurityGroupCreateWithRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_UpdateTags", + "description": "Updates a network security group tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { + "$ref": "./examples/NetworkSecurityGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_ListAll", + "description": "Gets all network security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroupListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_List", + "description": "Gets all network security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "delete": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Delete", + "description": "Deletes the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network security rule from network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Get", + "description": "Get the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_CreateOrUpdate", + "description": "Creates or updates a security rule in the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "name": "securityRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "Parameters supplied to the create or update network security rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create security rule": { + "$ref": "./examples/NetworkSecurityGroupRuleCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_List", + "description": "Gets all security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_List", + "description": "Gets all default security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleList": { + "$ref": "./examples/DefaultSecurityRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_Get", + "description": "Get the specified default network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "defaultSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the default security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleGet": { + "$ref": "./examples/DefaultSecurityRuleGet.json" + } + } + } + } + }, + "definitions": { + "SecurityRulePropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "Esp", + "*", + "Ah" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "sourceApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as source." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "destinationApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as destination." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the security rule resource." + } + }, + "required": [ + "protocol", + "access", + "priority", + "direction" + ], + "description": "Security rule resource." + }, + "SecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityRulePropertiesFormat", + "description": "Properties of the security rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network security rule." + }, + "SecurityRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The security rules in a network security group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group." + }, + "NetworkSecurityGroupPropertiesFormat": { + "properties": { + "flushConnection": { + "type": "boolean", + "description": "When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation." + }, + "securityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "A collection of security rules of the network security group." + }, + "defaultSecurityRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The default security rules of network security group." + }, + "networkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "A collection of references to network interfaces." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "flowLogs": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkWatcher.json#/definitions/FlowLog" + }, + "description": "A collection of references to flow log resources." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network security group resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network security group resource." + } + }, + "description": "Network Security Group resource." + }, + "NetworkSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat", + "description": "Properties of the network security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkSecurityGroup resource." + }, + "NetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "A list of NetworkSecurityGroup resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkSecurityGroups API service call." + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkSecurityPerimeter.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkSecurityPerimeter.json new file mode 100644 index 000000000000..3e4c0be98141 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkSecurityPerimeter.json @@ -0,0 +1,2454 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkSecurityPerimeter", + "description": "The Network Security Perimeter API provides a RESTful set of web services that interact with network security perimeter resource.", + "version": "2025-03-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.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_Get", + "description": "Gets the specified network security perimeter by the name.", + "responses": { + "200": { + "description": "Request is successful. Returns the resulting network security perimeter resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSecurityPerimeterGet": { + "$ref": "./examples/NetworkSecurityPerimeterGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_CreateOrUpdate", + "description": "Creates or updates a Network Security Perimeter.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "description": "Parameter supplied to create or update the network security perimeter." + } + ], + "responses": { + "200": { + "description": "Resource Updated. Returns the network security perimeter.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "201": { + "description": "Resource Created. Returns the network security perimeter.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Put Network Security Perimeter": { + "$ref": "./examples/NetworkSecurityPerimeterPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_Delete", + "parameters": [ + { + "$ref": "#/parameters/ForceDeleteParameter" + } + ], + "description": "Deletes a network security perimeter.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Delete in progress.", + "headers": { + "Azure-AsyncOperation": { + "description": "Azure async operation header", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "NetworkSecurityPerimeterDelete": { + "$ref": "./examples/NetworkSecurityPerimeterDelete.json" + } + } + }, + "patch": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_Patch", + "description": "Patch Tags for a Network Security Perimeter.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateTagsRequest" + }, + "description": "Parameter supplied to the network security perimeter." + } + ], + "responses": { + "200": { + "description": "Request is successful. Returns the resulting network security perimeter resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Patch Network Security Perimeter": { + "$ref": "./examples/NetworkSecurityPerimeterPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityPerimeters": { + "get": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_ListBySubscription", + "description": "List all network security perimeters in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. Returns the list of the network security perimeters.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkSecurityPerimetersList": { + "$ref": "./examples/NetworkSecurityPerimeterListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters": { + "get": { + "tags": [ + "NetworkSecurityPerimeters" + ], + "operationId": "NetworkSecurityPerimeters_List", + "description": "List network security perimeters in a resource group.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Request is successful. Returns a list of network security perimeters.", + "schema": { + "$ref": "#/definitions/NetworkSecurityPerimeterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Network Security Perimeter": { + "$ref": "./examples/NetworkSecurityPerimeterList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterProfiles" + ], + "operationId": "NetworkSecurityPerimeterProfiles_Get", + "description": "Gets the specified NSP profile.", + "responses": { + "200": { + "description": "OK - Returns information about the NSP profile.", + "schema": { + "$ref": "#/definitions/NspProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspProfilesGet": { + "$ref": "./examples/NspProfileGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeterProfiles" + ], + "operationId": "NetworkSecurityPerimeterProfiles_CreateOrUpdate", + "description": "Creates or updates a network profile.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspProfile" + }, + "description": "Parameters that hold the NspProfile resource to be created/updated." + } + ], + "responses": { + "200": { + "description": "Update - Profile is immutable resource. Returns the existing profile resource.", + "schema": { + "$ref": "#/definitions/NspProfile" + } + }, + "201": { + "description": "Create - Returns the NspProfile resource created.", + "schema": { + "$ref": "#/definitions/NspProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspProfilesPut": { + "$ref": "./examples/NspProfilePut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeterProfiles" + ], + "operationId": "NetworkSecurityPerimeterProfiles_Delete", + "description": "Deletes an NSP profile.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspProfilesDelete": { + "$ref": "./examples/NspProfileDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles": { + "get": { + "tags": [ + "NetworkSecurityPerimeterProfiles" + ], + "operationId": "NetworkSecurityPerimeterProfiles_List", + "description": "Lists the NSP profiles in the specified network security perimeter.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the list of NSP profiles.", + "schema": { + "$ref": "#/definitions/NspProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspProfilesList": { + "$ref": "./examples/NspProfileList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules/{accessRuleName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "#/parameters/AccessRuleNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterAccessRules" + ], + "operationId": "NetworkSecurityPerimeterAccessRules_Get", + "description": "Gets the specified NSP access rule by name.", + "responses": { + "200": { + "description": "OK - Returns information about the NSP access rule.", + "schema": { + "$ref": "#/definitions/NspAccessRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAccessRuleGet": { + "$ref": "./examples/NspAccessRuleGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeterAccessRules" + ], + "operationId": "NetworkSecurityPerimeterAccessRules_CreateOrUpdate", + "description": "Creates or updates a network access rule.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspAccessRule" + }, + "description": "Parameters that hold the NspAccessRule resource to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Existing access rule is updated. Returns the resource.", + "schema": { + "$ref": "#/definitions/NspAccessRule" + } + }, + "201": { + "description": "Create - Returns the NspAccessRule resource created.", + "schema": { + "$ref": "#/definitions/NspAccessRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAccessRulePut": { + "$ref": "./examples/NspAccessRulePut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeterAccessRules" + ], + "operationId": "NetworkSecurityPerimeterAccessRules_Delete", + "description": "Deletes an NSP access rule.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAccessRulesDelete": { + "$ref": "./examples/NspAccessRuleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules": { + "get": { + "tags": [ + "NetworkSecurityPerimeterAccessRules" + ], + "operationId": "NetworkSecurityPerimeterAccessRules_List", + "description": "Lists the NSP access rules in the specified NSP profile.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the list of NSP access rules.", + "schema": { + "$ref": "#/definitions/NspAccessRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAccessRulesList": { + "$ref": "./examples/NspAccessRuleList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations/{associationName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/AssociationNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterAssociations" + ], + "operationId": "NetworkSecurityPerimeterAssociations_Get", + "description": "Gets the specified NSP association by name.", + "responses": { + "200": { + "description": "OK - Returns information about the NSP resource association.", + "schema": { + "$ref": "#/definitions/NspAssociation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAssociationGet": { + "$ref": "./examples/NspAssociationGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeterAssociations" + ], + "operationId": "NetworkSecurityPerimeterAssociations_CreateOrUpdate", + "description": "Creates or updates a NSP resource association.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspAssociation" + }, + "description": "Parameters that hold the NspAssociation resource to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Existing resource association is updated. Returns the resource.", + "schema": { + "$ref": "#/definitions/NspAssociation" + } + }, + "201": { + "description": "Create - Returns the NspAssociation resource created.", + "schema": { + "$ref": "#/definitions/NspAssociation" + } + }, + "202": { + "description": "Accepted - Returns the NspAssociation resource created.", + "schema": { + "$ref": "#/definitions/NspAssociation" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "Azure async operation header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "NspAssociationPut": { + "$ref": "./examples/NspAssociationPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeterAssociations" + ], + "operationId": "NetworkSecurityPerimeterAssociations_Delete", + "description": "Deletes an NSP association resource.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Delete in progress.", + "headers": { + "Azure-AsyncOperation": { + "description": "Azure async operation header", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "NspAssociationDelete": { + "$ref": "./examples/NspAssociationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations": { + "get": { + "tags": [ + "NetworkSecurityPerimeterAssociations" + ], + "operationId": "NetworkSecurityPerimeterAssociations_List", + "description": "Lists the NSP resource associations.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the list of NSP resource associations.", + "schema": { + "$ref": "#/definitions/NspAssociationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAssociationList": { + "$ref": "./examples/NspAssociationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations/{associationName}/reconcile": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/AssociationNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "NetworkSecurityPerimeterAssociations" + ], + "operationId": "NetworkSecurityPerimeterAssociations_Reconcile", + "description": "Reconcile NSP association", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspAssociationReconcile" + }, + "description": "Parameters for NSP association reconcile" + } + ], + "responses": { + "200": { + "description": "Reconcile NSP association.", + "schema": { + "$ref": "#/definitions/NspAssociationReconcile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAssociationReconcile": { + "$ref": "./examples/NspAssociationReconcile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes": { + "get": { + "tags": [ + "NetworkSecurityPerimeterAssociableResourceTypes" + ], + "operationId": "NetworkSecurityPerimeterAssociableResourceTypes_List", + "description": "Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of resources that are onboarded with network security perimeter feature.", + "schema": { + "$ref": "#/definitions/PerimeterAssociableResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSecurityPerimeterAssociableResourceTypes": { + "$ref": "./examples/PerimeterAssociableResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules/{accessRuleName}/reconcile": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/ProfileNameParameter" + }, + { + "$ref": "#/parameters/AccessRuleNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "post": { + "tags": [ + "NetworkSecurityPerimeterAccessRules" + ], + "operationId": "NetworkSecurityPerimeterAccessRules_Reconcile", + "description": "Reconcile NSP access rules", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspAccessRuleReconcile" + }, + "description": "Parameters for NSP access rule reconcile" + } + ], + "responses": { + "200": { + "description": "Reconcile NSP access rule.", + "schema": { + "$ref": "#/definitions/NspAccessRuleReconcile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspAccessRuleReconcile": { + "$ref": "./examples/NspAccessRuleReconcile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/links/{linkName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/LinkNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterLinks" + ], + "operationId": "NetworkSecurityPerimeterLinks_Get", + "description": "Gets the specified NSP link resource.", + "responses": { + "200": { + "description": "OK - Returns NSP link resource.", + "schema": { + "$ref": "#/definitions/NspLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLinksGet": { + "$ref": "./examples/NspLinkGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeterLinks" + ], + "operationId": "NetworkSecurityPerimeterLinks_CreateOrUpdate", + "description": "Creates or updates NSP link resource.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspLink" + }, + "description": "Parameters that hold the NspLink resource to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Existing NspLink resource is updated. Returns the resource.", + "schema": { + "$ref": "#/definitions/NspLink" + } + }, + "201": { + "description": "Create - Returns the NspLink resource created.", + "schema": { + "$ref": "#/definitions/NspLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLinksPut": { + "$ref": "./examples/NspLinkPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeterLinks" + ], + "operationId": "NetworkSecurityPerimeterLinks_Delete", + "description": "Deletes an NSP Link resource.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Delete in progress.", + "headers": { + "location": { + "description": "location header", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NspLinkDelete": { + "$ref": "./examples/NspLinkDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/links": { + "get": { + "tags": [ + "NetworkSecurityPerimeterLinks" + ], + "operationId": "NetworkSecurityPerimeterLinks_List", + "description": "Lists the NSP Link resources in the specified network security perimeter.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the list of NSP link resources.", + "schema": { + "$ref": "#/definitions/NspLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLinkList": { + "$ref": "./examples/NspLinkList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkReferences/{linkReferenceName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/LinkReferenceNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterLinkReferences" + ], + "operationId": "NetworkSecurityPerimeterLinkReferences_Get", + "description": "Gets the specified NSP linkReference resource.", + "responses": { + "200": { + "description": "OK - Returns the NSP linkReference resource.", + "schema": { + "$ref": "#/definitions/NspLinkReference" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLinkReferencesGet": { + "$ref": "./examples/NspLinkReferenceGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeterLinkReferences" + ], + "operationId": "NetworkSecurityPerimeterLinkReferences_Delete", + "description": "Deletes an NSP LinkReference resource.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "202": { + "description": "Delete in progress.", + "headers": { + "location": { + "description": "location header", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. The resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NspLinkReferenceDelete": { + "$ref": "./examples/NspLinkReferenceDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkReferences": { + "get": { + "tags": [ + "NetworkSecurityPerimeterLinkReferences" + ], + "operationId": "NetworkSecurityPerimeterLinkReferences_List", + "description": "Lists the NSP LinkReference resources in the specified network security perimeter.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTopParameter" + }, + { + "$ref": "#/parameters/ListSkipTokenParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the list of NSP linkReference resources.", + "schema": { + "$ref": "#/definitions/NspLinkReferenceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLinkReferenceList": { + "$ref": "./examples/NspLinkReferenceList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/loggingConfigurations/{loggingConfigurationName}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "#/parameters/LoggingConfigurationNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterLoggingConfigurations" + ], + "operationId": "NetworkSecurityPerimeterLoggingConfigurations_Get", + "description": "Gets the NSP logging configuration.", + "responses": { + "200": { + "description": "OK - Returns NSP logging configuration.", + "schema": { + "$ref": "#/definitions/NspLoggingConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLoggingConfigurationGet": { + "$ref": "./examples/NspLoggingConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityPerimeterLoggingConfigurations" + ], + "operationId": "NetworkSecurityPerimeterLoggingConfigurations_CreateOrUpdate", + "description": "Creates or updates NSP logging configuration.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NspLoggingConfiguration" + }, + "description": "Parameters that hold the NspLoggingConfiguration to be created/updated." + } + ], + "responses": { + "200": { + "description": "Updated - Existing NspLoggingConfiguration is updated. Returns the logging configuration.", + "schema": { + "$ref": "#/definitions/NspLoggingConfiguration" + } + }, + "201": { + "description": "Create - Returns the NspLoggingConfiguration resource created.", + "schema": { + "$ref": "#/definitions/NspLoggingConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLoggingConfigurationPut": { + "$ref": "./examples/NspLoggingConfigurationPut.json" + } + } + }, + "delete": { + "tags": [ + "NetworkSecurityPerimeterLoggingConfigurations" + ], + "operationId": "NetworkSecurityPerimeterLoggingConfigurations_Delete", + "description": "Deletes an NSP Logging configuration.", + "responses": { + "200": { + "description": "Delete Succeed." + }, + "204": { + "description": "Request successful. The logging configuration does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLoggingConfigurationDelete": { + "$ref": "./examples/NspLoggingConfigurationDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/loggingConfigurations": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkSecurityPerimeterNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterLoggingConfigurations" + ], + "operationId": "NetworkSecurityPerimeterLoggingConfigurations_List", + "description": "Lists the NSP logging configuration.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK - Returns the list of NSP logging configuration.", + "schema": { + "$ref": "#/definitions/NspLoggingConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspLoggingConfigurationList": { + "$ref": "./examples/NspLoggingConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/networkSecurityPerimeterOperationStatuses/{operationId}": { + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "get": { + "tags": [ + "NetworkSecurityPerimeterOperationStatuses" + ], + "operationId": "NetworkSecurityPerimeterOperationStatuses_Get", + "description": "Gets the operation status for the given operation id.", + "responses": { + "200": { + "description": "OK - Returns information about the Nsp operation.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/OperationStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NspOperationStatusGet": { + "$ref": "./examples/NspOperationStatusGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/nspServiceTags": { + "get": { + "tags": [ + "NetworkSecurityPerimeterServiceTags" + ], + "operationId": "NetworkSecurityPerimeterServiceTags_List", + "description": "Gets the list of service tags supported by NSP. These service tags can be used to create access rules in NSP.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of service tags supported by NSP.", + "schema": { + "$ref": "#/definitions/NspServiceTagsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NSPServiceTagsList": { + "$ref": "./examples/NspServiceTagsList.json" + } + } + } + } + }, + "definitions": { + "NetworkSecurityPerimeter": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityPerimeterProperties", + "description": "The network security perimeter properties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" + } + ], + "description": "The Network Security Perimeter resource" + }, + "NetworkSecurityPerimeterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityPerimeter" + }, + "description": "Gets a page of NetworkSecurityPerimeter" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NetworkSecurityPerimeter. It contains a list of network security perimeters and a URL link to get the next set of results." + }, + "NetworkSecurityPerimeterProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/NSPProvisioningState", + "description": "The provisioning state of the scope assignment resource." + }, + "perimeterGuid": { + "readOnly": true, + "type": "string", + "description": "perimeter guid of the network security perimeter." + } + }, + "description": "Properties of network security perimeter." + }, + "UpdateTagsRequest": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityPerimeters" + } + ] + }, + "description": "Network security perimeter identifier." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "List of tags for Network Security Perimeter" + } + }, + "description": "Update tags request." + }, + "NspProfile": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NspProfileProperties", + "description": "Properties of the network security perimeter profile" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "description": "The network security perimeter profile resource" + }, + "NspProfileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspProfile" + }, + "description": "Gets a page of NSP profile" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP profiles. Contains a list of NSP profiles and a URL link to get the next set of results." + }, + "NspProfileProperties": { + "type": "object", + "properties": { + "accessRulesVersion": { + "readOnly": true, + "type": "string", + "description": "Version number that increases with every update to access rules within the profile." + }, + "diagnosticSettingsVersion": { + "readOnly": true, + "type": "string", + "description": "Version number that increases with every update to diagnostic settings within the profile." + } + }, + "description": "Properties of NSP profile." + }, + "NspAccessRule": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NspAccessRuleProperties", + "description": "Properties of the NSP access rule." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "description": "The NSP access rule resource" + }, + "NspAccessRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspAccessRule" + }, + "description": "Gets a page of NSP access rule" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP access rules. Contains a list of NSP access rules and a URL link to get the next set of results." + }, + "NspAccessRuleProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/NSPProvisioningState", + "description": "The provisioning state of the scope assignment resource." + }, + "direction": { + "type": "string", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "AccessRuleDirection", + "modelAsString": true + }, + "description": "Direction that specifies whether the access rules is inbound/outbound." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Inbound address prefixes (IPv4/IPv6)" + }, + "fullyQualifiedDomainNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Outbound rules in fully qualified domain name format." + }, + "subscriptions": { + "type": "array", + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionId" + }, + "description": "List of subscription ids" + }, + "networkSecurityPerimeters": { + "readOnly": true, + "type": "array", + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PerimeterBasedAccessRule" + }, + "description": "Rule specified by the perimeter id." + }, + "emailAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Outbound rules in email address format. This access rule type is currently unavailable for use." + }, + "phoneNumbers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Outbound rules in phone number format. This access rule type is currently unavailable for use." + }, + "serviceTags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Inbound rules of type service tag. This access rule type is currently unavailable for use." + } + }, + "description": "Properties of NSP access rule." + }, + "SubscriptionId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Resources/subscriptions" + } + ] + }, + "description": "Subscription id in the ARM id format." + } + } + }, + "PerimeterBasedAccessRule": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityPerimeters" + } + ] + }, + "description": "NSP id in the ARM id format." + }, + "perimeterGuid": { + "readOnly": true, + "type": "string", + "description": "Resource guid of the NSP supplied." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the NSP supplied." + } + } + }, + "NspAssociation": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NspAssociationProperties", + "description": "Properties of the NSP resource association." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "description": "The NSP resource association resource" + }, + "NspAssociationsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspAssociation" + }, + "description": "Gets a page of NSP resource associations" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP resource associations. Contains a list of NSP resource associations and a URL link to get the next set of results." + }, + "NspAssociationProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/NSPProvisioningState", + "description": "The provisioning state of the resource association resource." + }, + "privateLinkResource": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The PaaS resource to be associated." + }, + "profile": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Profile id to which the PaaS resource is associated." + }, + "accessMode": { + "type": "string", + "enum": [ + "Learning", + "Enforced", + "Audit" + ], + "x-ms-enum": { + "name": "AssociationAccessMode", + "modelAsString": true + }, + "description": "Access mode on the association." + }, + "hasProvisioningIssues": { + "readOnly": true, + "type": "string", + "description": "Specifies if there are provisioning issues" + } + } + }, + "NspAssociationReconcile": { + "type": "object", + "properties": {}, + "description": "Request object for NSP association." + }, + "PerimeterAssociableResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PerimeterAssociableResourceProperties", + "description": "Properties of the perimeter associable resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Identifier of the perimeter associable resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "description": "Resource that is onboarded to use network security perimeter. Also referred as perimeter associable resource." + }, + "PerimeterAssociableResourcesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PerimeterAssociableResource" + }, + "description": "Gets paged list of perimeter associable resources." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Paged list of perimeter associable resources." + }, + "PerimeterAssociableResourceProperties": { + "type": "object", + "properties": { + "displayName": { + "readOnly": true, + "type": "string", + "description": "A friendly name for the properties of perimeter associable resources." + }, + "resourceType": { + "readOnly": true, + "type": "string", + "description": "Resource type/provider name." + }, + "publicDnsZones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "Public DNS zone names of the resources." + } + }, + "description": "Properties of the perimeter associable resources." + }, + "NSPProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Accepted", + "Failed" + ], + "x-ms-enum": { + "name": "nspProvisioningState", + "modelAsString": true + } + }, + "NSPLinkProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state of NSP Link/LinkReference.", + "enum": [ + "Succeeded", + "Creating", + "Updating", + "Deleting", + "Accepted", + "Failed", + "WaitForRemoteCompletion" + ], + "x-ms-enum": { + "name": "nspLinkProvisioningState", + "modelAsString": true + } + }, + "NspAccessRuleReconcile": { + "type": "object", + "properties": {}, + "description": "Request object for NSP reconcile." + }, + "NspLink": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NspLinkProperties", + "description": "Properties of the network security perimeter link resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "description": "The network security perimeter link resource" + }, + "NspLinkListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspLink" + }, + "description": "Gets a page of NSP Link resources." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP link resources. Contains a list of NSP link resources and a URL link to get the next set of results." + }, + "NspLinkProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/NSPLinkProvisioningState", + "description": "The provisioning state of the NSP Link resource." + }, + "autoApprovedRemotePerimeterResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityPerimeters" + } + ] + }, + "description": "Perimeter ARM Id for the remote NSP with which the link gets created in Auto-approval mode. It should be used when the NSP admin have Microsoft.Network/networkSecurityPerimeters/linkPerimeter/action permission on the remote NSP resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remotePerimeterGuid": { + "readOnly": true, + "type": "string", + "description": "Remote NSP Guid with which the link gets created." + }, + "remotePerimeterLocation": { + "readOnly": true, + "type": "string", + "description": "Remote NSP location with which the link gets created." + }, + "localInboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.", + "uniqueItems": true + }, + "localOutboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.", + "uniqueItems": true + }, + "remoteInboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Remote Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles. This property can only be updated in auto-approval mode.", + "uniqueItems": true + }, + "remoteOutboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Remote Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.", + "uniqueItems": true + }, + "description": { + "type": "string", + "description": "A message passed to the owner of the remote NSP link resource with this connection request. In case of Auto-approved flow, it is default to 'Auto Approved'. Restricted to 140 chars." + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The NSP link state.", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "nspLinkStatus", + "modelAsString": true + } + } + }, + "description": "Properties of NSP Link resource." + }, + "NspLinkReference": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NspLinkReferenceProperties", + "description": "Properties of the network security perimeter linkReference resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ], + "description": "The network security perimeter linkReference resource" + }, + "NspLinkReferenceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspLinkReference" + }, + "description": "Gets a page of NSP LinkReference resources." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP linkReference resources. Contains a list of NSP linkReference resources and a URL link to get the next set of results." + }, + "NspLinkReferenceProperties": { + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/NSPLinkProvisioningState", + "description": "The provisioning state of the NSP LinkReference resource." + }, + "remotePerimeterResourceId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/networkSecurityPerimeters" + } + ] + }, + "description": "Perimeter ARM Id for the remote NSP with which the link is created." + }, + "remotePerimeterGuid": { + "readOnly": true, + "type": "string", + "description": "Remote NSP Guid with which the link is created." + }, + "remotePerimeterLocation": { + "readOnly": true, + "type": "string", + "description": "Remote NSP location with which the link gets created." + }, + "localInboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Local Inbound profile names to which Inbound is allowed. Use ['*'] to allow inbound to all profiles.", + "uniqueItems": true + }, + "localOutboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Local Outbound profile names from which Outbound is allowed. In current version, it is readonly property and it's value is set to ['*'] to allow outbound from all profiles. In later version, user will be able to modify it.", + "uniqueItems": true + }, + "remoteInboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Remote Inbound profile names to which Inbound is allowed. ['*'] value implies inbound is allowed to all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter." + }, + "remoteOutboundProfiles": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Remote Outbound profile names from which Outbound is allowed. ['*'] value implies outbound is allowed from all profiles at remote perimeter. This property can only be updated from corresponding link resource present in remote perimeter." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "A message sent by the remote NSP link admin for connection request. In case of Auto-approved flow, it is default to 'Auto Approved'." + }, + "status": { + "type": "string", + "description": "The NSP linkReference state. It cannot be changed if link is created in auto-approval mode.", + "enum": [ + "Approved", + "Pending", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "nspLinkStatus", + "modelAsString": true + } + } + }, + "description": "Properties of NSP LinkReference resource." + }, + "NspLoggingConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NspLoggingConfigurationProperties", + "description": "Properties of the NSP logging configuration." + } + }, + "description": "The NSP logging configuration", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" + } + ] + }, + "NspLoggingConfigurationProperties": { + "type": "object", + "properties": { + "enabledLogCategories": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The log categories to enable in the NSP logging configuration." + }, + "version": { + "type": "string", + "description": "The version of the NSP logging configuration." + } + }, + "description": "The NSP logging configuration properties." + }, + "NspLoggingConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspLoggingConfiguration" + }, + "description": "Gets a page of NSP logging configuration" + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP logging configuration. Contains a list of NSP logging configurations and a URL link to get the next set of results." + }, + "NspServiceTagsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NspServiceTagsResource" + }, + "description": "Gets paged list of NSP service tags." + }, + "nextLink": { + "type": "string", + "description": "Gets the URL to get the next page of results." + } + }, + "description": "Result of the request to list NSP service tags." + }, + "NspServiceTagsResource": { + "type": "object", + "properties": { + "serviceTags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "NSP service tags." + } + }, + "description": "Resource containing list of NSP service tags." + } + }, + "parameters": { + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "NetworkSecurityPerimeterNameParameter": { + "name": "networkSecurityPerimeterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security perimeter.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "ProfileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NSP profile.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "AccessRuleNameParameter": { + "name": "accessRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NSP access rule.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "AssociationNameParameter": { + "name": "associationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NSP association.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "LinkNameParameter": { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NSP link.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "LinkReferenceNameParameter": { + "name": "linkReferenceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NSP linkReference.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "ListTopParameter": { + "name": "$top", + "description": "An optional query parameter which specifies the maximum number of records to be returned by the server.", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 20, + "x-ms-parameter-location": "method" + }, + "ListSkipTokenParameter": { + "name": "$skipToken", + "description": "SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "NetworkSecurityPerimeterProfileParameter": { + "name": "networkSecurityPerimeterProfile", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security perimeter profile.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of network security perimeter.", + "x-ms-parameter-location": "method" + }, + "LoggingConfigurationNameParameter": { + "name": "loggingConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NSP logging configuration. Accepts 'instance' as name.", + "x-ms-parameter-location": "method", + "pattern": "(^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*[a-zA-Z0-9_]+$)|(^[a-zA-Z0-9]$)", + "maxLength": 80 + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation id of the async operation.", + "x-ms-parameter-location": "method" + }, + "ForceDeleteParameter": { + "name": "forceDeletion", + "in": "query", + "required": false, + "type": "boolean", + "description": "Deletes the resource even if it contains any child associations.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkVerifier.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkVerifier.json new file mode 100644 index 000000000000..28743301ac30 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkVerifier.json @@ -0,0 +1,1300 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagerVerifierManagementClient", + "version": "2025-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisIntents": { + "get": { + "tags": [ + "ReachabilityAnalysisIntents" + ], + "summary": "Gets list of Reachability Analysis Intents .", + "operationId": "ReachabilityAnalysisIntents_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "query", + "name": "skipToken", + "description": "Optional skip token.", + "type": "string" + }, + { + "in": "query", + "name": "skip", + "description": "Optional num entries to skip.", + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "in": "query", + "name": "top", + "description": "Optional num entries to show.", + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "in": "query", + "name": "sortKey", + "description": "Optional key by which to sort.", + "type": "string" + }, + { + "in": "query", + "name": "sortValue", + "description": "Optional sort value for pagination.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of ReachabilityAnalysisIntents", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisIntentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ReachabilityAnalysisIntentList": { + "$ref": "./examples/ReachabilityAnalysisIntentList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisIntents/{reachabilityAnalysisIntentName}": { + "get": { + "tags": [ + "ReachabilityAnalysisIntents" + ], + "summary": "Get the Reachability Analysis Intent.", + "operationId": "ReachabilityAnalysisIntents_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "path", + "name": "reachabilityAnalysisIntentName", + "description": "Reachability Analysis Intent name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + } + ], + "responses": { + "200": { + "description": "Get a reachabilityAnalysisIntent", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisIntent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "ReachabilityAnalysisIntentGet": { + "$ref": "./examples/ReachabilityAnalysisIntentGet.json" + } + } + }, + "put": { + "tags": [ + "ReachabilityAnalysisIntents" + ], + "summary": "Creates Reachability Analysis Intent.", + "operationId": "ReachabilityAnalysisIntents_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "path", + "name": "reachabilityAnalysisIntentName", + "description": "Reachability Analysis Intent name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "body", + "name": "body", + "description": "Reachability Analysis Intent object to create/update.", + "required": true, + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisIntent" + } + } + ], + "responses": { + "200": { + "description": "ReachabilityAnalysisIntent updated.", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisIntent" + } + }, + "201": { + "description": "ReachabilityAnalysisIntent created.", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisIntent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "ReachabilityAnalysisIntentCreate": { + "$ref": "./examples/ReachabilityAnalysisIntentPut.json" + } + } + }, + "delete": { + "tags": [ + "ReachabilityAnalysisIntent" + ], + "summary": "Deletes Reachability Analysis Intent.", + "operationId": "ReachabilityAnalysisIntents_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "path", + "name": "reachabilityAnalysisIntentName", + "description": "Reachability Analysis Intent name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + } + ], + "responses": { + "200": { + "description": "ReachabilityAnalysisIntent was deleted." + }, + "204": { + "description": "ReachabilityAnalysisIntent delete request succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "ReachabilityAnalysisIntentDelete": { + "$ref": "./examples/ReachabilityAnalysisIntentDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns": { + "get": { + "tags": [ + "ReachabilityAnalysisRuns" + ], + "summary": "Gets list of Reachability Analysis Runs.", + "operationId": "ReachabilityAnalysisRuns_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "query", + "name": "skipToken", + "description": "Optional skip token.", + "type": "string" + }, + { + "in": "query", + "name": "skip", + "description": "Optional num entries to skip.", + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "in": "query", + "name": "top", + "description": "Optional num entries to show.", + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "in": "query", + "name": "sortKey", + "description": "Optional key by which to sort.", + "type": "string" + }, + { + "in": "query", + "name": "sortValue", + "description": "Optional sort value for pagination.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of ReachabilityAnalysisRuns", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisRunListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ReachabilityAnalysisRunList": { + "$ref": "./examples/ReachabilityAnalysisRunList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}/reachabilityAnalysisRuns/{reachabilityAnalysisRunName}": { + "get": { + "tags": [ + "ReachabilityAnalysisRuns" + ], + "summary": "Gets Reachability Analysis Run.", + "operationId": "ReachabilityAnalysisRuns_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "path", + "name": "reachabilityAnalysisRunName", + "description": "Reachability Analysis Run name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + } + ], + "responses": { + "200": { + "description": "Get a reachabilityAnalysisRun", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "ReachabilityAnalysisRunGet": { + "$ref": "./examples/ReachabilityAnalysisRunGet.json" + } + } + }, + "put": { + "tags": [ + "ReachabilityAnalysisRuns" + ], + "summary": "Creates Reachability Analysis Runs.", + "operationId": "ReachabilityAnalysisRuns_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "path", + "name": "reachabilityAnalysisRunName", + "description": "Reachability Analysis Run name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "body", + "name": "body", + "description": "Analysis Run resource object to create/update.", + "required": true, + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisRun" + } + } + ], + "responses": { + "200": { + "description": "ReachabilityAnalysisRun updated.", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisRun" + } + }, + "201": { + "description": "ReachabilityAnalysisRun created and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ReachabilityAnalysisRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "ReachabilityAnalysisRunCreate": { + "$ref": "./examples/ReachabilityAnalysisRunPut.json" + } + } + }, + "delete": { + "tags": [ + "ReachabilityAnalysisRuns" + ], + "summary": "Deletes Reachability Analysis Run.", + "operationId": "ReachabilityAnalysisRuns_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "path", + "name": "reachabilityAnalysisRunName", + "description": "Reachability Analysis Run name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + } + ], + "responses": { + "202": { + "description": "ReachabilityAnalysisRun delete request accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "ReachabilityAnalysisRun delete request succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ReachabilityAnalysisRunDelete": { + "$ref": "./examples/ReachabilityAnalysisRunDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces": { + "get": { + "tags": [ + "VerifierWorkspaces" + ], + "summary": "Gets list of Verifier Workspaces.", + "operationId": "VerifierWorkspaces_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "query", + "name": "skipToken", + "description": "Optional skip token.", + "type": "string" + }, + { + "in": "query", + "name": "skip", + "description": "Optional num entries to skip.", + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "in": "query", + "name": "top", + "description": "Optional num entries to show.", + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "in": "query", + "name": "sortKey", + "description": "Optional key by which to sort.", + "type": "string" + }, + { + "in": "query", + "name": "sortValue", + "description": "Optional sort value for pagination.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "List of VerifierWorkspaces.", + "schema": { + "$ref": "#/definitions/VerifierWorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VerifierWorkspaceList": { + "$ref": "./examples/VerifierWorkspaceList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/verifierWorkspaces/{workspaceName}": { + "get": { + "tags": [ + "VerifierWorkspaces" + ], + "summary": "Gets Verifier Workspace.", + "operationId": "VerifierWorkspaces_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + } + ], + "responses": { + "200": { + "description": "Get a VerifierWorkspace.", + "schema": { + "$ref": "#/definitions/VerifierWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "VerifierWorkspaceGet": { + "$ref": "./examples/VerifierWorkspaceGet.json" + } + } + }, + "put": { + "tags": [ + "VerifierWorkspaces" + ], + "summary": "Creates Verifier Workspace.", + "operationId": "VerifierWorkspaces_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "body", + "name": "body", + "description": "Verifier Workspace object to create/update.", + "required": true, + "schema": { + "$ref": "#/definitions/VerifierWorkspace" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + } + ], + "responses": { + "200": { + "description": "VerifierWorkspace updated.", + "schema": { + "$ref": "#/definitions/VerifierWorkspace" + } + }, + "201": { + "description": "VerifierWorkspace created.", + "schema": { + "$ref": "#/definitions/VerifierWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "VerifierWorkspaceCreate": { + "$ref": "./examples/VerifierWorkspacePut.json" + } + } + }, + "patch": { + "tags": [ + "VerifierWorkspaces" + ], + "summary": "Updates Verifier Workspace.", + "operationId": "VerifierWorkspaces_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "in": "body", + "name": "body", + "description": "Verifier Workspace object to create/update.", + "schema": { + "$ref": "#/definitions/VerifierWorkspaceUpdate" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + } + ], + "responses": { + "200": { + "description": "VerifierWorkspace updated.", + "schema": { + "$ref": "#/definitions/VerifierWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-examples": { + "VerifierWorkspacePatch": { + "$ref": "./examples/VerifierWorkspacePatch.json" + } + } + }, + "delete": { + "tags": [ + "VerifierWorkspaces" + ], + "summary": "Deletes Verifier Workspace.", + "operationId": "VerifierWorkspaces_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./networkManager.json#/parameters/NetworkManagerNameParameter" + }, + { + "in": "path", + "name": "workspaceName", + "description": "Workspace name.", + "required": true, + "type": "string", + "pattern": "^[0-9a-zA-Z]([0-9a-zA-Z_.-]{0,62}[0-9a-zA-Z_])?$" + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + } + ], + "responses": { + "202": { + "description": "VerifierWorkspace delete request accepted and will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "VerifierWorkspace delete request succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CommonErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VerifierWorkspaceDelete": { + "$ref": "./examples/VerifierWorkspaceDelete.json" + } + } + } + } + }, + "definitions": { + "IPTraffic": { + "required": [ + "sourceIps", + "destinationIps", + "sourcePorts", + "destinationPorts", + "protocols" + ], + "description": "IP traffic information.", + "type": "object", + "properties": { + "sourceIps": { + "type": "array", + "items": { + "type": "string", + "description": "Source IP address of the traffic.." + }, + "description": "List of source IP addresses of the traffic.." + }, + "destinationIps": { + "type": "array", + "items": { + "type": "string", + "description": "Destination IP address of the traffic.." + }, + "description": "List of destination IP addresses of the traffic.." + }, + "sourcePorts": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source ports of the traffic." + }, + "destinationPorts": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination ports of the traffic." + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkProtocol", + "description": "Network protocol this resource applies to." + } + } + } + }, + "IntentContent": { + "required": [ + "destinationResourceId", + "ipTraffic", + "sourceResourceId" + ], + "description": "Intent information.", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "sourceResourceId": { + "format": "arm-id", + "type": "string", + "description": "Source resource id of the intent." + }, + "destinationResourceId": { + "format": "arm-id", + "type": "string", + "description": "Destination resource id of the intent." + }, + "ipTraffic": { + "$ref": "#/definitions/IPTraffic", + "description": "IP traffic information." + } + } + }, + "NetworkProtocol": { + "enum": [ + "Any", + "TCP", + "UDP", + "ICMP" + ], + "x-ms-enum": { + "name": "NetworkProtocol", + "modelAsString": true + }, + "description": "Network Protocol.", + "type": "string" + }, + "ProvisioningState": { + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "description": "Provisioning states of a resource.", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "ReachabilityAnalysisIntentListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReachabilityAnalysisIntent" + }, + "description": "Gets a page of Reachability Analysis Intents" + }, + "nextLink": { + "description": "Gets the URL to get the next page of results.", + "type": "string" + } + }, + "description": "A list of Reachability Analysis Intents." + }, + "ReachabilityAnalysisIntent": { + "description": "Configuration information or intent on which to do the analysis on.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReachabilityAnalysisIntentProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/CommonProxyResource" + } + ] + }, + "ReachabilityAnalysisIntentProperties": { + "required": [ + "destinationResourceId", + "ipTraffic", + "sourceResourceId" + ], + "description": "Represents the Reachability Analysis Intent properties.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "description": { + "type": "string" + }, + "sourceResourceId": { + "format": "arm-id", + "type": "string", + "description": "Source resource id to verify the reachability path of." + }, + "destinationResourceId": { + "format": "arm-id", + "type": "string", + "description": "Destination resource id to verify the reachability path of." + }, + "ipTraffic": { + "$ref": "#/definitions/IPTraffic", + "description": "IP traffic information." + } + } + }, + "ReachabilityAnalysisRunListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReachabilityAnalysisRun" + }, + "description": "Gets a page of Reachability Analysis Runs." + }, + "nextLink": { + "description": "Gets the URL to get the next page of results.", + "type": "string" + } + }, + "description": "A list of Reachability Analysis Run" + }, + "ReachabilityAnalysisRun": { + "required": [ + "properties" + ], + "description": "Configuration information for analysis run.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ReachabilityAnalysisRunProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/CommonProxyResource" + } + ] + }, + "ReachabilityAnalysisRunProperties": { + "required": [ + "intentId" + ], + "description": "Represents the Reachability Analysis Run properties.", + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "intentId": { + "type": "string", + "description": "Id of the intent resource to run analysis on." + }, + "intentContent": { + "readOnly": true, + "$ref": "#/definitions/IntentContent", + "description": "Intent information." + }, + "analysisResult": { + "type": "string", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "VerifierWorkspaceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VerifierWorkspace" + }, + "description": "Gets a page of Verifier Workspaces." + }, + "nextLink": { + "description": "Gets the URL to get the next page of results.", + "type": "string" + } + }, + "description": "A list of Verifier Workspace" + }, + "VerifierWorkspace": { + "description": "Instance of Verifier Workspace.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VerifierWorkspaceProperties" + }, + "etag": { + "description": "String representing unique etag for the resource document.", + "type": "string", + "readOnly": true + }, + "systemData": { + "readOnly": true, + "description": "The system metadata related to this resource.", + "$ref": "./network.json#/definitions/SystemData" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/CommonTrackedResource" + } + ] + }, + "VerifierWorkspaceProperties": { + "type": "object", + "description": "Properties of Verifier Workspace resource.", + "properties": { + "description": { + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + } + } + }, + "VerifierWorkspaceUpdate": { + "type": "object", + "description": "Represents the VerifierWorkspace update API request interface.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/VerifierWorkspaceUpdateProperties" + } + } + }, + "VerifierWorkspaceUpdateProperties": { + "type": "object", + "description": "Represents the VerifierWorkspace update properties.", + "properties": { + "description": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow." + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkVirtualAppliance.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkVirtualAppliance.json new file mode 100644 index 000000000000..6e139c6ddbce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkVirtualAppliance.json @@ -0,0 +1,1874 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/networkVirtualAppliances/{networkVirtualApplianceName}": { + "delete": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Delete", + "description": "Deletes the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Get", + "description": "Gets the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_UpdateTags", + "description": "Updates a Network Virtual Appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of Network Virtual Appliance." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update Network Virtual Appliance Tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of Network Virtual Appliance updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceUpdateTags.json" + } + } + }, + "put": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance resource.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualAppliancePut.json" + }, + "Create SaaS NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceSaaSPut.json" + }, + "Create NVA in VNet with PrivateNic & PublicNic": { + "$ref": "./examples/NetworkVirtualApplianceVnetBasicPut.json" + }, + "Create NVA in VNet with PrivateNic, PublicNic & AdditionalPrivateNic": { + "$ref": "./examples/NetworkVirtualApplianceVnetAdditionalPrivatePut.json" + }, + "Create NVA in VNet with PrivateNic, PublicNic & AdditionalPublicNic": { + "$ref": "./examples/NetworkVirtualApplianceVnetAdditionalPublicPut.json" + }, + "Create NVA in VNet with PrivateNic & PublicNic, including NetworkProfile": { + "$ref": "./examples/NetworkVirtualApplianceVnetNetworkProfilePut.json" + }, + "Create NVA in VNet with PrivateNic & PublicNic, including Internet-Ingress": { + "$ref": "./examples/NetworkVirtualApplianceVnetIngressPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/restart": { + "post": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Restart", + "description": "Restarts one or more VMs belonging to the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "NetworkVirtualApplianceInstanceIds", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation restarts one or more Network Virtual Appliance VM resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + } + }, + "202": { + "description": "Request accepted. The operation restarts one or more Network Virtual Appliance VM resources.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Restart All NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceEmptyRestart.json" + }, + "Restart Specific NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceSpecificRestart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/reimage": { + "post": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Reimage", + "description": "Reimages one VM belonging to the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "NetworkVirtualApplianceInstanceIds", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reimages one or more Network Virtual Appliance VM resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceIds" + } + }, + "202": { + "description": "Request accepted. The operation reimages one or more Network Virtual Appliance VM resources.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Reimages Specific NetworkVirtualAppliance VMs in VM Scale Set": { + "$ref": "./examples/NetworkVirtualApplianceSpecificReimage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/getBootDiagnosticLogs": { + "post": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_GetBootDiagnosticLogs", + "description": "Retrieves the boot diagnostic logs for a VM instance belonging to the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceBootDiagnosticParameters" + }, + "description": "Parameters supplied to retrieve boot diagnostic logs for a NVA VM instance" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation retrieves boot diagnostic logs for a Network Virtual Appliance VM resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceInstanceId" + } + }, + "202": { + "description": "Request accepted. The operation gets the boot diagnostic logs for a Network Virtual Appliance VM instance.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve Boot Diagnostic logs for a given NVA VMSS instance": { + "$ref": "./examples/NetworkVirtualApplianceBootDiagnostics.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances": { + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_ListByResourceGroup", + "description": "Lists all Network Virtual Appliances in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliance for a given resource group": { + "$ref": "./examples/NetworkVirtualApplianceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualAppliances": { + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_List", + "description": "Gets all Network Virtual Appliances in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliances for a given subscription": { + "$ref": "./examples/NetworkVirtualApplianceListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}": { + "delete": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_Delete", + "description": "Deletes the specified site from a Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Network Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSiteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_Get", + "description": "Gets the specified Virtual Appliance Site.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetNetwork Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSiteGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance Site.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance Site operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSitePut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites": { + "get": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_List", + "description": "Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance site resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliance sites for a given Network Virtual Appliance": { + "$ref": "./examples/NetworkVirtualApplianceSiteList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus": { + "get": { + "tags": [ + "VirtualApplianceSkus" + ], + "operationId": "VirtualApplianceSkus_List", + "description": "List all SKUs available for a virtual appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all virtual appliance skus.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkVirtualApplianceSkuListResult": { + "$ref": "./examples/NetworkVirtualApplianceSkuList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus/{skuName}": { + "get": { + "tags": [ + "VirtualApplianceSkus" + ], + "operationId": "VirtualApplianceSkus_Get", + "description": "Retrieves a single available sku for network virtual appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Sku." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested NetworkVirtualAppliance sku information.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkVirtualApplianceSkuGet": { + "$ref": "./examples/NetworkVirtualApplianceSkuGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/inboundSecurityRules/{ruleCollectionName}": { + "put": { + "operationId": "InboundSecurityRule_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance Inbound Security Rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "ruleCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of security rule collection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance Inbound Security Rules operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance Inbound Security Rules resource.", + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance Inbound Security Rules resource.", + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Inbound Security Rules": { + "$ref": "./examples/InboundSecurityRulePut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "InboundSecurityRule_Get", + "description": "Retrieves the available specified Network Virtual Appliance Inbound Security Rules Collection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "ruleCollectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of security rule collection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested Network Virtual Appliance Inbound Security Rules Collection resource.", + "schema": { + "$ref": "#/definitions/InboundSecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Inbound Security Rules": { + "$ref": "./examples/InboundSecurityRuleGet.json" + } + } + } + } + }, + "definitions": { + "NetworkVirtualAppliance": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualAppliancePropertiesFormat", + "description": "Properties of the Network Virtual Appliance." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The service principal that has read access to cloud-init and config blob." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkVirtualAppliance Resource." + }, + "NetworkVirtualAppliancePropertiesFormat": { + "properties": { + "nvaSku": { + "readOnly": false, + "description": "Network Virtual Appliance SKU.", + "$ref": "#/definitions/VirtualApplianceSkuProperties" + }, + "addressPrefix": { + "type": "string", + "readOnly": true, + "description": "Address Prefix." + }, + "bootStrapConfigurationBlobs": { + "type": "array", + "readOnly": false, + "description": "BootStrapConfigurationBlobs storage URLs.", + "items": { + "type": "string" + } + }, + "virtualHub": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Virtual Hub where Network Virtual Appliance is being deployed." + }, + "cloudInitConfigurationBlobs": { + "type": "array", + "readOnly": false, + "description": "CloudInitConfigurationBlob storage URLs.", + "items": { + "type": "string" + } + }, + "cloudInitConfiguration": { + "type": "string", + "readOnly": false, + "description": "CloudInitConfiguration string in plain text." + }, + "virtualApplianceAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualAppliance ASN. Microsoft private, public and IANA reserved ASN are not supported." + }, + "sshPublicKey": { + "type": "string", + "readOnly": false, + "description": "Public key for SSH login." + }, + "virtualApplianceNics": { + "type": "array", + "readOnly": true, + "description": "List of Virtual Appliance Network Interfaces.", + "items": { + "$ref": "#/definitions/VirtualApplianceNicProperties" + } + }, + "networkProfile": { + "type": "object", + "readOnly": false, + "description": "Network Profile containing configurations for Public and Private NIC.", + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceNetworkInterfaceConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "additionalNics": { + "type": "array", + "readOnly": false, + "description": "Details required for Additional Network Interface. This property is not compatible with the NVA deployed in VNets.", + "items": { + "$ref": "#/definitions/VirtualApplianceAdditionalNicProperties" + }, + "x-ms-identifiers": [] + }, + "internetIngressPublicIps": { + "type": "array", + "readOnly": false, + "description": "List of Resource Uri of Public IPs for Internet Ingress Scenario.", + "items": { + "$ref": "#/definitions/InternetIngressPublicIpsProperties" + }, + "x-ms-identifiers": [] + }, + "virtualApplianceSites": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualApplianceSite.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "virtualApplianceConnections": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualApplianceConnections.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "inboundSecurityRules": { + "type": "array", + "readOnly": true, + "description": "List of references to InboundSecurityRules.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + }, + "deploymentType": { + "type": "string", + "readOnly": true, + "description": "The deployment type. PartnerManaged for the SaaS NVA" + }, + "delegation": { + "description": "The delegation for the Virtual Appliance. Only appliable for SaaS NVA.", + "$ref": "#/definitions/DelegationProperties" + }, + "partnerManagedResource": { + "description": "The delegation for the Virtual Appliance", + "$ref": "#/definitions/PartnerManagedResourceProperties" + }, + "nvaInterfaceConfigurations": { + "description": "The NVA in VNet interface configurations", + "$ref": "#/definitions/NvaInterfaceConfigurations" + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "description": "A Internal Load Balancer's HA port frontend IP address. Can be used to set routes & UDR to load balance traffic between NVA instances" + } + }, + "description": "Network Virtual Appliance definition." + }, + "VirtualApplianceSkuProperties": { + "properties": { + "vendor": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Vendor." + }, + "bundledScaleUnit": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Scale Unit." + }, + "marketPlaceVersion": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Version." + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "VirtualApplianceNicProperties": { + "properties": { + "nicType": { + "type": "string", + "readOnly": true, + "description": "NIC type - PublicNic, PrivateNic, or AdditionalNic; AdditionalPrivateNic and AdditionalPublicNic are only supported for NVAs deployed in VNets.", + "enum": [ + "PublicNic", + "PrivateNic", + "AdditionalNic" + ], + "x-ms-enum": { + "name": "NicTypeInResponse", + "modelAsString": true + } + }, + "name": { + "type": "string", + "readOnly": true, + "description": "NIC name." + }, + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP address." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP address." + }, + "instanceName": { + "type": "string", + "readOnly": true, + "description": "Instance on which nic is attached." + } + }, + "description": "Network Virtual Appliance NIC properties." + }, + "VirtualApplianceNetworkInterfaceConfiguration": { + "type": "object", + "readOnly": false, + "description": "Represents a single NIC configuration.", + "properties": { + "type": { + "type": "string", + "description": "NIC type. This should be either PublicNic or PrivateNic.", + "enum": [ + "PublicNic", + "PrivateNic" + ], + "x-ms-enum": { + "name": "NicTypeInRequest", + "modelAsString": true + }, + "x-ms-client-name": "NicType" + }, + "properties": { + "$ref": "#/definitions/VirtualApplianceNetworkInterfaceConfigurationProperties" + } + } + }, + "VirtualApplianceNetworkInterfaceConfigurationProperties": { + "type": "object", + "readOnly": false, + "description": "Represents a single NIC configuration properties.", + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceIPConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualApplianceIPConfiguration": { + "type": "object", + "readOnly": false, + "description": "Represents a single IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "For hub NVAs, primary IP configs must be named 'privatenicipconfig' and 'publicnicipconfig', with non-primary configs using these prefixes; no naming restrictions apply for NVAs in VNets. Maximum 80 character are allowed." + }, + "properties": { + "$ref": "#/definitions/VirtualApplianceIPConfigurationProperties" + } + } + }, + "VirtualApplianceIPConfigurationProperties": { + "type": "object", + "readOnly": false, + "description": "Represents a single IP configuration properties.", + "properties": { + "primary": { + "type": "boolean", + "description": "Whether or not this is primary IP configuration of the NIC." + } + } + }, + "VirtualApplianceAdditionalNicProperties": { + "type": "object", + "title": "Network Virtual Appliance Additional Nic Properties", + "description": "Network Virtual Appliance Additional NIC properties.", + "properties": { + "name": { + "type": "string", + "readOnly": false, + "description": "Name of additional nic" + }, + "hasPublicIp": { + "type": "boolean", + "readOnly": false, + "description": "Flag (true or false) for Intent for Public Ip on additional nic" + } + } + }, + "InternetIngressPublicIpsProperties": { + "type": "object", + "title": "Internet Ingress Public Ip Properties", + "description": "Resource Uri of Public Ip for Standard Load Balancer Frontend End.", + "properties": { + "id": { + "type": "string", + "readOnly": false, + "description": "Resource Uri of Public Ip", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } + }, + "VirtualApplianceSite": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualApplianceSiteProperties", + "description": "The properties of the Virtual Appliance Sites." + }, + "name": { + "type": "string", + "description": "Name of the virtual appliance site." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Site type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Appliance Site resource." + }, + "VirtualApplianceSiteProperties": { + "properties": { + "addressPrefix": { + "type": "string", + "readOnly": false, + "description": "Address Prefix." + }, + "o365Policy": { + "readOnly": false, + "description": "Office 365 Policy.", + "$ref": "#/definitions/Office365PolicyProperties" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the rule group." + }, + "Office365PolicyProperties": { + "properties": { + "breakOutCategories": { + "readOnly": false, + "description": "Office 365 breakout categories.", + "$ref": "#/definitions/BreakOutCategoryPolicies" + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "BreakOutCategoryPolicies": { + "properties": { + "allow": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 allow category." + }, + "optimize": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 optimize category." + }, + "default": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 default category." + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "NetworkVirtualApplianceSku": { + "title": "Available NetworkVirtualApplianceSkus", + "description": "Definition of the NetworkVirtualApplianceSkus resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualApplianceSkuPropertiesFormat", + "description": "NetworkVirtualApplianceSku properties." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "NetworkVirtualApplianceSkuPropertiesFormat": { + "title": "Network Virtual Appliance Sku Properties", + "description": "Properties specific to NetworkVirtualApplianceSkus.", + "properties": { + "vendor": { + "type": "string", + "readOnly": true, + "description": "Network Virtual Appliance Sku vendor." + }, + "availableVersions": { + "type": "array", + "readOnly": true, + "description": "Available Network Virtual Appliance versions.", + "items": { + "type": "string" + } + }, + "availableScaleUnits": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceSkuInstances" + }, + "description": "The list of scale units available." + } + } + }, + "NetworkVirtualApplianceSkuInstances": { + "title": "Network Virtual Appliance Sku Instances", + "description": "List of available Sku and instances.", + "properties": { + "scaleUnit": { + "type": "string", + "readOnly": true, + "description": "Scale Unit." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Instance Count." + } + } + }, + "NetworkVirtualApplianceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualAppliance" + }, + "description": "List of Network Virtual Appliances." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualAppliances API service call." + }, + "NetworkVirtualApplianceSiteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceSite" + }, + "description": "List of Network Virtual Appliance sites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualApplianceSites API service call." + }, + "NetworkVirtualApplianceSkuListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceSku" + }, + "description": "List of Network Virtual Appliance Skus that are available." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualApplianceSkus API service call." + }, + "InboundSecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundSecurityRuleProperties", + "description": "The properties of the Inbound Security Rules." + }, + "name": { + "type": "string", + "description": "Name of security rule collection." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "NVA inbound security rule type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NVA Inbound Security Rule resource." + }, + "InboundSecurityRuleProperties": { + "properties": { + "ruleType": { + "type": "string", + "enum": [ + "AutoExpire", + "Permanent" + ], + "x-ms-enum": { + "name": "InboundSecurityRuleType", + "modelAsString": true + }, + "description": "Rule Type. This should be either AutoExpire or Permanent. Auto Expire Rule only creates NSG rules. Permanent Rule creates NSG rule and SLB LB Rule." + }, + "rules": { + "type": "array", + "readOnly": false, + "description": "List of allowed rules.", + "items": { + "$ref": "#/definitions/InboundSecurityRules" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the Inbound Security Rules resource." + }, + "InboundSecurityRules": { + "properties": { + "name": { + "type": "string", + "description": "Name of the rule." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "InboundSecurityRulesProtocol", + "modelAsString": true + }, + "description": "Protocol. This should be either TCP or UDP." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range." + }, + "destinationPortRange": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "NVA port ranges to be opened up. One needs to provide specific ports." + }, + "destinationPortRanges": { + "type": "array", + "readOnly": false, + "description": "NVA port ranges to be opened up. One can provide a range of ports. Allowed port value between 0 and 65535.", + "items": { + "type": "string" + } + }, + "appliesOn": { + "type": "array", + "readOnly": false, + "description": "Public IP name in case of Permanent Rule type & Interface Name in case of Auto Expire Rule type", + "items": { + "type": "string" + } + } + }, + "description": "Properties of the Inbound Security Rules resource." + }, + "DelegationProperties": { + "type": "object", + "properties": { + "serviceName": { + "type": "string", + "description": "The service name to which the NVA is delegated." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the delegation." + }, + "PartnerManagedResourceProperties": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "PaloAltoNetworks.Cloudngfw/firewalls" + } + ] + }, + "description": "The partner managed resource id." + }, + "internalLoadBalancerId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/loadBalancers" + } + ] + }, + "description": "The partner managed ILB resource id" + }, + "standardLoadBalancerId": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/loadBalancers" + } + ] + }, + "description": "The partner managed SLB resource id" + } + }, + "description": "Properties of the partner managed resource. Only appliable for SaaS NVA." + }, + "NetworkVirtualApplianceInstanceIds": { + "type": "object", + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the Network Virtual Appliance VM instances." + }, + "NetworkVirtualApplianceInstanceId": { + "type": "object", + "properties": { + "instanceId": { + "type": "integer", + "format": "int32", + "description": "The network virtual appliance instance id for which boot diagnostic logs is being requested" + } + } + }, + "NetworkVirtualApplianceBootDiagnosticParameters": { + "type": "object", + "properties": { + "instanceId": { + "type": "integer", + "format": "int32", + "description": "The network virtual appliance instance id for which boot diagnostic logs is being requested" + }, + "serialConsoleStorageSasUrl": { + "type": "string", + "format": "uri", + "description": "Specifies the sas-url to the storage blob into which serial console logs for the requested instance will be written" + }, + "consoleScreenshotStorageSasUrl": { + "type": "string", + "format": "uri", + "description": "Specifies the sas-url to the storage blob into which console screen shot for the requested instance will be written" + } + }, + "description": "Specifies input parameters required to retrieve the boot diagnostic logs for an NVA instance" + }, + "NvaInterfaceConfigurations": { + "type": "array", + "readOnly": false, + "description": "The NVA in VNet interface configurations details", + "maxItems": 3, + "items": { + "$ref": "#/definitions/NvaInterfaceConfigurationsProperties" + } + }, + "NvaInterfaceConfigurationsProperties": { + "type": "object", + "properties": { + "subnet": { + "readOnly": false, + "$ref": "#/definitions/NvaInVnetSubnetReferenceProperties", + "description": "A subnet resource id where the NIC will be deployed. Each subnet resource uri should be unique.", + "x-ms-identifiers": [] + }, + "type": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "PrivateNic", + "PublicNic", + "AdditionalPrivateNic", + "AdditionalPublicNic" + ], + "x-ms-enum": { + "name": "NvaNicType", + "modelAsString": true, + "values": [ + { + "value": "PrivateNic", + "description": "The private NIC type" + }, + { + "value": "PublicNic", + "description": "The public NIC type" + }, + { + "value": "AdditionalPrivateNic", + "description": "An additional private NIC type" + }, + { + "value": "AdditionalPublicNic", + "description": "An additional public NIC type" + } + ] + } + }, + "description": "Specifies the NIC types for the NVA interface configuration. Allowed values: PrivateNic, PublicNic, AdditionalPrivateNic, AdditionalPublicNic. Only the combination of PrivateNic and PublicNic is currently supported." + }, + "name": { + "type": "string", + "maxLength": 70, + "description": "Specifies the name of the interface. Maximum length is 70 characters." + } + }, + "description": "Specifies input parameters required NVA in VNet interface configuration." + }, + "NvaInVnetSubnetReferenceProperties": { + "type": "object", + "title": "Subnet references where the NVA NICS will be deployed", + "description": "The resource URI of the subnets where the NVA NICS will be deployed", + "properties": { + "id": { + "type": "string", + "readOnly": false, + "description": "Resource Uri of Subnet", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkWatcher.json new file mode 100644 index 000000000000..03b816567318 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/networkWatcher.json @@ -0,0 +1,4742 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/networkWatchers/{networkWatcherName}": { + "put": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CreateOrUpdate", + "description": "Creates or updates a network watcher in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "Parameters that define the network watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network watcher": { + "$ref": "./examples/NetworkWatcherCreate.json" + } + } + }, + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Get", + "description": "Gets the specified network watcher by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network watcher": { + "$ref": "./examples/NetworkWatcherGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Delete", + "description": "Deletes the specified network watcher resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network watcher": { + "$ref": "./examples/NetworkWatcherDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_UpdateTags", + "description": "Updates a network watcher tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network watcher tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network watcher tags": { + "$ref": "./examples/NetworkWatcherUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_List", + "description": "Gets all network watchers by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List network watchers": { + "$ref": "./examples/NetworkWatcherList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAll", + "description": "Gets all network watchers by subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List all network watchers": { + "$ref": "./examples/NetworkWatcherListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTopology", + "description": "Gets the current network topology by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TopologyParameters" + }, + "description": "Parameters that define the representation of topology." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the topology of resource group.", + "schema": { + "$ref": "#/definitions/Topology" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Topology": { + "$ref": "./examples/NetworkWatcherTopologyGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_VerifyIPFlow", + "description": "Verify IP flow from the specified VM to a location given the currently configured NSG rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VerificationIPFlowParameters" + }, + "description": "Parameters that define the IP flow to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of IP flow verification.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ip flow verify": { + "$ref": "./examples/NetworkWatcherIpFlowVerify.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNextHop", + "description": "Gets the next hop from the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NextHopParameters" + }, + "description": "Parameters that define the source and destination endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the next hop from the VM.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get next hop": { + "$ref": "./examples/NetworkWatcherNextHopGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetVMSecurityRules", + "description": "Gets the configured and effective security group rules on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityGroupViewParameters" + }, + "description": "Parameters that define the VM to check security groups for." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns security group rules on the VM.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get security group view": { + "$ref": "./examples/NetworkWatcherSecurityGroupViewGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}": { + "put": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Create", + "description": "Create and start a packet capture on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCapture" + }, + "description": "Parameters that define the create packet capture operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Get", + "description": "Gets a packet capture session by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureGet.json" + } + } + }, + "delete": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Delete", + "description": "Deletes the specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Stop", + "description": "Stops a specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the packet capture session." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_GetStatus", + "description": "Query the status of a running packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of packet capture status.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "202": { + "description": "Accepted query status of packet capture.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query packet capture status": { + "$ref": "./examples/NetworkWatcherPacketCaptureQueryStatus.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures": { + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_List", + "description": "Lists all packet capture sessions within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful packet capture enumeration request.", + "schema": { + "$ref": "#/definitions/PacketCaptureListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List packet captures": { + "$ref": "./examples/NetworkWatcherPacketCapturesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshooting", + "description": "Initiate troubleshooting on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TroubleshootingParameters" + }, + "description": "Parameters that define the resource to troubleshoot." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshooting": { + "$ref": "./examples/NetworkWatcherTroubleshootGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshootingResult", + "description": "Get the last completed troubleshooting result on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryTroubleshootingParameters" + }, + "description": "Parameters that define the resource to query the troubleshooting result." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshoot result": { + "$ref": "./examples/NetworkWatcherTroubleshootResultQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_SetFlowLogConfiguration", + "description": "Configures flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogInformation" + }, + "description": "Parameters that define the configuration of flow log." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for setting flow log and traffic analytics (optional) configuration.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Configure flow log": { + "$ref": "./examples/NetworkWatcherFlowLogConfigure.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_GetFlowLogStatus", + "description": "Queries status of flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogStatusParameters" + }, + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for query flow log and traffic analytics (optional) status.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log status": { + "$ref": "./examples/NetworkWatcherFlowLogStatusQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CheckConnectivity", + "description": "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityParameters" + }, + "description": "Parameters that determine how the connectivity check will be performed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for checking connectivity.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check connectivity": { + "$ref": "./examples/NetworkWatcherConnectivityCheck.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetAzureReachabilityReport", + "description": "NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureReachabilityReportParameters" + }, + "description": "Parameters that determine Azure reachability report configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for Azure reachability report.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Reachability Report": { + "$ref": "./examples/NetworkWatcherAzureReachabilityReportGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAvailableProviders", + "description": "NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableProvidersListParameters" + }, + "description": "Parameters that scope the list of available providers." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for list of available providers.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Available Providers List": { + "$ref": "./examples/NetworkWatcherAvailableProvidersListGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", + "description": "Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticParameters" + }, + "description": "Parameters to get network configuration diagnostic." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of network configuration diagnostic.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Network configuration diagnostic": { + "$ref": "./examples/NetworkWatcherNetworkConfigurationDiagnostic.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}": { + "put": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_CreateOrUpdate", + "description": "Create or update a connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionMonitor" + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "migrate", + "in": "query", + "required": false, + "type": "string", + "description": "Value indicating whether connection monitor V1 should be migrated to V2 format." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create connection monitor V1": { + "$ref": "./examples/NetworkWatcherConnectionMonitorCreate.json" + }, + "Create connection monitor V2": { + "$ref": "./examples/NetworkWatcherConnectionMonitorV2Create.json" + }, + "Create connection monitor with Arc Network": { + "$ref": "./examples/NetworkWatcherConnectionMonitorCreateWithArcNetwork.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Get", + "description": "Gets a connection monitor by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorGet.json" + } + } + }, + "delete": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Delete", + "description": "Deletes the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_UpdateTags", + "description": "Update tags of the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update connection monitor tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns updated connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update connection monitor tags": { + "$ref": "./examples/NetworkWatcherConnectionMonitorUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/stop": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Stop", + "description": "Stops the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors": { + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_List", + "description": "Lists all connection monitors for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful connection monitor enumeration request.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List connection monitors": { + "$ref": "./examples/NetworkWatcherConnectionMonitorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}": { + "put": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_CreateOrUpdate", + "description": "Create or update a flow log for the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLog" + }, + "description": "Parameters that define the create or update flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update flow log": { + "$ref": "./examples/NetworkWatcherFlowLogCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_UpdateTags", + "description": "Update tags of the specified flow log.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update flow log tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns updated flow log.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update flow log tags": { + "$ref": "./examples/NetworkWatcherFlowLogUpdateTags.json" + } + } + }, + "get": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_Get", + "description": "Gets a flow log resource by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log": { + "$ref": "./examples/NetworkWatcherFlowLogGet.json" + } + } + }, + "delete": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_Delete", + "description": "Deletes the specified flow log resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete flow log": { + "$ref": "./examples/NetworkWatcherFlowLogDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs": { + "get": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_List", + "description": "Lists all flow log resources for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful flow log enumeration request.", + "schema": { + "$ref": "#/definitions/FlowLogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List connection monitors": { + "$ref": "./examples/NetworkWatcherFlowLogList.json" + } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "The error object.", + "properties": { + "error": { + "title": "Error", + "$ref": "./network.json#/definitions/ErrorDetails", + "description": "The error details object." + } + } + }, + "NetworkWatcher": { + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkWatcherPropertiesFormat", + "description": "Properties of the network watcher." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network watcher in a resource group." + }, + "NetworkWatcherPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network watcher resource." + } + }, + "description": "The network watcher properties." + }, + "NetworkWatcherListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "List of network watcher resources." + } + }, + "description": "Response for ListNetworkWatchers API service call." + }, + "TopologyParameters": { + "properties": { + "targetResourceGroupName": { + "type": "string", + "description": "The name of the target resource group to perform topology on." + }, + "targetVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Virtual Network resource." + }, + "targetSubnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Subnet resource." + } + }, + "description": "Parameters that define the representation of topology." + }, + "Topology": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "GUID representing the operation id." + }, + "createdDateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was initially created for the resource group." + }, + "lastModified": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was last modified." + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/TopologyResource" + }, + "description": "A list of topology resources." + } + }, + "description": "Topology of the specified resource group." + }, + "TopologyResource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource." + }, + "id": { + "type": "string", + "description": "ID of the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "associations": { + "type": "array", + "description": "Holds the associations the resource has with other resources in the resource group.", + "items": { + "$ref": "#/definitions/TopologyAssociation" + } + } + }, + "description": "The network resource topology information for the given resource group." + }, + "TopologyAssociation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is associated with the parent resource." + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource that is associated with the parent resource." + }, + "associationType": { + "type": "string", + "enum": [ + "Associated", + "Contains" + ], + "x-ms-enum": { + "name": "AssociationType", + "modelAsString": true + }, + "description": "The association type of the child resource to the parent resource." + } + }, + "description": "Resources that have an association with the parent resource." + }, + "VerificationIPFlowParameters": { + "description": "Parameters that define the IP flow to be verified.", + "required": [ + "targetResourceId", + "direction", + "protocol", + "localPort", + "remotePort", + "localIPAddress", + "remoteIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform next-hop on." + }, + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction of the packet represented as a 5-tuple." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "IpFlowProtocol", + "modelAsString": true + }, + "description": "Protocol to be verified on." + }, + "localPort": { + "type": "string", + "description": "The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "remotePort": { + "type": "string", + "description": "The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "localIPAddress": { + "type": "string", + "description": "The local IP address. Acceptable values are valid IPv4 addresses." + }, + "remoteIPAddress": { + "type": "string", + "description": "The remote IP address. Acceptable values are valid IPv4 addresses." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional)." + } + } + }, + "VerificationIPFlowResult": { + "description": "Results of IP flow verification on the target resource.", + "properties": { + "access": { + "$ref": "./network.json#/definitions/Access", + "description": "Indicates whether the traffic is allowed or denied." + }, + "ruleName": { + "type": "string", + "description": "Name of the rule. If input is not matched against any security rule, it is not displayed." + } + } + }, + "NextHopParameters": { + "description": "Parameters that define the source and destination endpoint.", + "required": [ + "targetResourceId", + "sourceIPAddress", + "destinationIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The resource identifier of the target resource against which the action is to be performed." + }, + "sourceIPAddress": { + "type": "string", + "description": "The source IP address." + }, + "destinationIPAddress": { + "type": "string", + "description": "The destination IP address." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional)." + } + } + }, + "NextHopResult": { + "description": "The information about next hop from the specified VM.", + "properties": { + "nextHopType": { + "type": "string", + "enum": [ + "Internet", + "VirtualAppliance", + "VirtualNetworkGateway", + "VnetLocal", + "HyperNetGateway", + "None" + ], + "x-ms-enum": { + "name": "NextHopType", + "modelAsString": true + }, + "description": "Next hop type." + }, + "nextHopIpAddress": { + "type": "string", + "description": "Next hop IP Address." + }, + "routeTableId": { + "type": "string", + "description": "The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'." + } + } + }, + "SecurityGroupViewParameters": { + "description": "Parameters that define the VM to check security groups for.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "ID of the target VM." + } + } + }, + "SecurityGroupViewResult": { + "description": "The information about security rules applied to the specified VM.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "List of network interfaces on the specified VM.", + "items": { + "$ref": "#/definitions/SecurityGroupNetworkInterface" + } + } + } + }, + "SecurityGroupNetworkInterface": { + "description": "Network interface and all its associated security rules.", + "properties": { + "id": { + "type": "string", + "description": "ID of the network interface." + }, + "securityRuleAssociations": { + "$ref": "#/definitions/SecurityRuleAssociations", + "description": "All security rules associated with the network interface." + } + } + }, + "SecurityRuleAssociations": { + "description": "All security rules associated with the network interface.", + "properties": { + "networkInterfaceAssociation": { + "$ref": "#/definitions/NetworkInterfaceAssociation", + "description": "Network interface and it's custom security rules." + }, + "subnetAssociation": { + "$ref": "#/definitions/SubnetAssociation", + "description": "Subnet and it's custom security rules." + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + }, + "description": "Collection of default security rules of the network security group." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "Collection of effective security rules." + } + } + }, + "NetworkInterfaceAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Network interface ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "SubnetAssociation": { + "description": "Subnet and it's custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Subnet ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "PacketCapture": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureParameters", + "description": "Properties of the packet capture." + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureParameters": { + "properties": { + "target": { + "type": "string", + "description": "The ID of the targeted resource, only AzureVM and AzureVMSS as target type are currently supported." + }, + "scope": { + "$ref": "#/definitions/PacketCaptureMachineScope", + "description": "A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS." + }, + "targetType": { + "description": "Target type of the resource provided.", + "type": "string", + "enum": [ + "AzureVM", + "AzureVMSS" + ], + "x-ms-enum": { + "name": "PacketCaptureTargetType", + "modelAsString": false + } + }, + "bytesToCapturePerPacket": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 0, + "description": "Number of bytes captured per packet, the remaining bytes are truncated." + }, + "totalBytesPerSession": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 1073741824, + "description": "Maximum size of the capture output." + }, + "timeLimitInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 18000, + "default": 18000, + "description": "Maximum duration of the capture session in seconds." + }, + "storageLocation": { + "$ref": "#/definitions/PacketCaptureStorageLocation", + "description": "The storage location for a packet capture session." + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureFilter" + }, + "description": "A list of packet capture filters." + }, + "continuousCapture": { + "description": "This continuous capture is a nullable boolean, which can hold 'null', 'true' or 'false' value. If we do not pass this parameter, it would be consider as 'null', default value is 'null'.", + "type": "boolean" + }, + "captureSettings": { + "type": "object", + "$ref": "#/definitions/PacketCaptureSettings", + "description": "The capture setting holds the 'FileCount', 'FileSizeInBytes', 'SessionTimeLimitInSeconds' values." + } + }, + "required": [ + "target", + "storageLocation" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureMachineScope": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "List of AzureVMSS instances to run packet capture on.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture.", + "items": { + "type": "string" + } + } + }, + "description": "A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS." + }, + "PacketCaptureStorageLocation": { + "properties": { + "storageId": { + "type": "string", + "description": "The ID of the storage account to save the packet capture session. Required if no localPath or filePath is provided." + }, + "storagePath": { + "type": "string", + "description": "The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture." + }, + "filePath": { + "type": "string", + "description": "This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + }, + "localPath": { + "type": "string", + "description": "This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures." + } + }, + "description": "The storage location for a packet capture session." + }, + "PacketCaptureSettings": { + "properties": { + "fileCount": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 10000, + "default": 10, + "description": "Number of file count. Default value of count is 10 and maximum number is 10000." + }, + "fileSizeInBytes": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "default": 104857600, + "description": "Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB)." + }, + "sessionTimeLimitInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 604800, + "default": 86400, + "description": "Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day)." + } + }, + "description": "The storage location for a packet capture session." + }, + "PacketCaptureFilter": { + "properties": { + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "Any" + ], + "x-ms-enum": { + "name": "PcProtocol", + "modelAsString": true + }, + "default": "Any", + "description": "Protocol to be filtered on." + }, + "localIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remoteIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "localPort": { + "type": "string", + "description": "Local port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remotePort": { + "type": "string", + "description": "Remote port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + } + }, + "description": "Filter that is applied to packet capture request. Multiple filters can be applied." + }, + "PacketCaptureListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureResult" + }, + "description": "Information about packet capture sessions." + } + }, + "description": "List of packet capture sessions." + }, + "PacketCaptureResult": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the packet capture session." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the packet capture operation." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureResultProperties", + "description": "Properties of the packet capture result." + } + }, + "description": "Information about packet capture session." + }, + "PacketCaptureResultProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the packet capture session." + } + }, + "allOf": [ + { + "$ref": "#/definitions/PacketCaptureParameters" + } + ], + "description": "The properties of a packet capture session." + }, + "PacketCaptureQueryStatusResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the packet capture resource." + }, + "id": { + "type": "string", + "description": "The ID of the packet capture resource." + }, + "captureStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the packet capture session." + }, + "packetCaptureStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Stopped", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "PcStatus", + "modelAsString": true + }, + "description": "The status of the packet capture session." + }, + "stopReason": { + "type": "string", + "description": "The reason the current packet capture session was stopped." + }, + "packetCaptureError": { + "type": "array", + "description": "List of errors of packet capture session.", + "items": { + "type": "string", + "enum": [ + "InternalError", + "AgentStopped", + "CaptureFailed", + "LocalFileFailed", + "StorageFailed" + ], + "x-ms-enum": { + "name": "PcError", + "modelAsString": true + } + } + } + }, + "description": "Status of packet capture session." + }, + "TroubleshootingParameters": { + "description": "Parameters that define the resource to troubleshoot.", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The target resource to troubleshoot.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TroubleshootingProperties", + "description": "Properties of the troubleshooting resource." + } + } + }, + "QueryTroubleshootingParameters": { + "description": "Parameters that define the resource to query the troubleshooting result.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource ID to query the troubleshooting result.", + "type": "string" + } + } + }, + "TroubleshootingProperties": { + "description": "Storage location provided for troubleshoot.", + "required": [ + "storageId", + "storagePath" + ], + "properties": { + "storageId": { + "description": "The ID for the storage account to save the troubleshoot result.", + "type": "string" + }, + "storagePath": { + "description": "The path to the blob to save the troubleshoot result in.", + "type": "string" + } + } + }, + "TroubleshootingResult": { + "description": "Troubleshooting information gained from specified resource.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the troubleshooting." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the troubleshooting." + }, + "code": { + "type": "string", + "description": "The result code of the troubleshooting." + }, + "results": { + "type": "array", + "description": "Information from troubleshooting.", + "items": { + "$ref": "#/definitions/TroubleshootingDetails" + } + } + } + }, + "TroubleshootingDetails": { + "description": "Information gained from troubleshooting of specified resource.", + "properties": { + "id": { + "type": "string", + "description": "The id of the get troubleshoot operation." + }, + "reasonType": { + "type": "string", + "description": "Reason type of failure." + }, + "summary": { + "type": "string", + "description": "A summary of troubleshooting." + }, + "detail": { + "type": "string", + "description": "Details on troubleshooting results." + }, + "recommendedActions": { + "type": "array", + "description": "List of recommended actions.", + "items": { + "$ref": "#/definitions/TroubleshootingRecommendedActions" + } + } + } + }, + "TroubleshootingRecommendedActions": { + "description": "Recommended actions based on discovered issues.", + "properties": { + "actionId": { + "description": "ID of the recommended action.", + "type": "string" + }, + "actionText": { + "description": "Description of recommended actions.", + "type": "string" + }, + "actionUri": { + "description": "The uri linking to a documentation for the recommended troubleshooting actions.", + "type": "string" + }, + "actionUriText": { + "description": "The information from the URI for the recommended troubleshooting actions.", + "type": "string" + } + } + }, + "FlowLogListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FlowLog" + }, + "description": "Information about flow log resource." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "List of flow logs." + }, + "FlowLog": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogPropertiesFormat", + "description": "Properties of the flow log." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "description": "FlowLog resource Managed Identity", + "$ref": "./network.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A flow log resource." + }, + "FlowLogPropertiesFormat": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "targetResourceId", + "storageId" + ], + "properties": { + "targetResourceId": { + "description": "ID of network security group to which flow log will be applied.", + "type": "string" + }, + "targetResourceGuid": { + "readOnly": true, + "description": "Guid of network security group to which flow log will be applied.", + "type": "string" + }, + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabledFilteringCriteria": { + "description": "Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged.", + "type": "string" + }, + "recordTypes": { + "description": "Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the flow log." + } + } + }, + "FlowLogProperties": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "storageId", + "enabled" + ], + "properties": { + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabledFilteringCriteria": { + "description": "Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged.", + "type": "string" + }, + "recordTypes": { + "description": "Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." + } + } + }, + "FlowLogStatusParameters": { + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource where getting the flow log and traffic analytics (optional) status.", + "type": "string" + } + } + }, + "RetentionPolicyParameters": { + "description": "Parameters that define the retention policy for flow log.", + "properties": { + "days": { + "description": "Number of days to retain flow log records.", + "type": "integer", + "format": "int32", + "default": 0 + }, + "enabled": { + "description": "Flag to enable/disable retention.", + "type": "boolean", + "default": false + } + } + }, + "FlowLogFormatParameters": { + "description": "Parameters that define the flow log format.", + "properties": { + "type": { + "type": "string", + "description": "The file type of flow log.", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "FlowLogFormatType", + "modelAsString": true + } + }, + "version": { + "description": "The version (revision) of the flow log.", + "type": "integer", + "format": "int32", + "default": 0 + } + } + }, + "FlowLogInformation": { + "description": "Information on the configuration of flow log and traffic analytics (optional) .", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The ID of the resource to configure for flow log and traffic analytics (optional) .", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogProperties", + "description": "Properties of the flow log." + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." + }, + "identity": { + "description": "FlowLog resource Managed Identity", + "$ref": "./network.json#/definitions/ManagedServiceIdentity" + } + } + }, + "TrafficAnalyticsProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "properties": { + "networkWatcherFlowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties", + "description": "Parameters that define the configuration of traffic analytics." + } + } + }, + "TrafficAnalyticsConfigurationProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "properties": { + "enabled": { + "description": "Flag to enable/disable traffic analytics.", + "type": "boolean" + }, + "workspaceId": { + "description": "The resource guid of the attached workspace.", + "type": "string" + }, + "workspaceRegion": { + "description": "The location of the attached workspace.", + "type": "string" + }, + "workspaceResourceId": { + "description": "Resource Id of the attached workspace.", + "type": "string" + }, + "trafficAnalyticsInterval": { + "description": "The interval in minutes which would decide how frequently TA service should do flow analytics.", + "type": "integer", + "format": "int32" + } + } + }, + "ConnectivityParameters": { + "description": "Parameters that determine how the connectivity check will be performed.", + "required": [ + "source", + "destination" + ], + "properties": { + "source": { + "$ref": "#/definitions/ConnectivitySource", + "description": "The source of the connection." + }, + "destination": { + "$ref": "#/definitions/ConnectivityDestination", + "description": "The destination of connection." + }, + "protocol": { + "type": "string", + "description": "Network protocol.", + "enum": [ + "Tcp", + "Http", + "Https", + "Icmp" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "protocolConfiguration": { + "$ref": "#/definitions/ProtocolConfiguration", + "description": "Configuration of the protocol." + }, + "preferredIPVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Preferred IP version of the connection." + } + } + }, + "ConnectivitySource": { + "description": "Parameters that define the source of the connection.", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "description": "The ID of the resource from which a connectivity check will be initiated.", + "type": "string" + }, + "port": { + "description": "The source port from which a connectivity check will be performed.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535 + } + } + }, + "ConnectivityDestination": { + "description": "Parameters that define destination of connection.", + "properties": { + "resourceId": { + "description": "The ID of the resource to which a connection attempt will be made.", + "type": "string" + }, + "address": { + "description": "The IP address or URI the resource to which a connection attempt will be made.", + "type": "string" + }, + "port": { + "description": "Port on which check connectivity will be performed.", + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535 + } + } + }, + "ConnectivityInformation": { + "description": "Information on the connectivity status.", + "properties": { + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + }, + "description": "The connection status." + }, + "avgLatencyInMs": { + "description": "Average latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "minLatencyInMs": { + "description": "Minimum latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "maxLatencyInMs": { + "description": "Maximum latency in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "probesSent": { + "description": "Total number of probes sent.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "probesFailed": { + "description": "Number of failed probes.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "ConnectivityHop": { + "description": "Information about a hop between the source and the destination.", + "properties": { + "type": { + "description": "The type of the hop.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the hop.", + "readOnly": true, + "type": "string" + }, + "address": { + "description": "The IP address of the hop.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true, + "type": "string" + }, + "nextHopIds": { + "readOnly": true, + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + } + }, + "previousHopIds": { + "readOnly": true, + "type": "array", + "description": "List of previous hop identifiers.", + "items": { + "type": "string" + } + }, + "links": { + "readOnly": true, + "type": "array", + "description": "List of hop links.", + "items": { + "$ref": "#/definitions/HopLink" + } + }, + "previousLinks": { + "readOnly": true, + "type": "array", + "description": "List of previous hop links.", + "items": { + "$ref": "#/definitions/HopLink" + } + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + } + } + }, + "HopLink": { + "description": "Hop link.", + "properties": { + "nextHopId": { + "description": "The ID of the next hop.", + "readOnly": true, + "type": "string" + }, + "linkType": { + "description": "Link type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HopLinkProperties", + "description": "Hop link properties." + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + }, + "context": { + "readOnly": true, + "type": "object", + "description": "Provides additional context on links.", + "additionalProperties": { + "type": "string" + } + }, + "resourceId": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + } + } + }, + "HopLinkProperties": { + "description": "Hop link properties.", + "properties": { + "roundTripTimeMin": { + "description": "Minimum roundtrip time in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295 + }, + "roundTripTimeAvg": { + "description": "Average roundtrip time in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295 + }, + "roundTripTimeMax": { + "description": "Maximum roundtrip time in milliseconds.", + "readOnly": true, + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295 + } + } + }, + "ConnectivityIssue": { + "description": "Information about an issue encountered in the process of checking for connectivity.", + "properties": { + "origin": { + "readOnly": true, + "type": "string", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + }, + "description": "The origin of the issue." + }, + "severity": { + "readOnly": true, + "type": "string", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + }, + "description": "The severity of the issue." + }, + "type": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true + }, + "description": "The type of issue." + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + } + } + } + }, + "IssueContext": { + "description": "A key-value pair that provides additional context on the issue.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "ProtocolConfiguration": { + "description": "Configuration of the protocol.", + "properties": { + "HTTPConfiguration": { + "$ref": "#/definitions/HTTPConfiguration", + "description": "HTTP configuration of the connectivity check." + } + } + }, + "HTTPConfiguration": { + "properties": { + "method": { + "type": "string", + "description": "HTTP method.", + "enum": [ + "Get" + ], + "x-ms-enum": { + "name": "HTTPMethod", + "modelAsString": true + } + }, + "headers": { + "type": "array", + "description": "List of HTTP headers.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodes": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "description": "Valid status codes." + } + }, + "description": "HTTP configuration of the connectivity check." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The name in HTTP header." + }, + "value": { + "type": "string", + "description": "The value in HTTP header." + } + }, + "description": "The HTTP header." + }, + "AzureReachabilityReportParameters": { + "properties": { + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Internet service providers." + }, + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional Azure regions to scope the query to." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the Azure reachability report." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the Azure reachability report." + } + }, + "required": [ + "providerLocation", + "startTime", + "endTime" + ], + "description": "Geographic and time constraints for Azure reachability report." + }, + "AzureReachabilityReportLocation": { + "properties": { + "country": { + "type": "string", + "description": "The name of the country." + }, + "state": { + "type": "string", + "description": "The name of the state." + }, + "city": { + "type": "string", + "description": "The name of the city or town." + } + }, + "required": [ + "country" + ], + "description": "Parameters that define a geographic location." + }, + "AzureReachabilityReport": { + "properties": { + "aggregationLevel": { + "type": "string", + "description": "The aggregation level of Azure reachability report. Can be Country, State or City." + }, + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." + }, + "reachabilityReport": { + "type": "array", + "description": "List of Azure reachability report items.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportItem" + } + } + }, + "required": [ + "aggregationLevel", + "providerLocation", + "reachabilityReport" + ], + "description": "Azure reachability report details." + }, + "AzureReachabilityReportItem": { + "properties": { + "provider": { + "type": "string", + "description": "The Internet service provider." + }, + "azureLocation": { + "type": "string", + "description": "The Azure region." + }, + "latencies": { + "type": "array", + "description": "List of latency details for each of the time series.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportLatencyInfo" + } + } + }, + "description": "Azure reachability report details for a given provider location." + }, + "AzureReachabilityReportLatencyInfo": { + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "The time stamp." + }, + "score": { + "type": "integer", + "format": "int32", + "description": "The relative latency score between 1 and 100, higher values indicating a faster connection.", + "minimum": 1, + "maximum": 100 + } + }, + "description": "Details on latency for a time series." + }, + "AvailableProvidersListParameters": { + "properties": { + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Azure regions." + }, + "country": { + "type": "string", + "description": "The country for available providers list." + }, + "state": { + "type": "string", + "description": "The state for available providers list." + }, + "city": { + "type": "string", + "description": "The city or town for available providers list." + } + }, + "description": "Constraints that determine the list of available Internet service providers." + }, + "AvailableProvidersList": { + "properties": { + "countries": { + "type": "array", + "description": "List of available countries.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCountry" + } + } + }, + "required": [ + "countries" + ], + "description": "List of available countries with details." + }, + "AvailableProvidersListCountry": { + "properties": { + "countryName": { + "type": "string", + "description": "The country name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "states": { + "type": "array", + "description": "List of available states in the country.", + "items": { + "$ref": "#/definitions/AvailableProvidersListState" + } + } + }, + "description": "Country details." + }, + "AvailableProvidersListState": { + "properties": { + "stateName": { + "type": "string", + "description": "The state name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "cities": { + "type": "array", + "description": "List of available cities or towns in the state.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCity" + } + } + }, + "description": "State details." + }, + "AvailableProvidersListCity": { + "properties": { + "cityName": { + "type": "string", + "description": "The city or town name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + } + }, + "description": "City or town details." + }, + "NetworkConfigurationDiagnosticParameters": { + "description": "Parameters to get network configuration diagnostic.", + "required": [ + "targetResourceId", + "profiles" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." + }, + "verbosityLevel": { + "type": "string", + "enum": [ + "Normal", + "Minimum", + "Full" + ], + "x-ms-enum": { + "name": "VerbosityLevel", + "modelAsString": true + }, + "description": "Verbosity level." + }, + "profiles": { + "type": "array", + "description": "List of network configuration diagnostic profiles.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" + } + } + } + }, + "NetworkConfigurationDiagnosticProfile": { + "description": "Parameters to compare with network configuration.", + "required": [ + "direction", + "protocol", + "source", + "destination", + "destinationPort" + ], + "properties": { + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction of the traffic." + }, + "protocol": { + "type": "string", + "description": "Protocol to be verified on. Accepted values are '*', TCP, UDP." + }, + "source": { + "type": "string", + "description": "Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag." + }, + "destination": { + "type": "string", + "description": "Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag." + }, + "destinationPort": { + "type": "string", + "description": "Traffic destination port. Accepted values are '*' and a single port in the range (0 - 65535)." + } + } + }, + "NetworkConfigurationDiagnosticResponse": { + "description": "Results of network configuration diagnostic on the target resource.", + "properties": { + "results": { + "readOnly": true, + "type": "array", + "description": "List of network configuration diagnostic results.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResult" + } + } + } + }, + "NetworkConfigurationDiagnosticResult": { + "description": "Network configuration diagnostic result corresponded to provided traffic query.", + "properties": { + "profile": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile", + "description": "Network configuration diagnostic profile." + }, + "networkSecurityGroupResult": { + "$ref": "#/definitions/NetworkSecurityGroupResult", + "description": "Network security group result." + } + } + }, + "NetworkSecurityGroupResult": { + "description": "Network configuration diagnostic result corresponded provided traffic query.", + "properties": { + "securityRuleAccessResult": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "evaluatedNetworkSecurityGroups": { + "readOnly": true, + "type": "array", + "description": "List of results network security groups diagnostic.", + "items": { + "$ref": "#/definitions/EvaluatedNetworkSecurityGroup" + } + } + } + }, + "EvaluatedNetworkSecurityGroup": { + "description": "Results of network security group evaluation.", + "properties": { + "networkSecurityGroupId": { + "type": "string", + "description": "Network security group ID." + }, + "appliedTo": { + "type": "string", + "description": "Resource ID of nic or subnet to which network security group is applied." + }, + "matchedRule": { + "$ref": "#/definitions/MatchedRule", + "description": "Matched network security rule." + }, + "rulesEvaluationResult": { + "readOnly": true, + "type": "array", + "description": "List of network security rules evaluation results.", + "items": { + "$ref": "#/definitions/NetworkSecurityRulesEvaluationResult" + } + } + } + }, + "MatchedRule": { + "description": "Matched rule.", + "properties": { + "ruleName": { + "type": "string", + "description": "Name of the matched network security rule." + }, + "action": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." + } + } + }, + "NetworkSecurityRulesEvaluationResult": { + "description": "Network security rules evaluation result.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network security rule." + }, + "protocolMatched": { + "type": "boolean", + "description": "Value indicating whether protocol is matched." + }, + "sourceMatched": { + "type": "boolean", + "description": "Value indicating whether source is matched." + }, + "sourcePortMatched": { + "type": "boolean", + "description": "Value indicating whether source port is matched." + }, + "destinationMatched": { + "type": "boolean", + "description": "Value indicating whether destination is matched." + }, + "destinationPortMatched": { + "type": "boolean", + "description": "Value indicating whether destination port is matched." + } + } + }, + "Direction": { + "type": "string", + "description": "The direction of the traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + } + }, + "ConnectionMonitor": { + "properties": { + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorParameters", + "description": "Properties of the connection monitor." + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorParameters": { + "properties": { + "source": { + "$ref": "#/definitions/ConnectionMonitorSource", + "description": "Describes the source of connection monitor." + }, + "destination": { + "$ref": "#/definitions/ConnectionMonitorDestination", + "description": "Describes the destination of connection monitor." + }, + "autoStart": { + "type": "boolean", + "default": true, + "description": "Determines if the connection monitor will start automatically once created." + }, + "monitoringIntervalInSeconds": { + "type": "integer", + "format": "int32", + "minimum": 30, + "maximum": 1800, + "default": 60, + "description": "Monitoring interval in seconds." + }, + "endpoints": { + "type": "array", + "description": "List of connection monitor endpoints.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpoint" + } + }, + "testConfigurations": { + "type": "array", + "description": "List of connection monitor test configurations.", + "items": { + "$ref": "#/definitions/ConnectionMonitorTestConfiguration" + } + }, + "testGroups": { + "type": "array", + "description": "List of connection monitor test groups.", + "items": { + "$ref": "#/definitions/ConnectionMonitorTestGroup" + } + }, + "outputs": { + "type": "array", + "description": "List of connection monitor outputs.", + "items": { + "$ref": "#/definitions/ConnectionMonitorOutput" + } + }, + "notes": { + "type": "string", + "description": "Optional notes to be associated with the connection monitor." + } + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorSource": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the source by connection monitor." + }, + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The source port used by connection monitor." + } + }, + "required": [ + "resourceId" + ], + "description": "Describes the source of connection monitor." + }, + "ConnectionMonitorDestination": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the destination by connection monitor." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor destination (IP or domain name)." + }, + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The destination port used by connection monitor." + } + }, + "description": "Describes the destination of connection monitor." + }, + "ConnectionMonitorEndpoint": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor endpoint." + }, + "type": { + "type": "string", + "enum": [ + "AzureVM", + "AzureVNet", + "AzureSubnet", + "ExternalAddress", + "MMAWorkspaceMachine", + "MMAWorkspaceNetwork", + "AzureArcVM", + "AzureVMSS", + "AzureArcNetwork" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + }, + "description": "The endpoint type." + }, + "resourceId": { + "type": "string", + "description": "Resource ID of the connection monitor endpoint are supported for AzureVM, AzureVMSS, AzureVNet, AzureSubnet, MMAWorkspaceMachine, MMAWorkspaceNetwork, AzureArcVM endpoint type." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor endpoint. Supported for AzureVM, ExternalAddress, ArcMachine, MMAWorkspaceMachine endpoint type." + }, + "filter": { + "$ref": "#/definitions/ConnectionMonitorEndpointFilter", + "description": "Filter field is getting deprecated and should not be used. Instead use Include/Exclude scope fields for it." + }, + "scope": { + "$ref": "#/definitions/ConnectionMonitorEndpointScope", + "description": "Endpoint scope defines which target resource to monitor in case of compound resource endpoints like VMSS, AzureSubnet, AzureVNet, MMAWorkspaceNetwork, AzureArcNetwork." + }, + "coverageLevel": { + "type": "string", + "enum": [ + "Default", + "Low", + "BelowAverage", + "Average", + "AboveAverage", + "Full" + ], + "x-ms-enum": { + "name": "CoverageLevel", + "modelAsString": true + }, + "description": "Test coverage for the endpoint." + }, + "locationDetails": { + "$ref": "#/definitions/ConnectionMonitorEndpointLocationDetails", + "description": "Location details is optional and only being used for 'AzureArcNetwork' type endpoints, which contains region details." + }, + "subscriptionId": { + "type": "string", + "description": "Subscription ID for connection monitor endpoint. It's an optional parameter which is being used for 'AzureArcNetwork' type endpoint." + } + }, + "required": [ + "name" + ], + "description": "Describes the connection monitor endpoint." + }, + "ConnectionMonitorEndpointScope": { + "properties": { + "include": { + "type": "array", + "description": "List of items which needs to be included to the endpoint scope.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointScopeItem" + } + }, + "exclude": { + "type": "array", + "description": "List of items which needs to be excluded from the endpoint scope.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointScopeItem" + } + } + }, + "description": "Describes the connection monitor endpoint scope." + }, + "ConnectionMonitorEndpointScopeItem": { + "properties": { + "address": { + "type": "string", + "description": "The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address." + } + }, + "description": "Describes the connection monitor endpoint scope item." + }, + "ConnectionMonitorEndpointFilter": { + "properties": { + "type": { + "type": "string", + "enum": [ + "Include" + ], + "x-ms-enum": { + "name": "ConnectionMonitorEndpointFilterType", + "modelAsString": true + }, + "description": "The behavior of the endpoint filter. Currently only 'Include' is supported." + }, + "items": { + "type": "array", + "description": "List of items in the filter.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointFilterItem" + } + } + }, + "description": "Describes the connection monitor endpoint filter." + }, + "ConnectionMonitorEndpointFilterItem": { + "properties": { + "type": { + "type": "string", + "enum": [ + "AgentAddress" + ], + "x-ms-enum": { + "name": "ConnectionMonitorEndpointFilterItemType", + "modelAsString": true + }, + "description": "The type of item included in the filter. Currently only 'AgentAddress' is supported." + }, + "address": { + "type": "string", + "description": "The address of the filter item." + } + }, + "description": "Describes the connection monitor endpoint filter item." + }, + "ConnectionMonitorTestGroup": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor test group." + }, + "disable": { + "type": "boolean", + "description": "Value indicating whether test group is disabled." + }, + "testConfigurations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of test configuration names." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of source endpoint names." + }, + "destinations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of destination endpoint names." + } + }, + "required": [ + "name", + "testConfigurations", + "sources", + "destinations" + ], + "description": "Describes the connection monitor test group." + }, + "ConnectionMonitorTestConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor test configuration." + }, + "testFrequencySec": { + "type": "integer", + "format": "int32", + "description": "The frequency of test evaluation, in seconds." + }, + "protocol": { + "type": "string", + "enum": [ + "Tcp", + "Http", + "Icmp" + ], + "x-ms-enum": { + "name": "ConnectionMonitorTestConfigurationProtocol", + "modelAsString": true + }, + "description": "The protocol to use in test evaluation." + }, + "preferredIPVersion": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "PreferredIPVersion", + "modelAsString": true + }, + "description": "The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters." + }, + "httpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorHttpConfiguration", + "description": "The parameters used to perform test evaluation over HTTP." + }, + "tcpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorTcpConfiguration", + "description": "The parameters used to perform test evaluation over TCP." + }, + "icmpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorIcmpConfiguration", + "description": "The parameters used to perform test evaluation over ICMP." + }, + "successThreshold": { + "$ref": "#/definitions/ConnectionMonitorSuccessThreshold", + "description": "The threshold for declaring a test successful." + } + }, + "required": [ + "name", + "protocol" + ], + "description": "Describes a connection monitor test configuration." + }, + "ConnectionMonitorHttpConfiguration": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The port to connect to." + }, + "method": { + "type": "string", + "description": "The HTTP method to use.", + "enum": [ + "Get", + "Post" + ], + "x-ms-enum": { + "name": "HTTPConfigurationMethod", + "modelAsString": true + } + }, + "path": { + "type": "string", + "description": "The path component of the URI. For instance, \"/dir1/dir2\"." + }, + "requestHeaders": { + "type": "array", + "description": "The HTTP headers to transmit with the request.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodeRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "HTTP status codes to consider successful. For instance, \"2xx,301-304,418\"." + }, + "preferHTTPS": { + "type": "boolean", + "description": "Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit." + } + }, + "description": "Describes the HTTP configuration." + }, + "ConnectionMonitorTcpConfiguration": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 65535, + "description": "The port to connect to." + }, + "disableTraceRoute": { + "type": "boolean", + "description": "Value indicating whether path evaluation with trace route should be disabled." + }, + "destinationPortBehavior": { + "type": "string", + "description": "Destination port behavior.", + "enum": [ + "None", + "ListenIfAvailable" + ], + "x-ms-enum": { + "name": "DestinationPortBehavior", + "modelAsString": true + } + } + }, + "description": "Describes the TCP configuration." + }, + "ConnectionMonitorIcmpConfiguration": { + "properties": { + "disableTraceRoute": { + "type": "boolean", + "description": "Value indicating whether path evaluation with trace route should be disabled." + } + }, + "description": "Describes the ICMP configuration." + }, + "ConnectionMonitorSuccessThreshold": { + "properties": { + "checksFailedPercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of failed checks permitted for a test to evaluate as successful." + }, + "roundTripTimeMs": { + "type": "number", + "description": "The maximum round-trip time in milliseconds permitted for a test to evaluate as successful." + } + }, + "description": "Describes the threshold for declaring a test successful." + }, + "ConnectionMonitorOutput": { + "properties": { + "type": { + "type": "string", + "description": "Connection monitor output destination type. Currently, only \"Workspace\" is supported.", + "enum": [ + "Workspace" + ], + "x-ms-enum": { + "name": "OutputType", + "modelAsString": true + } + }, + "workspaceSettings": { + "$ref": "#/definitions/ConnectionMonitorWorkspaceSettings", + "description": "Describes the settings for producing output into a log analytics workspace." + } + }, + "description": "Describes a connection monitor output destination." + }, + "ConnectionMonitorWorkspaceSettings": { + "properties": { + "workspaceResourceId": { + "type": "string", + "description": "Log analytics workspace resource ID." + } + }, + "description": "Describes the settings for producing output into a log analytics workspace." + }, + "ConnectionStateSnapshot": { + "properties": { + "connectionState": { + "type": "string", + "enum": [ + "Reachable", + "Unreachable", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + }, + "description": "The connection state." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the connection snapshot." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the connection snapshot." + }, + "evaluationState": { + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "EvaluationState", + "modelAsString": true + }, + "description": "Connectivity analysis evaluation state." + }, + "avgLatencyInMs": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Average latency in ms." + }, + "minLatencyInMs": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Minimum latency in ms." + }, + "maxLatencyInMs": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Maximum latency in ms." + }, + "probesSent": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The number of sent probes." + }, + "probesFailed": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The number of failed probes." + }, + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "./networkWatcher.json#/definitions/ConnectivityHop" + } + } + }, + "description": "Connection state snapshot." + }, + "ConnectionMonitorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionMonitorResult" + }, + "description": "Information about connection monitors." + } + }, + "description": "List of connection monitors." + }, + "ConnectionMonitorResult": { + "x-ms-azure-resource": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the connection monitor." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the connection monitor." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Connection monitor type." + }, + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorResultProperties", + "description": "Properties of the connection monitor result." + } + }, + "description": "Information about the connection monitor." + }, + "ConnectionMonitorResultProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the connection monitor." + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date and time when the connection monitor was started." + }, + "monitoringStatus": { + "readOnly": true, + "type": "string", + "description": "The monitoring status of the connection monitor." + }, + "connectionMonitorType": { + "readOnly": true, + "type": "string", + "enum": [ + "MultiEndpoint", + "SingleSourceDestination" + ], + "x-ms-enum": { + "name": "ConnectionMonitorType", + "modelAsString": true + }, + "description": "Type of connection monitor." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionMonitorParameters" + } + ], + "description": "Describes the properties of a connection monitor." + }, + "ConnectionMonitorQueryResult": { + "properties": { + "sourceStatus": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ConnectionMonitorSourceStatus", + "modelAsString": true + }, + "description": "Status of connection monitor source." + }, + "states": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionStateSnapshot" + }, + "description": "Information about connection states." + } + }, + "description": "List of connection states snapshots." + }, + "ConnectionMonitorEndpointLocationDetails": { + "type": "object", + "properties": { + "region": { + "type": "string", + "description": "Region for connection monitor endpoint." + } + }, + "description": "Connection monitor endpoint location details only being used for 'AzureArcNetwork' type endpoints, which contains the region details." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/operation.json new file mode 100644 index 000000000000..b8eaf60a042d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/operation.json @@ -0,0 +1,271 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { + "$ref": "./examples/OperationList.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/privateEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/privateEndpoint.json new file mode 100644 index 000000000000..a18e1b436831 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/privateEndpoint.json @@ -0,0 +1,1069 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/privateEndpoints/{privateEndpointName}": { + "delete": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_Delete", + "description": "Deletes the specified private endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private endpoint": { + "$ref": "./examples/PrivateEndpointDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_Get", + "description": "Gets the specified private endpoint by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private endpoint": { + "$ref": "./examples/PrivateEndpointGet.json" + }, + "Get private endpoint with manual approval connection": { + "$ref": "./examples/PrivateEndpointGetForManualApproval.json" + }, + "Get private endpoint with application security groups": { + "$ref": "./examples/PrivateEndpointGetWithASG.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_CreateOrUpdate", + "description": "Creates or updates an private endpoint in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "description": "Parameters supplied to the create or update private endpoint operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private endpoint": { + "$ref": "./examples/PrivateEndpointCreate.json" + }, + "Create private endpoint with manual approval connection": { + "$ref": "./examples/PrivateEndpointCreateForManualApproval.json" + }, + "Create private endpoint with application security groups": { + "$ref": "./examples/PrivateEndpointCreateWithASG.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_List", + "description": "Gets all private endpoints in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private endpoint resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private endpoints in resource group": { + "$ref": "./examples/PrivateEndpointList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_ListBySubscription", + "description": "Gets all private endpoints in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private endpoint resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all private endpoints": { + "$ref": "./examples/PrivateEndpointListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { + "get": { + "operationId": "AvailablePrivateEndpointTypes_List", + "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available PrivateEndpoint types": { + "$ref": "./examples/AvailablePrivateEndpointTypesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { + "get": { + "operationId": "AvailablePrivateEndpointTypes_ListByResourceGroup", + "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available PrivateEndpoint types in the resource group": { + "$ref": "./examples/AvailablePrivateEndpointTypesResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}": { + "delete": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_Delete", + "description": "Deletes the specified private dns zone group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_Get", + "description": "Gets the private dns zone group resource by specified private dns zone group name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting privateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_CreateOrUpdate", + "description": "Creates or updates a private dns zone group in the specified private endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + }, + "description": "Parameters supplied to the create or update private dns zone group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PrivateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting PrivateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups": { + "get": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_List", + "description": "Gets all private dns zone groups in a private endpoint.", + "parameters": [ + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private dns zone group resources.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroupListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private endpoints in resource group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateEndpoint": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the load balancer." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointProperties", + "description": "Properties of the private endpoint." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Private endpoint resource." + }, + "PrivateEndpointProperties": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The ID of the subnet from which the private IP will be allocated." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "An array of references to the network interfaces created for this private endpoint." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private endpoint resource." + }, + "ipVersionType": { + "type": "string", + "description": "Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4.", + "enum": [ + "IPv4", + "IPv6", + "DualStack" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "PrivateEndpointIPVersionType", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "Indicates that the Private IPs of the private endpoint will be IPv4 only." + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "Indicates that the Private IPs of the private endpoint will be IPv6 only." + }, + { + "name": "DualStack", + "value": "DualStack", + "description": "Indicates that the Private IPs of the private endpoint can be both IPv4 and IPv6." + } + ] + } + }, + "privateLinkServiceConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + }, + "description": "A grouping of information about the connection to the remote resource." + }, + "manualPrivateLinkServiceConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + }, + "description": "A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource." + }, + "customDnsConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomDnsConfigPropertiesFormat" + }, + "description": "An array of custom dns configurations." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the private endpoint IP configuration is included." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointIPConfiguration" + }, + "description": "A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints." + }, + "customNetworkInterfaceName": { + "type": "string", + "description": "The custom name of the network interface attached to the private endpoint." + } + }, + "description": "Properties of the private endpoint." + }, + "CustomDnsConfigPropertiesFormat": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fqdn that resolves to private endpoint ip address." + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of private ip addresses of the private endpoint." + } + }, + "description": "Contains custom Dns resolution configuration from customer." + }, + "PrivateLinkServiceConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceConnectionProperties", + "description": "Properties of the private link service connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateLinkServiceConnection resource." + }, + "PrivateLinkServiceConnectionProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service connection resource." + }, + "privateLinkServiceId": { + "type": "string", + "description": "The resource id of private link service." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to." + }, + "requestMessage": { + "type": "string", + "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars." + }, + "privateLinkServiceConnectionState": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of read-only information about the state of the connection to the remote resource." + } + }, + "description": "Properties of the PrivateLinkServiceConnection." + }, + "PrivateEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "description": "A list of private endpoint resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateEndpoints API service call." + }, + "PrivateDnsZoneGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + }, + "description": "A list of private dns zone group resources in a private endpoint." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateDnsZoneGroups API service call." + }, + "AvailablePrivateEndpointTypesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrivateEndpointType" + }, + "description": "An array of available privateEndpoint type." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available PrivateEndpoint types." + }, + "AvailablePrivateEndpointType": { + "properties": { + "name": { + "type": "string", + "description": "The name of the service and resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailablePrivateEndpoint Type resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "resourceName": { + "type": "string", + "description": "The name of the service and resource." + }, + "displayName": { + "type": "string", + "description": "Display name of the resource." + } + }, + "description": "The information of an AvailablePrivateEndpointType." + }, + "PrivateDnsZoneGroup": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateDnsZoneGroupPropertiesFormat", + "description": "Properties of the private dns zone group." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private dns zone group resource." + }, + "PrivateDnsZoneGroupPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private dns zone group resource." + }, + "privateDnsZoneConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateDnsZoneConfig" + }, + "description": "A collection of private dns zone configurations of the private dns zone group." + } + }, + "description": "Properties of the private dns zone group." + }, + "PrivateDnsZoneConfig": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateDnsZonePropertiesFormat", + "description": "Properties of the private dns zone configuration." + } + }, + "description": "PrivateDnsZoneConfig resource." + }, + "PrivateDnsZonePropertiesFormat": { + "properties": { + "privateDnsZoneId": { + "type": "string", + "description": "The resource id of the private dns zone." + }, + "recordSets": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RecordSet" + }, + "description": "A collection of information regarding a recordSet, holding information to identify private resources." + } + }, + "description": "Properties of the private dns zone configuration resource." + }, + "RecordSet": { + "properties": { + "recordType": { + "type": "string", + "description": "Resource record type." + }, + "recordSetName": { + "type": "string", + "description": "Recordset name." + }, + "fqdn": { + "type": "string", + "description": "Fqdn that resolves to private endpoint ip address." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the recordset." + }, + "ttl": { + "type": "integer", + "description": "Recordset time to live." + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private ip address of the private endpoint." + } + }, + "description": "A collective group of information about the record set information." + }, + "PrivateEndpointIPConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointIPConfigurationProperties", + "description": "Properties of private endpoint IP configurations." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "An IP Configuration of the private endpoint." + }, + "PrivateEndpointIPConfigurationProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The ID of a group obtained from the remote resource that this private endpoint should connect to." + }, + "memberName": { + "type": "string", + "description": "The member name of a group obtained from the remote resource that this private endpoint should connect to." + }, + "privateIPAddress": { + "type": "string", + "description": "A private ip address obtained from the private endpoint's subnet." + } + }, + "description": "Properties of an IP Configuration of the private endpoint." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/privateLinkService.json new file mode 100644 index 000000000000..66423787bfe9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/privateLinkService.json @@ -0,0 +1,1120 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/privateLinkServices/{serviceName}": { + "delete": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_Delete", + "description": "Deletes the specified private link service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private link service": { + "$ref": "./examples/PrivateLinkServiceDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_Get", + "description": "Gets the specified private link service by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PrivateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private link service": { + "$ref": "./examples/PrivateLinkServiceGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkService" + ], + "operationId": "PrivateLinkServices_CreateOrUpdate", + "description": "Creates or updates an private link service in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkService" + }, + "description": "Parameters supplied to the create or update private link service operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting privateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting privateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private link service": { + "$ref": "./examples/PrivateLinkServiceCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_List", + "description": "Gets all private link services in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of privateLinkService resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private link service in resource group": { + "$ref": "./examples/PrivateLinkServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListBySubscription", + "description": "Gets all private link service in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PrivateLinkService resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all private list service": { + "$ref": "./examples/PrivateLinkServiceListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_GetPrivateEndpointConnection", + "description": "Get the specific private end point connection by specific private link service in the resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting private end point connection resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private end point connection": { + "$ref": "./examples/PrivateLinkServiceGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_UpdatePrivateEndpointConnection", + "description": "Approve or reject private end point connection for a private link service in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to approve or reject the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PrivateEndpointConnection resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "approve or reject private end point connection for a private link service": { + "$ref": "./examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_DeletePrivateEndpointConnection", + "description": "Delete private end point connection for a private link service in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "delete private end point connection for a private link service": { + "$ref": "./examples/PrivateLinkServiceDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListPrivateEndpointConnections", + "description": "Gets all private end point connections for a specific private link service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private end point connection resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private link service in resource group": { + "$ref": "./examples/PrivateLinkServiceListPrivateEndpointConnection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { + "post": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibility", + "description": "Checks whether the subscription is visible to private link service.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" + }, + "description": "The request body of CheckPrivateLinkService API call." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the subscription is visible to private link service.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceVisibility" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Check private link service visibility": { + "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { + "post": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibilityByResourceGroup", + "description": "Checks whether the subscription is visible to private link service in the specified resource group.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" + }, + "description": "The request body of CheckPrivateLinkService API call." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the subscription is visible to private link service.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceVisibility" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Check private link service visibility": { + "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServices", + "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of private link service id that can be linked to a private end point with auto approved": { + "$ref": "./examples/AutoApprovedPrivateLinkServicesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServicesByResourceGroup", + "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of private link service id that can be linked to a private end point with auto approved": { + "$ref": "./examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateLinkService": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the load balancer." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceProperties", + "description": "Properties of the private link service." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Private link service resource." + }, + "PrivateLinkServiceProperties": { + "properties": { + "loadBalancerFrontendIpConfigurations": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration" + }, + "description": "An array of references to the load balancer IP configurations." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceIpConfiguration" + }, + "description": "An array of private link service IP configurations." + }, + "destinationIPAddress": { + "readOnly": false, + "type": "string", + "description": "The destination IP address of the private link service." + }, + "accessMode": { + "type": "string", + "description": "The access mode of the private link service.", + "enum": [ + "Default", + "Restricted" + ], + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Allows unrestricted access to the private link service." + }, + { + "name": "Restricted", + "value": "Restricted", + "description": "Limits access to subscriptions which are inside visibility list only." + } + ] + } + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "An array of references to the network interfaces created for this private link service." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service resource." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "An array of list about connections to the private endpoint." + }, + "visibility": { + "allOf": [ + { + "$ref": "#/definitions/ResourceSet" + } + ], + "description": "The visibility list of the private link service." + }, + "autoApproval": { + "allOf": [ + { + "$ref": "#/definitions/ResourceSet" + } + ], + "description": "The auto-approval list of the private link service." + }, + "fqdns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Fqdn." + }, + "alias": { + "readOnly": true, + "type": "string", + "description": "The alias of the private link service." + }, + "enableProxyProtocol": { + "type": "boolean", + "description": "Whether the private link service is enabled for proxy protocol or not." + } + }, + "description": "Properties of the private link service." + }, + "ResourceSet": { + "properties": { + "subscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of subscriptions." + } + }, + "description": "The base resource set for visibility and auto-approval." + }, + "PrivateLinkServiceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceIpConfigurationProperties", + "description": "Properties of the private link service ip configuration." + }, + "name": { + "type": "string", + "description": "The name of private link service ip configuration." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The private link service ip configuration." + }, + "PrivateLinkServiceIpConfigurationProperties": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "primary": { + "type": "boolean", + "description": "Whether the ip configuration is primary or not." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service IP configuration resource." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." + } + }, + "description": "Properties of private link service IP configuration." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private end point connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateEndpointConnection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "linkIdentifier": { + "readOnly": true, + "type": "string", + "description": "The consumer link id." + }, + "privateEndpointLocation": { + "readOnly": true, + "type": "string", + "description": "The location of the private endpoint." + } + }, + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "type": "string", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateLinkServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkService" + }, + "description": "A list of PrivateLinkService resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateLinkService API service call." + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "A list of PrivateEndpointConnection resources for a specific private link service." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateEndpointConnection API service call." + }, + "CheckPrivateLinkServiceVisibilityRequest": { + "properties": { + "privateLinkServiceAlias": { + "type": "string", + "description": "The alias of the private link service." + } + }, + "description": "Request body of the CheckPrivateLinkServiceVisibility API service call." + }, + "PrivateLinkServiceVisibility": { + "properties": { + "visible": { + "type": "boolean", + "description": "Private Link Service Visibility (True/False)." + } + }, + "description": "Response for the CheckPrivateLinkServiceVisibility API service call." + }, + "AutoApprovedPrivateLinkServicesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoApprovedPrivateLinkService" + }, + "description": "An array of auto approved private link service." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of private link service id that can be linked to a private end point with auto approved." + }, + "AutoApprovedPrivateLinkService": { + "properties": { + "privateLinkService": { + "type": "string", + "description": "The id of the private link service resource." + } + }, + "description": "The information of an AutoApprovedPrivateLinkService." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/publicIpAddress.json new file mode 100644 index 000000000000..540654e552ce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/publicIpAddress.json @@ -0,0 +1,911 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/publicIPAddresses/{publicIpAddressName}": { + "delete": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Delete", + "description": "Deletes the specified public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete public IP address": { + "$ref": "./examples/PublicIpAddressDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Get", + "description": "Gets the specified public IP address in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get public IP address": { + "$ref": "./examples/PublicIpAddressGet.json" + }, + "Get public IP address with StandardV2 sku": { + "$ref": "./examples/PublicIpAddressGetStandardV2Sku.json" + } + } + }, + "put": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "Parameters supplied to the create or update public IP address operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create public IP address defaults": { + "$ref": "./examples/PublicIpAddressCreateDefaults.json" + }, + "Create public IP address allocation method": { + "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json" + }, + "Create public IP address DNS": { + "$ref": "./examples/PublicIpAddressCreateDns.json" + }, + "Create public IP address DNS with Domain Name Label Scope": { + "$ref": "./examples/PublicIpAddressCreateDnsWithDomainNameLabelScope.json" + }, + "Create public IP address defaults with StandardV2 Sku": { + "$ref": "./examples/PublicIpAddressCreateDefaultsStandardV2Sku.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_UpdateTags", + "description": "Updates public IP address tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP address tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { + "$ref": "./examples/PublicIpAddressUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_ListAll", + "description": "Gets all the public IP addresses in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all public IP addresses": { + "$ref": "./examples/PublicIpAddressListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_List", + "description": "Gets all public IP addresses in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group public IP addresses": { + "$ref": "./examples/PublicIpAddressList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}/ddosProtectionStatus": { + "post": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_DdosProtectionStatus", + "description": "Gets the Ddos Protection Status of a Public IP Address", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the Ddos Protection Status of this Public IP.", + "schema": { + "$ref": "#/definitions/PublicIpDdosProtectionStatusResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Get Ddos Protection Status of a Public IP Address": { + "$ref": "./examples/PublicIpAddressGetDdosProtectionStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}/reserveCloudServicePublicIpAddress": { + "post": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_ReserveCloudServicePublicIpAddress", + "description": "Reserves the specified Cloud Service Public IP by switching its allocation method to Static. If rollback is requested, reverts the allocation method to Dynamic.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\.-]*[A-Za-z0-9_]$", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReserveCloudServicePublicIpAddressRequest" + }, + "description": "Parameter that define which Public IP Address should be associated in place of given Public IP Address." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Reserve public IP address ": { + "$ref": "./examples/PublicIpAddressReserve.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}/disassociateCloudServiceReservedPublicIp": { + "post": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_DisassociateCloudServiceReservedPublicIp", + "description": "Disassociates the Cloud Service reserved Public IP and associates the specified Standalone Public IP to the same Cloud Service frontend.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./networkManager.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\.-]*[A-Za-z0-9_]$", + "minLength": 1, + "maxLength": 80 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DisassociateCloudServicePublicIpRequest" + }, + "description": "Parameter that define which Public IP Address should be associated in place of given Public IP Address." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disassociate public IP address ": { + "$ref": "./examples/PublicIpAddressDisassociateCloudServiceReservedPublicIp.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP address SKU.", + "enum": [ + "Basic", + "Standard", + "StandardV2" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a public IP address SKU.", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP address." + }, + "PublicIPAddressPropertiesFormat": { + "properties": { + "publicIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The public IP address allocation method." + }, + "publicIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "The public IP address version." + }, + "ipConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/IPConfiguration", + "description": "The IP configuration associated with the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/PublicIPAddressDnsSettings", + "description": "The FQDN of the DNS record associated with the public IP address." + }, + "ddosSettings": { + "$ref": "#/definitions/DdosSettings", + "description": "The DDoS protection custom policy associated with the public IP address." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address associated with the public IP address resource." + }, + "publicIPPrefix": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The Public IP Prefix this Public IP Address should be allocated from." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the public IP address resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the public IP address resource." + }, + "servicePublicIPAddress": { + "$ref": "#/definitions/PublicIPAddress", + "description": "The service public IP address of the public IP address resource." + }, + "natGateway": { + "$ref": "./natGateway.json#/definitions/NatGateway", + "description": "The NatGateway for the Public IP address." + }, + "migrationPhase": { + "type": "string", + "description": "Migration phase of Public IP Address.", + "enum": [ + "None", + "Prepare", + "Commit", + "Abort", + "Committed" + ], + "x-ms-enum": { + "name": "PublicIPAddressMigrationPhase", + "modelAsString": true + } + }, + "linkedPublicIPAddress": { + "$ref": "#/definitions/PublicIPAddress", + "description": "The linked public IP address of the public IP address resource." + }, + "deleteOption": { + "type": "string", + "description": "Specify what happens to the public IP address when the VM using it is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true + } + } + }, + "description": "Public IP address properties." + }, + "PublicIPAddress": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the public ip address." + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "The public IP address SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPAddressPropertiesFormat", + "description": "Public IP address properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP address resource." + }, + "PublicIPAddressListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "A list of public IP addresses that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpAddresses API service call." + }, + "PublicIPAddressDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system." + }, + "domainNameLabelScope": { + "type": "string", + "description": "The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "PublicIpAddressDnsSettingsDomainNameLabelScope", + "modelAsString": false + } + }, + "fqdn": { + "type": "string", + "description": "The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone." + }, + "reverseFqdn": { + "type": "string", + "description": "The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN." + } + }, + "description": "Contains FQDN of the DNS record associated with the public IP address." + }, + "DdosSettings": { + "properties": { + "protectionMode": { + "readOnly": false, + "type": "string", + "enum": [ + "VirtualNetworkInherited", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DdosSettingsProtectionMode", + "modelAsString": true + }, + "description": "The DDoS protection mode of the public IP" + }, + "ddosProtectionPlan": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled" + } + }, + "description": "Contains the DDoS protection settings of the public IP." + }, + "IpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: SQL." + } + }, + "description": "Contains the IpTag associated with the object." + }, + "PublicIpDdosProtectionStatusResult": { + "type": "object", + "properties": { + "publicIpAddressId": { + "type": "string", + "description": "Public IP ARM resource ID" + }, + "publicIpAddress": { + "type": "string", + "description": "IP Address of the Public IP Resource" + }, + "isWorkloadProtected": { + "type": "string", + "enum": [ + "False", + "True" + ], + "x-ms-enum": { + "name": "IsWorkloadProtected", + "modelAsString": true + }, + "description": "Value indicating whether the IP address is DDoS workload protected or not." + }, + "ddosProtectionPlanId": { + "type": "string", + "description": " DDoS protection plan Resource Id of a if IP address is protected through a plan." + } + }, + "description": "Response for GetPublicIpAddressDdosProtectionStatusOperation API service call." + }, + "ReserveCloudServicePublicIpAddressRequest": { + "type": "object", + "properties": { + "isRollback": { + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "IsRollback", + "modelAsString": true + }, + "description": "When true, reverts from Static to Dynamic allocation (undo reservation)." + } + }, + "required": [ + "isRollback" + ], + "description": "The request for ReserveCloudServicePublicIpAddressOperation." + }, + "DisassociateCloudServicePublicIpRequest": { + "type": "object", + "properties": { + "publicIpArmId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPAddresses" + } + ] + }, + "description": "ARM ID of the Standalone Public IP to associate. This is of the form : /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}" + } + }, + "required": [ + "publicIpArmId" + ], + "description": "The request for DisassociateCloudServicePublicIpOperation." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/publicIpPrefix.json new file mode 100644 index 000000000000..63dae1e167b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/publicIpPrefix.json @@ -0,0 +1,516 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/publicIPPrefixes/{publicIpPrefixName}": { + "delete": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Delete", + "description": "Deletes the specified public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the PublicIpPrefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete public IP prefix": { + "$ref": "./examples/PublicIpPrefixDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Get", + "description": "Gets the specified public IP prefix in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get public IP prefix": { + "$ref": "./examples/PublicIpPrefixGet.json" + }, + "Get public IP prefix with StandardV2 sku": { + "$ref": "./examples/PublicIpPrefixGetStandardV2Sku.json" + } + } + }, + "put": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "Parameters supplied to the create or update public IP prefix operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create public IP prefix defaults": { + "$ref": "./examples/PublicIpPrefixCreateDefaults.json" + }, + "Create public IP prefix allocation method": { + "$ref": "./examples/PublicIpPrefixCreateCustomizedValues.json" + }, + "Create public IP prefix defaults with StandardV2 Sku": { + "$ref": "./examples/PublicIpPrefixCreateDefaultsStandardV2Sku.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_UpdateTags", + "description": "Updates public IP prefix tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP prefix tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP prefix tags": { + "$ref": "./examples/PublicIpPrefixUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_ListAll", + "description": "Gets all the public IP prefixes in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all public IP prefixes": { + "$ref": "./examples/PublicIpPrefixListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_List", + "description": "Gets all public IP prefixes in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group public IP prefixes": { + "$ref": "./examples/PublicIpPrefixList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPPrefixSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP prefix SKU.", + "enum": [ + "Standard", + "StandardV2" + ], + "x-ms-enum": { + "name": "PublicIPPrefixSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a public IP prefix SKU.", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPPrefixSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP prefix." + }, + "PublicIPPrefixPropertiesFormat": { + "properties": { + "publicIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "The public IP address version." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "./publicIpAddress.json#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP prefix." + }, + "prefixLength": { + "type": "integer", + "format": "int32", + "description": "The Length of the Public IP Prefix." + }, + "ipPrefix": { + "readOnly": true, + "type": "string", + "description": "The allocated Prefix." + }, + "publicIPAddresses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ReferencedPublicIpAddress" + }, + "description": "The list of all referenced PublicIPAddresses." + }, + "loadBalancerFrontendIpConfiguration": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to load balancer frontend IP configuration associated with the public IP prefix." + }, + "customIPPrefix": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The customIpPrefix that this prefix is associated with." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the public IP prefix resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the public IP prefix resource." + }, + "natGateway": { + "$ref": "./natGateway.json#/definitions/NatGateway", + "description": "NatGateway of Public IP Prefix." + } + }, + "description": "Public IP prefix properties." + }, + "PublicIPPrefix": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the public ip address." + }, + "sku": { + "$ref": "#/definitions/PublicIPPrefixSku", + "description": "The public IP prefix SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPPrefixPropertiesFormat", + "description": "Public IP prefix properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP prefix resource." + }, + "PublicIPPrefixListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "A list of public IP prefixes that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpPrefixes API service call." + }, + "ReferencedPublicIpAddress": { + "properties": { + "id": { + "type": "string", + "description": "The PublicIPAddress Reference." + } + }, + "description": "Reference to a public IP address." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/routeFilter.json new file mode 100644 index 000000000000..6eadcfee8a84 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/routeFilter.json @@ -0,0 +1,842 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/routeFilters/{routeFilterName}": { + "delete": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Delete", + "x-ms-examples": { + "RouteFilterDelete": { + "$ref": "./examples/RouteFilterDelete.json" + } + }, + "description": "Deletes the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Get", + "x-ms-examples": { + "RouteFilterGet": { + "$ref": "./examples/RouteFilterGet.json" + } + }, + "description": "Gets the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced express route bgp peering resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterCreate": { + "$ref": "./examples/RouteFilterCreate.json" + } + }, + "description": "Creates or updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Parameters supplied to the create or update route filter operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_UpdateTags", + "description": "Updates tags of a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route filter tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update route filter tags": { + "$ref": "./examples/RouteFilterUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_ListByResourceGroup", + "x-ms-examples": { + "RouteFilterListByResourceGroup": { + "$ref": "./examples/RouteFilterListByResourceGroup.json" + } + }, + "description": "Gets all route filters in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_List", + "x-ms-examples": { + "RouteFilterList": { + "$ref": "./examples/RouteFilterList.json" + } + }, + "description": "Gets all route filters in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}": { + "delete": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Delete", + "x-ms-examples": { + "RouteFilterRuleDelete": { + "$ref": "./examples/RouteFilterRuleDelete.json" + } + }, + "description": "Deletes the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "description": "URL for determining when an operation has completed. Send a GET request to the URL in Location header.\nThe URI should return a 202 until the operation reaches a terminal state and 200 once it reaches a terminal state.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#202-accepted-and-location-headers", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.\nTo get the status of the asynchronous operation, send a GET request to the URL in Azure-AsyncOperation header value.\n\nFor more info: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#asynchronous-operations", + "type": "string" + } + } + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Rule was deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Get", + "x-ms-examples": { + "RouteFilterRuleGet": { + "$ref": "./examples/RouteFilterRuleGet.json" + } + }, + "description": "Gets the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterRuleCreate": { + "$ref": "./examples/RouteFilterRuleCreate.json" + } + }, + "description": "Creates or updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Parameters supplied to the create or update route filter rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules": { + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_ListByRouteFilter", + "x-ms-examples": { + "RouteFilterRuleListByRouteFilter": { + "$ref": "./examples/RouteFilterRuleListByRouteFilter.json" + } + }, + "description": "Gets all RouteFilterRules in a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter Rule resources.", + "schema": { + "$ref": "#/definitions/RouteFilterRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "RouteFilterRulePropertiesFormat": { + "required": [ + "access", + "routeFilterRuleType", + "communities" + ], + "properties": { + "access": { + "$ref": "./network.json#/definitions/Access", + "description": "The access type of the rule." + }, + "routeFilterRuleType": { + "type": "string", + "description": "The rule type of the rule.", + "enum": [ + "Community" + ], + "x-ms-enum": { + "name": "RouteFilterRuleType", + "modelAsString": true + } + }, + "communities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route filter rule resource." + } + }, + "description": "Route Filter Rule Resource." + }, + "RouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource." + }, + "PatchRouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource." + }, + "RouteFilterPropertiesFormat": { + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Collection of RouteFilterRules contained within a route filter." + }, + "peerings": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit peerings." + }, + "ipv6Peerings": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit ipv6 peerings." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route filter resource." + } + }, + "description": "Route Filter Resource." + }, + "RouteFilter": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route Filter Resource." + }, + "PatchRouteFilter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Resource." + }, + "RouteFilterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "A list of route filters in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilters API service call." + }, + "RouteFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "A list of RouteFilterRules in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilterRules API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/routeTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/routeTable.json new file mode 100644 index 000000000000..27a244ff4349 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/routeTable.json @@ -0,0 +1,769 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/routeTables/{routeTableName}": { + "delete": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Delete", + "description": "Deletes the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Request successful. Operation to delete was accepted." + }, + "202": { + "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete route table": { + "$ref": "./examples/RouteTableDelete.json" + } + } + }, + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Get", + "description": "Gets the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get route table": { + "$ref": "./examples/RouteTableGet.json" + } + } + }, + "put": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_CreateOrUpdate", + "description": "Create or updates a route table in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Parameters supplied to the create or update route table operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create route table": { + "$ref": "./examples/RouteTableCreate.json" + }, + "Create route table with route": { + "$ref": "./examples/RouteTableCreateWithRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_UpdateTags", + "description": "Updates a route table tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route table tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update route table tags": { + "$ref": "./examples/RouteTableUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_List", + "description": "Gets all route tables in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List route tables in resource group": { + "$ref": "./examples/RouteTableList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_ListAll", + "description": "Gets all route tables in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all route tables": { + "$ref": "./examples/RouteTableListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": { + "delete": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Delete", + "description": "Deletes the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Route was deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete route": { + "$ref": "./examples/RouteTableRouteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Get", + "description": "Gets the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get route": { + "$ref": "./examples/RouteTableRouteGet.json" + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "operationId": "Routes_CreateOrUpdate", + "description": "Creates or updates a route in the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "name": "routeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + }, + "description": "Parameters supplied to the create or update route operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create route": { + "$ref": "./examples/RouteTableRouteCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_List", + "description": "Gets all routes in a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route resources.", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routes": { + "$ref": "./examples/RouteTableRouteList.json" + } + } + } + } + }, + "definitions": { + "RoutePropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopType": { + "$ref": "#/definitions/RouteNextHopType", + "description": "The type of Azure hop the packet should be sent to." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route resource." + }, + "hasBgpOverride": { + "type": "boolean", + "readOnly": true, + "description": "A value indicating whether this route overrides overlapping BGP routes regardless of LPM." + } + }, + "required": [ + "nextHopType" + ], + "description": "Route resource." + }, + "Route": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutePropertiesFormat", + "description": "Properties of the route." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route resource." + }, + "RouteTablePropertiesFormat": { + "properties": { + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Collection of routes contained within a route table." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "Whether to disable the routes learned by BGP on that route table. True means disable." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route table resource." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the route table." + } + }, + "description": "Route Table resource." + }, + "RouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteTablePropertiesFormat", + "description": "Properties of the route table." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route table resource." + }, + "RouteTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteTable" + }, + "description": "A list of route tables in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteTable API service call." + }, + "RouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "A list of routes in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRoute API service call." + }, + "RouteNextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to.", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/securityPartnerProvider.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/securityPartnerProvider.json new file mode 100644 index 000000000000..56e6345b94ef --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/securityPartnerProvider.json @@ -0,0 +1,441 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/securityPartnerProviders/{securityPartnerProviderName}": { + "delete": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_Delete", + "description": "Deletes the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_Get", + "description": "Gets the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_CreateOrUpdate", + "description": "Creates or updates the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + }, + "description": "Parameters supplied to the create or update Security Partner Provider operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_UpdateTags", + "description": "Updates tags of a Security Partner Provider resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update Security Partner Provider tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Security Partner Provider Tags": { + "$ref": "./examples/SecurityPartnerProviderUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders": { + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_ListByResourceGroup", + "description": "Lists all Security Partner Providers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of SecurityPartnerProvider resources.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Security Partner Providers for a given resource group": { + "$ref": "./examples/SecurityPartnerProviderListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/securityPartnerProviders": { + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_List", + "description": "Gets all the Security Partner Providers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of SecurityPartnerProvider resources.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Security Partner Providers for a given subscription": { + "$ref": "./examples/SecurityPartnerProviderListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SecurityPartnerProviderPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Security Partner Provider resource." + }, + "securityProviderName": { + "description": "The security provider name.", + "$ref": "#/definitions/SecurityPartnerProvidersecurityProviderName" + }, + "connectionStatus": { + "readOnly": true, + "description": "The connection status with the Security Partner Provider.", + "$ref": "#/definitions/SecurityPartnerProviderConnectionStatus" + }, + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The virtualHub to which the Security Partner Provider belongs." + } + }, + "description": "Properties of the Security Partner Provider." + }, + "SecurityPartnerProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPartnerProviderPropertiesFormat", + "description": "Properties of the Security Partner Provider." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Security Partner Provider resource." + }, + "SecurityPartnerProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPartnerProvider" + }, + "description": "List of Security Partner Providers in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListSecurityPartnerProviders API service call." + }, + "SecurityPartnerProvidersecurityProviderName": { + "type": "string", + "description": "The Security Providers.", + "enum": [ + "ZScaler", + "IBoss", + "Checkpoint" + ], + "x-ms-enum": { + "name": "SecurityProviderName", + "modelAsString": true + } + }, + "SecurityPartnerProviderConnectionStatus": { + "type": "string", + "description": "The current state of the connection with Security Partner Provider.", + "readOnly": true, + "enum": [ + "Unknown", + "PartiallyConnected", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "SecurityPartnerProviderConnectionStatus", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceCommunity.json new file mode 100644 index 000000000000..ec2a75ebac25 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceCommunity.json @@ -0,0 +1,158 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/bgpServiceCommunities": { + "get": { + "tags": [ + "BgpServiceCommunities" + ], + "operationId": "BgpServiceCommunities_List", + "x-ms-examples": { + "ServiceCommunityList": { + "$ref": "./examples/ServiceCommunityList.json" + } + }, + "description": "Gets all the available bgp service communities.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of BgpServiceCommunity resources.", + "schema": { + "$ref": "#/definitions/BgpServiceCommunityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BGPCommunity": { + "properties": { + "serviceSupportedRegion": { + "type": "string", + "description": "The region which the service support. e.g. For O365, region is Global." + }, + "communityName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "communityValue": { + "type": "string", + "description": "The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing." + }, + "communityPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The prefixes that the bgp community contains." + }, + "isAuthorizedToUse": { + "type": "boolean", + "description": "Customer is authorized to use bgp community or not." + }, + "serviceGroup": { + "type": "string", + "description": "The service group of the bgp community contains." + } + }, + "description": "Contains bgp community information offered in Service Community resources." + }, + "BgpServiceCommunityPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "bgpCommunities": { + "type": "array", + "items": { + "$ref": "#/definitions/BGPCommunity" + }, + "description": "A list of bgp communities." + } + }, + "description": "Properties of Service Community." + }, + "BgpServiceCommunity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat", + "description": "Properties of the BGP service community." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service Community Properties." + }, + "BgpServiceCommunityListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpServiceCommunity" + }, + "description": "A list of service community resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListServiceCommunity API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceEndpointPolicy.json new file mode 100644 index 000000000000..30840a33e7d4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceEndpointPolicy.json @@ -0,0 +1,762 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Delete", + "description": "Deletes the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Get", + "description": "Gets the specified service Endpoint Policies in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get service endPoint Policy": { + "$ref": "./examples/ServiceEndpointPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_CreateOrUpdate", + "description": "Creates or updates a service Endpoint Policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyCreate.json" + }, + "Create service endpoint policy with definition": { + "$ref": "./examples/ServiceEndpointPolicyCreateWithDefinition.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_UpdateTags", + "description": "Updates tags of a service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update service endpoint policy tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update service endpoint policy tags": { + "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_List", + "description": "Gets all the service endpoint policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_ListByResourceGroup", + "description": "Gets all service endpoint Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group service endpoint policies": { + "$ref": "./examples/ServiceEndpointPolicyList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Delete", + "description": "Deletes the specified ServiceEndpoint policy definitions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Service Endpoint Policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete service endpoint policy definitions from service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Get", + "description": "Get the specified service endpoint policy definitions from service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get service endpoint definition in service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json" + } + } + }, + "put": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate", + "description": "Creates or updates a service endpoint policy definition in the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "name": "ServiceEndpointPolicyDefinitions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy definition": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": { + "get": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup", + "description": "Gets all service endpoint policy definitions in a service end point policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List service endpoint definitions in service end point policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceEndpointPolicyDefinitionPropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "service": { + "type": "string", + "description": "Service endpoint name." + }, + "serviceResources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of service resources." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint policy definition resource." + } + }, + "description": "Service Endpoint policy definition resource." + }, + "ServiceEndpointPolicyDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionPropertiesFormat", + "description": "Properties of the service endpoint policy definition." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "The type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Service Endpoint policy definitions." + }, + "ServiceEndpointPolicyDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "The service endpoint policy definition in a service endpoint policy." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy." + }, + "ServiceEndpointPolicyPropertiesFormat": { + "properties": { + "serviceEndpointPolicyDefinitions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "A collection of service endpoint policy definitions of the service endpoint policy." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the service endpoint policy resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint policy resource." + }, + "serviceAlias": { + "type": "string", + "description": "The alias indicating if the policy belongs to a service" + }, + "contextualServiceEndpointPolicies": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of contextual service endpoint policy." + } + }, + "description": "Service Endpoint Policy resource." + }, + "ServiceEndpointPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyPropertiesFormat", + "description": "Properties of the service end point policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of service endpoint policy. This is metadata used for the Azure portal experience." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service End point policy resource." + }, + "ServiceEndpointPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "A list of ServiceEndpointPolicy resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicies API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceTags.json new file mode 100644 index 000000000000..02ae858604b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/serviceTags.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/serviceTags": { + "get": { + "operationId": "ServiceTags_List", + "description": "Gets a list of service tag information resources.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location that will be used as a reference for version (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns a list of service tag information resources.", + "schema": { + "$ref": "#/definitions/ServiceTagsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of service tags": { + "$ref": "./examples/ServiceTagsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTagDetails": { + "get": { + "operationId": "ServiceTagInformation_List", + "description": "Gets a list of service tag information resources with pagination.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location that will be used as a reference for cloud (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "noAddressPrefixes", + "in": "query", + "required": false, + "type": "boolean", + "description": "Do not return address prefixes for the tag(s)." + }, + { + "name": "tagName", + "in": "query", + "required": false, + "type": "string", + "description": "Return tag information for a particular tag." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns a list of service tag information resources.", + "schema": { + "$ref": "#/definitions/ServiceTagInformationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of service tags": { + "$ref": "./examples/ServiceTagInformationListResult.json" + }, + "Get list of service tags with no address prefixes": { + "$ref": "./examples/ServiceTagInformationListResultWithNoAddressPrefixes.json" + }, + "Get list of service tags with tag name.": { + "$ref": "./examples/ServiceTagInformationListResultWithTagname.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceTagsListResult": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the cloud." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the cloud." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The azure resource type." + }, + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number." + }, + "cloud": { + "type": "string", + "readOnly": true, + "description": "The name of the cloud." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTagInformation" + }, + "readOnly": true, + "description": "The list of service tag information resources." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get next page of service tag information resources." + } + }, + "description": "Response for the ListServiceTags API service call." + }, + "ServiceTagInformationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTagInformation" + }, + "description": "The list of service tag information resources." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for Get ServiceTagInformation API service call. Retrieves the list of service tag information resources." + }, + "ServiceTagInformation": { + "properties": { + "properties": { + "$ref": "#/definitions/ServiceTagInformationPropertiesFormat", + "readOnly": true, + "description": "Properties of the service tag information." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of service tag." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of service tag." + }, + "serviceTagChangeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number of service tag object for region." + } + }, + "description": "The service tag information." + }, + "ServiceTagInformationPropertiesFormat": { + "properties": { + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number of service tag." + }, + "region": { + "type": "string", + "readOnly": true, + "description": "The region of service tag." + }, + "systemService": { + "type": "string", + "readOnly": true, + "description": "The name of system service." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of IP address prefixes." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the service tag." + } + }, + "description": "Properties of the service tag information." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/usage.json new file mode 100644 index 000000000000..49aecb487e6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/usage.json @@ -0,0 +1,160 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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}/providers/Microsoft.Network/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "List network usages for a subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location where resource usage is queried.", + "pattern": "^[-\\w\\._ ]+$" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Usage resources.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List usages": { + "$ref": "./examples/UsageList.json" + }, + "List usages spaced location": { + "$ref": "./examples/UsageListSpacedLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "The network resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list network resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetwork.json new file mode 100644 index 000000000000..0572469d38fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetwork.json @@ -0,0 +1,2358 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/virtualNetworks/{virtualNetworkName}": { + "delete": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Delete", + "description": "Deletes the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete virtual network": { + "$ref": "./examples/VirtualNetworkDelete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Get", + "description": "Gets the specified virtual network by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual network": { + "$ref": "./examples/VirtualNetworkGet.json" + }, + "Get virtual network with a delegated subnet": { + "$ref": "./examples/VirtualNetworkGetWithSubnetDelegation.json" + }, + "Get virtual network with service association links": { + "$ref": "./examples/VirtualNetworkGetWithServiceAssociationLink.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_CreateOrUpdate", + "description": "Creates or updates a virtual network in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Parameters supplied to the create or update virtual network operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create virtual network": { + "$ref": "./examples/VirtualNetworkCreate.json" + }, + "Create virtual network with subnet": { + "$ref": "./examples/VirtualNetworkCreateSubnet.json" + }, + "Create virtual network with subnet containing address prefixes": { + "$ref": "./examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json" + }, + "Create virtual network with Bgp Communities": { + "$ref": "./examples/VirtualNetworkCreateWithBgpCommunities.json" + }, + "Create virtual network with service endpoints": { + "$ref": "./examples/VirtualNetworkCreateServiceEndpoints.json" + }, + "Create virtual network with service endpoints and service endpoint policy": { + "$ref": "./examples/VirtualNetworkCreateServiceEndpointPolicy.json" + }, + "Create virtual network with delegated subnets": { + "$ref": "./examples/VirtualNetworkCreateSubnetWithDelegation.json" + }, + "Create virtual network with encryption": { + "$ref": "./examples/VirtualNetworkCreateWithEncryption.json" + }, + "Create virtual network with ipamPool": { + "$ref": "./examples/VirtualNetworkCreateWithIpamPool.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_UpdateTags", + "description": "Updates a virtual network tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tags": { + "$ref": "./examples/VirtualNetworkUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_ListAll", + "description": "Gets all virtual networks in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual networks": { + "$ref": "./examples/VirtualNetworkListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_List", + "description": "Gets all virtual networks in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual networks in resource group": { + "$ref": "./examples/VirtualNetworkList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}": { + "delete": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Delete", + "description": "Deletes the specified subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete subnet": { + "$ref": "./examples/SubnetDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Get", + "description": "Gets the specified subnet by virtual network and resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get subnet": { + "$ref": "./examples/SubnetGet.json" + }, + "Get subnet with a delegation": { + "$ref": "./examples/SubnetGetWithDelegation.json" + }, + "Get subnet with sharing scope": { + "$ref": "./examples/SubnetGetWithSharingScope.json" + } + } + }, + "put": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_CreateOrUpdate", + "description": "Creates or updates a subnet in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "subnetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Subnet" + }, + "description": "Parameters supplied to the create or update subnet operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create subnet": { + "$ref": "./examples/SubnetCreate.json" + }, + "Create subnet with service endpoints": { + "$ref": "./examples/SubnetCreateServiceEndpoint.json" + }, + "Create subnet with a delegation": { + "$ref": "./examples/SubnetCreateWithDelegation.json" + }, + "Create subnet with sharing scope": { + "$ref": "./examples/SubnetCreateWithSharingScope.json" + }, + "Create subnet with service endpoints with network identifier": { + "$ref": "./examples/SubnetCreateServiceEndpointNetworkIdentifier.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies": { + "post": { + "operationId": "Subnets_PrepareNetworkPolicies", + "description": "Prepares a subnet by applying network intent policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "prepareNetworkPoliciesRequestParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrepareNetworkPoliciesRequest" + }, + "description": "Parameters supplied to prepare subnet by applying network intent policies." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Preparing subnet by applying network intent policies is successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Network Policies": { + "$ref": "./examples/SubnetPrepareNetworkPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/UnprepareNetworkPolicies": { + "post": { + "operationId": "Subnets_UnprepareNetworkPolicies", + "description": "Unprepares a subnet by removing network intent policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "unprepareNetworkPoliciesRequestParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UnprepareNetworkPoliciesRequest" + }, + "description": "Parameters supplied to unprepare subnet to remove network intent policies." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Unpreparing subnet by removing network intent policies is successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Unprepare Network Policies": { + "$ref": "./examples/SubnetUnprepareNetworkPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks": { + "get": { + "operationId": "ResourceNavigationLinks_List", + "description": "Gets a list of resource navigation links for a subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of resource navigation links for the subnet.", + "schema": { + "$ref": "#/definitions/ResourceNavigationLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Resource Navigation Links": { + "$ref": "./examples/VirtualNetworkGetResourceNavigationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ServiceAssociationLinks": { + "get": { + "operationId": "ServiceAssociationLinks_List", + "description": "Gets a list of service association links for a subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of service association links for the subnet.", + "schema": { + "$ref": "#/definitions/ServiceAssociationLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Service Association Links": { + "$ref": "./examples/VirtualNetworkGetServiceAssociationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets": { + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_List", + "description": "Gets all subnets in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Subnet resources.", + "schema": { + "$ref": "#/definitions/SubnetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List subnets": { + "$ref": "./examples/SubnetList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}": { + "delete": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Delete", + "description": "Deletes the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete peering": { + "$ref": "./examples/VirtualNetworkPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Get", + "description": "Gets the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get peering": { + "$ref": "./examples/VirtualNetworkPeeringGet.json" + }, + "Get peering with remote virtual network encryption": { + "$ref": "./examples/VirtualNetworkPeeringGetWithRemoteVirtualNetworkEncryption.json" + }, + "Get subnet peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringGet.json" + }, + "Get V6 subnet peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create or update virtual network peering operation." + }, + { + "name": "syncRemoteAddressSpace", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "true" + ], + "x-ms-enum": { + "name": "SyncRemoteAddressSpace", + "modelAsString": true + }, + "description": "Parameter indicates the intention to sync the peering with the current address space on the remote vNet after it's updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create peering": { + "$ref": "./examples/VirtualNetworkPeeringCreate.json" + }, + "Sync Peering": { + "$ref": "./examples/VirtualNetworkPeeringSync.json" + }, + "Create peering with remote virtual network encryption": { + "$ref": "./examples/VirtualNetworkPeeringCreateWithRemoteVirtualNetworkEncryption.json" + }, + "Create subnet peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringCreate.json" + }, + "Sync subnet Peering": { + "$ref": "./examples/VirtualNetworkSubnetPeeringSync.json" + }, + "Create V6 Subnet peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringCreate.json" + }, + "Sync V6 Subnet Peering": { + "$ref": "./examples/VirtualNetworkV6SubnetPeeringSync.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_List", + "description": "Gets all virtual network peerings in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkPeering resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List peerings": { + "$ref": "./examples/VirtualNetworkPeeringList.json" + }, + "List peerings with remote virtual network encryption": { + "$ref": "./examples/VirtualNetworkPeeringListWithRemoteVirtualNetworkEncryption.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability": { + "get": { + "operationId": "VirtualNetworks_CheckIPAddressAvailability", + "description": "Checks whether a private IP address is available for use.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "ipAddress", + "in": "query", + "required": true, + "type": "string", + "description": "The private IP address to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private IP address availability and list of other free addresses if the requested one is not available.", + "schema": { + "$ref": "#/definitions/IPAddressAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check IP address availability": { + "$ref": "./examples/VirtualNetworkCheckIPAddressAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages": { + "get": { + "operationId": "VirtualNetworks_ListUsage", + "description": "Lists usage stats.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Usage stats for vnet.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VnetGetUsage": { + "$ref": "./examples/VirtualNetworkListUsage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/ddosProtectionStatus": { + "post": { + "operationId": "VirtualNetworks_ListDdosProtectionStatus", + "description": "Gets the Ddos Protection Status of all IP Addresses under the Virtual Network", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The max number of ip addresses to return." + }, + { + "name": "skipToken", + "in": "query", + "required": false, + "type": "string", + "description": "The skipToken that is given with nextLink." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the Ddos Protection Status of all IP Addresses under this Virtual Network.", + "schema": { + "$ref": "#/definitions/VirtualNetworkDdosProtectionStatusResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Ddos Protection Status of a Virtual Network": { + "$ref": "./examples/VirtualNetworkGetDdosProtectionStatus.json" + } + } + } + } + }, + "definitions": { + "ServiceAssociationLinkPropertiesFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service association link resource." + }, + "allowDelete": { + "type": "boolean", + "description": "If true, the resource can be deleted." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + } + }, + "description": "Properties of ServiceAssociationLink." + }, + "ServiceAssociationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceAssociationLinkPropertiesFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ServiceAssociationLink resource." + }, + "ResourceNavigationLinkFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource navigation link resource." + } + }, + "description": "Properties of ResourceNavigationLink." + }, + "ResourceNavigationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceNavigationLinkFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource navigation link identifier." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ResourceNavigationLink resource." + }, + "ServiceDelegationPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)." + }, + "actions": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The actions permitted to the service upon delegation." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service delegation resource." + } + }, + "description": "Properties of a service delegation." + }, + "Delegation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceDelegationPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a subnet. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Details the service to which the subnet is delegated." + }, + "SubnetPropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of address prefixes for the subnet." + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference to the NetworkSecurityGroup resource." + }, + "routeTable": { + "$ref": "./routeTable.json#/definitions/RouteTable", + "description": "The reference to the RouteTable resource." + }, + "natGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Nat gateway associated with this subnet." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPropertiesFormat" + }, + "description": "An array of service endpoints." + }, + "serviceEndpointPolicies": { + "type": "array", + "items": { + "$ref": "./serviceEndpointPolicy.json#/definitions/ServiceEndpointPolicy" + }, + "description": "An array of service endpoint policies." + }, + "privateEndpoints": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint" + }, + "description": "An array of references to private endpoints." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/IPConfiguration" + }, + "description": "An array of references to the network interface IP configurations using subnet." + }, + "ipConfigurationProfiles": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkProfile.json#/definitions/IPConfigurationProfile" + }, + "description": "Array of IP configuration profiles which reference this subnet." + }, + "ipAllocations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of IpAllocation which reference this subnet." + }, + "resourceNavigationLinks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "An array of references to the external resources using subnet." + }, + "serviceAssociationLinks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "An array of references to services injecting into this subnet." + }, + "delegations": { + "type": "array", + "items": { + "$ref": "#/definitions/Delegation" + }, + "description": "An array of references to the delegations on the subnet." + }, + "purpose": { + "type": "string", + "readOnly": true, + "description": "A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the subnet resource." + }, + "privateEndpointNetworkPolicies": { + "type": "string", + "default": "Disabled", + "description": "Enable or Disable apply network policies on private end point in the subnet.", + "enum": [ + "Enabled", + "Disabled", + "NetworkSecurityGroupEnabled", + "RouteTableEnabled" + ], + "x-ms-enum": { + "name": "VirtualNetworkPrivateEndpointNetworkPolicies", + "modelAsString": true + } + }, + "privateLinkServiceNetworkPolicies": { + "type": "string", + "default": "Enabled", + "description": "Enable or Disable apply network policies on private link service in the subnet.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "VirtualNetworkPrivateLinkServiceNetworkPolicies", + "modelAsString": true + } + }, + "applicationGatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Application gateway IP configurations of virtual network resource." + }, + "sharingScope": { + "type": "string", + "default": null, + "description": "Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty.", + "enum": [ + "Tenant", + "DelegatedServices" + ], + "x-ms-enum": { + "name": "SharingScope", + "modelAsString": true + } + }, + "defaultOutboundAccess": { + "type": "boolean", + "description": "Set this property to false to disable default outbound connectivity for all VMs in the subnet." + }, + "ipamPoolPrefixAllocations": { + "type": "array", + "items": { + "$ref": "#/definitions/IpamPoolPrefixAllocation" + }, + "description": "A list of IPAM Pools for allocating IP address prefixes." + } + }, + "description": "Properties of the subnet." + }, + "ServiceEndpointPropertiesFormat": { + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "networkIdentifier": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SubResource as network identifier." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint resource." + } + }, + "description": "The service endpoint properties." + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." + }, + "localAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The local address space of the local virtual network that is peered." + }, + "localVirtualNetworkAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The current local address space of the local virtual network that is peered." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the address space peered with the remote virtual network." + }, + "remoteVirtualNetworkAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the current address space of the remote virtual network." + }, + "remoteBgpCommunities": { + "$ref": "#/definitions/VirtualNetworkBgpCommunities", + "default": null, + "description": "The reference to the remote virtual network's Bgp Communities." + }, + "remoteVirtualNetworkEncryption": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkEncryption", + "default": null, + "description": "The reference to the remote virtual network's encryption" + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringState", + "modelAsString": true + } + }, + "peeringSyncLevel": { + "type": "string", + "description": "The peering sync status of the virtual network peering.", + "enum": [ + "FullyInSync", + "RemoteNotInSync", + "LocalNotInSync", + "LocalAndRemoteNotInSync" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringLevel", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + }, + "doNotVerifyRemoteGateways": { + "type": "boolean", + "description": "If we need to verify the provisioning state of the remote gateway." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resourceGuid property of the Virtual Network peering resource." + }, + "peerCompleteVnets": { + "type": "boolean", + "description": "Whether complete virtual network address space is peered." + }, + "enableOnlyIPv6Peering": { + "type": "boolean", + "description": "Whether only Ipv6 address space is peered for subnet peering." + }, + "localSubnetNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of local subnet names that are subnet peered with remote virtual network." + }, + "remoteSubnetNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of remote subnet names from remote virtual network that are subnet peered." + } + }, + "description": "Properties of the virtual network peering." + }, + "Subnet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubnetPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Subnet in a virtual network resource." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "Properties of the virtual network peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peerings in a virtual network resource." + }, + "SubnetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "The subnets in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network." + }, + "ResourceNavigationLinksListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "The resource navigation links in a subnet." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ResourceNavigationLinks_List operation." + }, + "ServiceAssociationLinksListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "The service association links in a subnet." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ServiceAssociationLinks_List operation." + }, + "VirtualNetworkPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "The peerings in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network." + }, + "VirtualNetworkPropertiesFormat": { + "properties": { + "addressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." + }, + "dhcpOptions": { + "$ref": "#/definitions/DhcpOptions", + "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." + }, + "flowTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The FlowTimeout value (in minutes) for the Virtual Network" + }, + "subnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "A list of subnets in a Virtual Network." + }, + "virtualNetworkPeerings": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "A list of peerings in a Virtual Network." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resourceGuid property of the Virtual Network resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network resource." + }, + "enableDdosProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource." + }, + "enableVmProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if VM protection is enabled for all the subnets in the virtual network." + }, + "ddosProtectionPlan": { + "$ref": "./network.json#/definitions/SubResource", + "default": null, + "description": "The DDoS protection plan associated with the virtual network." + }, + "bgpCommunities": { + "$ref": "#/definitions/VirtualNetworkBgpCommunities", + "default": null, + "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." + }, + "encryption": { + "$ref": "#/definitions/VirtualNetworkEncryption", + "default": null, + "description": "Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet." + }, + "ipAllocations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of IpAllocation which reference this VNET." + }, + "flowLogs": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkWatcher.json#/definitions/FlowLog" + }, + "description": "A collection of references to flow log resources." + }, + "privateEndpointVNetPolicies": { + "readOnly": false, + "$ref": "#/definitions/PrivateEndpointVNetPolicies", + "description": "Private Endpoint VNet Policies." + }, + "defaultPublicNatGateway": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to the default public nat gateway being used by this virtual network resource." + } + }, + "description": "Properties of the virtual network." + }, + "VirtualNetwork": { + "properties": { + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of the virtual network." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPropertiesFormat", + "description": "Properties of the virtual network." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network resource." + }, + "VirtualNetworkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "A list of VirtualNetwork resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworks API service call." + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + }, + "ipamPoolPrefixAllocations": { + "type": "array", + "items": { + "$ref": "#/definitions/IpamPoolPrefixAllocation" + }, + "description": "A list of IPAM Pools allocating IP address prefixes." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + }, + "DhcpOptions": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of DNS servers IP addresses." + } + }, + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options." + }, + "PrivateEndpointVNetPolicies": { + "type": "string", + "description": "Private Endpoint VNet Policies.", + "enum": [ + "Disabled", + "Basic" + ], + "x-ms-enum": { + "name": "PrivateEndpointVNetPolicies", + "modelAsString": true + } + }, + "VirtualNetworkBgpCommunities": { + "properties": { + "virtualNetworkCommunity": { + "type": "string", + "description": "The BGP community associated with the virtual network." + }, + "regionalCommunity": { + "type": "string", + "readOnly": true, + "description": "The BGP community associated with the region of the virtual network." + } + }, + "required": [ + "virtualNetworkCommunity" + ], + "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." + }, + "VirtualNetworkEncryption": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if encryption is enabled on the virtual network." + }, + "enforcement": { + "type": "string", + "description": "If the encrypted VNet allows VM that does not support encryption. This field is for future support, AllowUnencrypted is the only supported value at general availability.", + "enum": [ + "DropUnencrypted", + "AllowUnencrypted" + ], + "x-ms-enum": { + "name": "VirtualNetworkEncryptionEnforcement", + "modelAsString": true + } + } + }, + "required": [ + "enabled" + ], + "description": "Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet." + }, + "IPAddressAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Private IP address availability." + }, + "availableIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Contains other available private IP addresses if the asked for address is taken." + }, + "isPlatformReserved": { + "type": "boolean", + "description": "Private IP address platform reserved." + } + }, + "description": "Response for CheckIPAddressAvailability API service call." + }, + "VirtualNetworkListUsageResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VirtualNetworkUsage" + }, + "description": "VirtualNetwork usage stats." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the virtual networks GetUsage API service call." + }, + "VirtualNetworkUsage": { + "properties": { + "currentValue": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates number of IPs used from the Subnet." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Subnet identifier." + }, + "limit": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates the size of the subnet." + }, + "name": { + "$ref": "#/definitions/VirtualNetworkUsageName", + "readOnly": true, + "description": "The name containing common and localized value for usage." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Usage units. Returns 'Count'." + } + }, + "description": "Usage details for subnet." + }, + "VirtualNetworkUsageName": { + "properties": { + "localizedValue": { + "type": "string", + "readOnly": true, + "description": "Localized subnet size and usage string." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "Subnet size and usage string." + } + }, + "description": "Usage strings container." + }, + "PrepareNetworkPoliciesRequest": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service for which subnet is being prepared for." + }, + "networkIntentPolicyConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkIntentPolicyConfiguration" + }, + "description": "A list of NetworkIntentPolicyConfiguration." + } + }, + "description": "Details of PrepareNetworkPolicies for Subnet." + }, + "UnprepareNetworkPoliciesRequest": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service for which subnet is being unprepared for." + } + }, + "description": "Details of UnprepareNetworkPolicies for Subnet." + }, + "NetworkIntentPolicyConfiguration": { + "properties": { + "networkIntentPolicyName": { + "type": "string", + "description": "The name of the Network Intent Policy for storing in target subscription." + }, + "sourceNetworkIntentPolicy": { + "$ref": "#/definitions/NetworkIntentPolicy", + "description": "Source network intent policy." + } + }, + "description": "Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest." + }, + "NetworkIntentPolicy": { + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network Intent Policy resource." + }, + "VirtualNetworkDdosProtectionStatusResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./publicIpAddress.json#/definitions/PublicIpDdosProtectionStatusResult" + }, + "x-ms-identifiers": [], + "description": "The Ddos Protection Status Result for each public ip under a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for GetVirtualNetworkDdosProtectionStatusOperation." + }, + "IpamPoolPrefixAllocation": { + "type": "object", + "properties": { + "pool": { + "type": "object", + "x-ms-client-flatten": true, + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource id of the associated Azure IpamPool resource." + } + } + }, + "numberOfIpAddresses": { + "type": "string", + "description": "Number of IP addresses to allocate." + }, + "allocatedAddressPrefixes": { + "description": "List of assigned IP address prefixes in the IpamPool of the associated resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + }, + "description": "IpamPool prefix allocation reference." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetworkGateway.json new file mode 100644 index 000000000000..84c68d02dc9b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetworkGateway.json @@ -0,0 +1,5882 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/virtualNetworkGateways/{virtualNetworkGatewayName}": { + "put": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Parameters supplied to create or update virtual network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayUpdate.json" + }, + "UpdateVirtualNetworkScalableGateway": { + "$ref": "./examples/VirtualNetworkScalableGatewayUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Get", + "description": "Gets the specified virtual network gateway by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayGet.json" + }, + "GetVirtualNetworkScalableGateway": { + "$ref": "./examples/VirtualNetworkScalableGatewayGet.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Delete", + "description": "Deletes the specified virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_UpdateTags", + "description": "Updates a virtual network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayTags": { + "$ref": "./examples/VirtualNetworkGatewayUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_List", + "description": "Gets all virtual network gateways by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaysinResourceGroup": { + "$ref": "./examples/VirtualNetworkGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ListConnections", + "description": "Gets all the connections in a virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualNetworkGatewaysListConnections": { + "$ref": "./examples/VirtualNetworkGatewaysListConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Reset", + "description": "Resets the primary of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "gatewayVip", + "in": "query", + "required": false, + "type": "string", + "description": "Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation reset the primary of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ResetVpnClientSharedKey", + "description": "Resets the VPN client shared key of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the vpn client shared key of the virtual network gateway." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVpnClientSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayResetVpnClientSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Generatevpnclientpackage", + "description": "Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN client package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateVPNClientPackage": { + "$ref": "./examples/VirtualNetworkGatewayGenerateVpnClientPackage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateVirtualNetworkGatewayVPNProfile": { + "$ref": "./examples/VirtualNetworkGatewayGenerateVpnProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnProfilePackageUrl", + "description": "Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVPNProfilePackageURL": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetBgpPeerStatus", + "description": "The GetBgpPeerStatus operation retrieves the status of all BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": false, + "type": "string", + "description": "The IP address of the peer to retrieve the status of." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of BGP peer statuses.", + "schema": { + "$ref": "#/definitions/BgpPeerStatusListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayBGPPeerStatus": { + "$ref": "./examples/VirtualNetworkGatewayGetBGPPeerStatus.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SupportedVpnDevices", + "description": "Gets a xml format representation for supported vpn devices.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for supported vpn devices.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaySupportedVPNDevices": { + "$ref": "./examples/VirtualNetworkGatewaySupportedVpnDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/listRadiusSecrets": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ListRadiusSecrets", + "description": "List all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List all Radius servers with respective radius secrets from virtual network gateway VpnClientConfiguration.", + "schema": { + "$ref": "#/definitions/RadiusAuthServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListAllVirtualNetworkGatewayRadiusServerSecrets": { + "$ref": "./examples/AllVirtualNetworkGatewayRadiusServerSecretsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetLearnedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes.", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayLearnedRoutes": { + "$ref": "./examples/VirtualNetworkGatewayLearnedRoutes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetAdvertisedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": true, + "type": "string", + "description": "The IP address of the peer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes.", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayAdvertisedRoutes": { + "$ref": "./examples/VirtualNetworkGatewayGetAdvertisedRoutes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getResiliencyInformation": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetResiliencyInformation", + "description": "This operation retrieves the resiliency information for an Express Route Gateway, including the gateway's current resiliency score and recommendations to further improve the score", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "attemptRefresh", + "in": "query", + "required": false, + "type": "boolean", + "description": "Attempt to recalculate the Resiliency Information for the gateway" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Resiliency information for the gateway", + "schema": { + "$ref": "#/definitions/GatewayResiliencyInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayResiliencyInformation": { + "$ref": "./examples/VirtualNetworkGatewayGetResiliencyInformation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getRoutesInformation": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetRoutesInformation", + "description": "This operation retrieves the route set information for an Express Route Gateway based on their resiliency", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "attemptRefresh", + "in": "query", + "required": false, + "type": "boolean", + "description": "Attempt to recalculate the Route Sets Information for the gateway" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of route sets learned by the gateway based on their resiliency", + "schema": { + "$ref": "#/definitions/GatewayRouteSetsInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayRoutesInformation": { + "$ref": "./examples/VirtualNetworkGatewayGetRoutesInformation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SetVpnclientIpsecParameters", + "description": "The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "vpnclientIpsecParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + }, + "description": "Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Set VirtualNetworkGateway VpnClientIpsecParameters": { + "$ref": "./examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientIpsecParameters", + "description": "The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the set vpnclient ipsec parameters for P2S client of VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Get VirtualNetworkGateway VpnClientIpsecParameters": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_VpnDeviceConfigurationScript", + "description": "Gets a xml format representation for vpn device configuration script.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection for which the configuration script is generated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnDeviceScriptParameters" + }, + "description": "Parameters supplied to the generate vpn device script operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for vpn device configuration script.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVPNDeviceConfigurationScript": { + "$ref": "./examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StartPacketCapture", + "description": "Starts packet capture on virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStartParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to start packet capture on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Start packet capture on virtual network gateway without filter": { + "$ref": "./examples/VirtualNetworkGatewayStartPacketCapture.json" + }, + "Start packet capture on virtual network gateway with filter": { + "$ref": "./examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StopPacketCapture", + "description": "Stops packet capture on virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStopParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to stop packet capture on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Stop packet capture on virtual network gateway": { + "$ref": "./examples/VirtualNetworkGatewayStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverAllTestsDetails": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetFailoverAllTestDetails", + "description": "This operation retrieves the details of all the failover tests performed on the gateway for different peering locations", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "type", + "in": "query", + "required": true, + "type": "string", + "description": "The type of failover test" + }, + { + "name": "fetchLatest", + "in": "query", + "required": true, + "type": "boolean", + "description": "Fetch only the latest tests for each peering location" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Failover test details for the gateway", + "schema": { + "$ref": "#/definitions/ExpressRouteFailoverAllTestDetails" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayGetFailoverAllTestsDetails": { + "$ref": "./examples/VirtualNetworkGatewayGetFailoverAllTestsDetails.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getFailoverSingleTestDetails": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetFailoverSingleTestDetails", + "description": "This operation retrieves the details of a particular failover test performed on the gateway based on the test Guid", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peeringLocation", + "in": "query", + "required": true, + "type": "string", + "description": "Peering location of the test" + }, + { + "name": "failoverTestId", + "in": "query", + "required": true, + "type": "string", + "description": "The unique Guid value which identifies the test" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Details of the failover test", + "schema": { + "$ref": "#/definitions/ExpressRouteFailoverSingleTestDetailsObject" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayGetFailoverSingleTestDetails": { + "$ref": "./examples/VirtualNetworkGatewayGetFailoverSingleTestDetails.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startSiteFailoverTest": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StartExpressRouteSiteFailoverSimulation", + "description": "This operation starts failover simulation on the gateway for the specified peering location", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peeringLocation", + "in": "query", + "required": true, + "type": "string", + "description": "Peering location of the test" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "200": { + "description": "Request successful. The operation start failover simulation started on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayStartSiteFailoverSimulation": { + "$ref": "./examples/VirtualNetworkGatewayStartSiteFailoverSimulation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopSiteFailoverTest": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StopExpressRouteSiteFailoverSimulation", + "description": "This operation stops failover simulation on the gateway for the specified peering location", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "stopParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteFailoverStopApiParameters" + }, + "description": "Virtual network gateway stop simulation parameters supplied to stop failover simulation on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "200": { + "description": "Request successful. Started the operation stop failover simulation on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayStopSiteFailoverSimulation": { + "$ref": "./examples/VirtualNetworkGatewayStopSiteFailoverSimulation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Parameters supplied to the create or update virtual network gateway connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateVirtualNetworkGatewayConnection_S2S": { + "$ref": "./examples/VirtualNetworkGatewayConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Get", + "description": "Gets the specified virtual network gateway connection by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGet.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Delete", + "description": "Deletes the specified virtual network Gateway connection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_UpdateTags", + "description": "Updates a virtual network gateway connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayConnectionTags": { + "$ref": "./examples/VirtualNetworkGatewayConnectionUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_SetSharedKey", + "description": "The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + }, + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionSetSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetSharedKey", + "description": "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection shared key name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGetSharedKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_List", + "description": "The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation resets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewayConnectionsinResourceGroup": { + "$ref": "./examples/VirtualNetworkGatewayConnectionsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetSharedKey", + "description": "The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection reset shared key Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + }, + "description": "Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + } + }, + "202": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionResetSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/startPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_StartPacketCapture", + "description": "Starts packet capture on virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStartParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Start packet capture on virtual network gateway connection without filter": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStartPacketCapture.json" + }, + "Start packet capture on virtual network gateway connection with filter": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/stopPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_StopPacketCapture", + "description": "Stops packet capture on virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStopParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Stop packet capture on virtual network gateway connection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/getikesas": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetIkeSas", + "description": "Lists IKE Security Associations for the virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation GetIkeSas will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation getikesas completed on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "The operation GetIkeSas could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionIkeSa": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGetIkeSas.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/resetconnection": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetConnection", + "description": "Resets the virtual network gateway connection specified.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "The operation resetconnection could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": { + "put": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a local network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "Parameters supplied to the create or update local network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Get", + "description": "Gets the specified local network gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayGet.json" + } + } + }, + "delete": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Delete", + "description": "Deletes the specified local network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_UpdateTags", + "description": "Updates a local network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update local network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateLocalNetworkGatewayTags": { + "$ref": "./examples/LocalNetworkGatewayUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways": { + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_List", + "description": "Gets all the local network gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LocalNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/LocalNetworkGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListLocalNetworkGateways": { + "$ref": "./examples/LocalNetworkGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientConnectionHealth", + "description": "Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of VPN client connection health details.", + "schema": { + "$ref": "#/definitions/VpnClientConnectionHealthDetailListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVpnclientConnectionHealth": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/disconnectVirtualNetworkGatewayVpnConnections": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections", + "description": "Disconnect vpn connections of virtual network gateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "./virtualWan.json#/definitions/P2SVpnConnectionRequest" + }, + "description": "The parameters are supplied to disconnect vpn connections." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation disconnects the requested vpn connections." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disconnect VpnConnections from Virtual Network Gateway": { + "$ref": "./examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules/{natRuleName}": { + "get": { + "operationId": "VirtualNetworkGatewayNatRules_Get", + "x-ms-examples": { + "VirtualNetworkGatewayNatRuleGet": { + "$ref": "./examples/VirtualNetworkGatewayNatRuleGet.json" + } + }, + "description": "Retrieves the details of a nat rule.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the Virtual Network Gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualNetworkGatewayNatRules_CreateOrUpdate", + "x-ms-examples": { + "VirtualNetworkGatewayNatRulePut": { + "$ref": "./examples/VirtualNetworkGatewayNatRulePut.json" + } + }, + "description": "Creates a nat rule to a scalable virtual network gateway if it doesn't exist else updates the existing nat rules.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the Virtual Network Gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "NatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + }, + "description": "Parameters supplied to create or Update a Nat Rule." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + } + }, + "201": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualNetworkGatewayNatRules_Delete", + "x-ms-examples": { + "VirtualNetworkGatewayNatRuleDelete": { + "$ref": "./examples/VirtualNetworkGatewayNatRuleDelete.json" + } + }, + "description": "Deletes a nat rule.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the Virtual Network Gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Nat Rule deleted." + }, + "202": { + "description": "Request received successfully. Nat Rule deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No nat rules exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/natRules": { + "get": { + "operationId": "VirtualNetworkGatewayNatRules_ListByVirtualNetworkGateway", + "x-ms-examples": { + "VirtualNetworkGatewayNatRuleList": { + "$ref": "./examples/VirtualNetworkGatewayNatRuleList.json" + } + }, + "description": "Retrieves all nat rules for a particular virtual network gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the virtual network gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Nat rules for a virtual network gateway.", + "schema": { + "$ref": "#/definitions/ListVirtualNetworkGatewayNatRulesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/prepareMigration": { + "post": { + "operationId": "VirtualNetworkGateways_InvokePrepareMigration", + "description": "Trigger prepare migration for the virtual network gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the virtual network gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "migrationParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayMigrationParameters" + }, + "description": "Parameters supplied to the Begin Prepare migration on basic vpn gateway through Network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Request received successfully. Prepare migration in progress; follow the Location header to poll for final outcome.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayPrepareMigration": { + "$ref": "./examples/VirtualNetworkGatewayPrepareMigration.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/executeMigration": { + "post": { + "operationId": "VirtualNetworkGateways_InvokeExecuteMigration", + "description": "Trigger execute migration for the virtual network gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the virtual network gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Request received successfully. Execute migration in progress; follow the Location header to poll for final outcome.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayExecuteMigration": { + "$ref": "./examples/VirtualNetworkGatewayExecuteMigration.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/commitMigration": { + "post": { + "operationId": "VirtualNetworkGateways_InvokeCommitMigration", + "description": "Trigger commit migration for the virtual network gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the virtual network gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Request received successfully. Commit migration in progress; follow the Location header to poll for final outcome.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayCommitMigration": { + "$ref": "./examples/VirtualNetworkGatewayCommitMigration.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/abortMigration": { + "post": { + "operationId": "VirtualNetworkGateways_InvokeAbortMigration", + "description": "Trigger abort migration for the virtual network gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the virtual network gateway." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Request received successfully. Abort migration in progress; follow the Location header to poll for final outcome.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualNetworkGatewayAbortMigration": { + "$ref": "./examples/VirtualNetworkGatewayAbortMigration.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "VirtualNetworkGatewayMigrationParameters": { + "type": "object", + "properties": { + "migrationType": { + "$ref": "#/definitions/VirtualNetworkGatewayMigrationType" + }, + "resourceUrl": { + "type": "string", + "description": "Resource url that needs to be passed in to migration." + } + }, + "required": [ + "migrationType" + ], + "description": "Virtual network gateway migration parameters." + }, + "VirtualNetworkGatewayMigrationType": { + "type": "string", + "enum": [ + "UpgradeDeploymentToStandardIP" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayMigrationType", + "modelAsString": true, + "values": [ + { + "value": "UpgradeDeploymentToStandardIP", + "name": "UpgradeDeploymentToStandardIP", + "description": "Indicates that it is a migration process from basic IP CSES to standard IP VMSS." + } + ] + }, + "description": "MigrationType for the virtual network gateway." + }, + "VirtualNetworkGatewayMigrationStatus": { + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "Represent the current state of gateway migration.", + "enum": [ + "None", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayMigrationState", + "modelAsString": true + } + }, + "phase": { + "type": "string", + "description": "Represent the current migration phase of gateway.", + "enum": [ + "None", + "Prepare", + "PrepareSucceeded", + "Execute", + "ExecuteSucceeded", + "Commit", + "CommitSucceeded", + "AbortSucceeded", + "Abort" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayMigrationPhase", + "modelAsString": true, + "values": [ + { + "value": "None", + "name": "None", + "description": "No migration phase set on gateway." + }, + { + "value": "Prepare", + "name": "Prepare", + "description": "Gateway is going through prepare migration or prepare has failed. Please see state and error details for more information." + }, + { + "value": "PrepareSucceeded", + "name": "PrepareSucceeded", + "description": "Prepare succeeded on gateway." + }, + { + "value": "Execute", + "name": "Execute", + "description": "Gateway is going through execute migration or execute has failed. Please see state and error details for more information." + }, + { + "value": "ExecuteSucceeded", + "name": "ExecuteSucceeded", + "description": "Execute succeeded on gateway." + }, + { + "value": "Commit", + "name": "Commit", + "description": "Gateway is going through commit migration or commit has failed. Please see state and error details for more information." + }, + { + "value": "CommitSucceeded", + "name": "CommitSucceeded", + "description": "Commit succeeded, represent migration is complete for the gateway." + }, + { + "value": "AbortSucceeded", + "name": "AbortSucceeded", + "description": "Represent abort succeeded on gateway, start with prepare to retrigger migration." + }, + { + "value": "Abort", + "name": "Abort", + "description": "Gateway is going through abort migration or abort has failed. Please see state and error details for more information." + } + ] + } + }, + "errorMessage": { + "type": "string", + "description": "Error if any occurs during migration." + } + }, + "description": "Migration status for the Virtual Network Gateway." + }, + "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the public IP resource." + }, + "privateIPAddress": { + "readOnly": true, + "type": "string", + "description": "Private IP Address for this gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway IP configuration resource." + } + }, + "description": "Properties of VirtualNetworkGatewayIPConfiguration." + }, + "VirtualNetworkGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the virtual network gateway ip configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration for virtual network gateway." + }, + "VirtualNetworkGatewayNatRuleProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT Rule resource." + }, + "type": { + "type": "string", + "description": "The type of NAT rule for VPN NAT.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "VpnNatRuleType", + "modelAsString": true + } + }, + "mode": { + "type": "string", + "description": "The Source NAT direction of a VPN NAT.", + "enum": [ + "EgressSnat", + "IngressSnat" + ], + "x-ms-enum": { + "name": "VpnNatRuleMode", + "modelAsString": true + } + }, + "internalMappings": { + "type": "array", + "items": { + "$ref": "./virtualWan.json#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address internal mapping for NAT." + }, + "externalMappings": { + "type": "array", + "items": { + "$ref": "./virtualWan.json#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address external mapping for NAT." + }, + "ipConfigurationId": { + "type": "string", + "description": "The IP Configuration ID this NAT rule applies to." + } + }, + "description": "Parameters for VirtualNetworkGatewayNatRule." + }, + "VirtualNetworkGatewayNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayNatRuleProperties", + "description": "Properties of the Virtual Network Gateway NAT rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VirtualNetworkGatewayNatRule Resource." + }, + "VirtualNetworkGatewayPropertiesFormat": { + "properties": { + "autoScaleConfiguration": { + "$ref": "#/definitions/VirtualNetworkGatewayAutoScaleConfiguration", + "description": "Autoscale configuration for virutal network gateway" + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" + }, + "description": "IP configurations for virtual network gateway." + }, + "gatewayType": { + "type": "string", + "description": "The type of this virtual network gateway.", + "enum": [ + "Vpn", + "ExpressRoute", + "LocalGateway" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayType", + "modelAsString": true + } + }, + "vpnType": { + "type": "string", + "description": "The type of this virtual network gateway.", + "enum": [ + "PolicyBased", + "RouteBased" + ], + "x-ms-enum": { + "name": "VpnType", + "modelAsString": true + } + }, + "vpnGatewayGeneration": { + "type": "string", + "description": "The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.", + "enum": [ + "None", + "Generation1", + "Generation2" + ], + "x-ms-enum": { + "name": "VpnGatewayGeneration", + "modelAsString": true + } + }, + "enableBgp": { + "type": "boolean", + "description": "Whether BGP is enabled for this virtual network gateway or not." + }, + "enablePrivateIpAddress": { + "type": "boolean", + "description": "Whether private IP needs to be enabled on this gateway for connections or not." + }, + "virtualNetworkGatewayMigrationStatus": { + "$ref": "#/definitions/VirtualNetworkGatewayMigrationStatus", + "description": "The reference to the VirtualNetworkGatewayMigrationStatus which represents the status of migration." + }, + "activeActive": { + "type": "boolean", + "description": "ActiveActive flag." + }, + "enableHighBandwidthVpnGateway": { + "type": "boolean", + "description": "To enable Advanced Connectivity feature for VPN gateway" + }, + "disableIPSecReplayProtection": { + "type": "boolean", + "description": "disableIPSecReplayProtection flag." + }, + "gatewayDefaultSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." + }, + "sku": { + "$ref": "#/definitions/VirtualNetworkGatewaySku", + "description": "The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." + }, + "vpnClientConfiguration": { + "$ref": "#/definitions/VpnClientConfiguration", + "description": "The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations." + }, + "virtualNetworkGatewayPolicyGroups": { + "type": "array", + "description": "The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayPolicyGroup" + } + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Virtual network gateway's BGP speaker settings." + }, + "customRoutes": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway resource." + }, + "enableDnsForwarding": { + "type": "boolean", + "description": "Whether dns forwarding is enabled or not." + }, + "inboundDnsForwardingEndpoint": { + "type": "string", + "readOnly": true, + "description": "The IP address allocated by the gateway to which dns requests can be sent." + }, + "vNetExtendedLocationResourceId": { + "type": "string", + "description": "Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet." + }, + "natRules": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + }, + "description": "NatRules for virtual network gateway." + }, + "enableBgpRouteTranslationForNat": { + "type": "boolean", + "description": "EnableBgpRouteTranslationForNat flag." + }, + "allowVirtualWanTraffic": { + "type": "boolean", + "description": "Configures this gateway to accept traffic from remote Virtual WAN networks." + }, + "allowRemoteVnetTraffic": { + "type": "boolean", + "description": "Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN." + }, + "adminState": { + "type": "string", + "description": "Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "adminState", + "modelAsString": true + } + }, + "resiliencyModel": { + "type": "string", + "description": "Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed", + "enum": [ + "SingleHomed", + "MultiHomed" + ], + "x-ms-enum": { + "name": "resiliencyModel", + "modelAsString": true + } + } + }, + "description": "VirtualNetworkGateway properties." + }, + "VirtualNetworkGatewayAutoScaleConfiguration": { + "properties": { + "bounds": { + "$ref": "#/definitions/VirtualNetworkGatewayAutoScaleBounds", + "description": "The bounds of the autoscale configuration" + } + }, + "description": "Virtual Network Gateway Autoscale Configuration details" + }, + "VirtualNetworkGatewayAutoScaleBounds": { + "properties": { + "min": { + "type": "integer", + "description": "Minimum scale Units for Autoscale configuration" + }, + "max": { + "type": "integer", + "description": "Maximum Scale Units for Autoscale configuration" + } + } + }, + "VpnClientRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN client root certificate resource." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of SSL certificates of application gateway." + }, + "VpnClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "VPN client root certificate of virtual network gateway." + }, + "VpnClientRevokedCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN client revoked certificate resource." + } + }, + "description": "Properties of the revoked VPN client certificate of virtual network gateway." + }, + "VpnClientRevokedCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat", + "description": "Properties of the vpn client revoked certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VPN client revoked certificate of virtual network gateway." + }, + "RadiusServer": { + "properties": { + "radiusServerAddress": { + "type": "string", + "description": "The address of this radius server." + }, + "radiusServerScore": { + "type": "integer", + "format": "int64", + "description": "The initial score assigned to this radius server." + }, + "radiusServerSecret": { + "type": "string", + "x-ms-secret": true, + "description": "The secret used for this radius server. We will no longer return radiusServerSecret in VirtualNetworkGateway Create/Update/Get/List/UpdateTags APIs response. Please use VirtualNetworkGateway ListRadiusSecrets API to fetch radius server secrets." + } + }, + "required": [ + "radiusServerAddress" + ], + "description": "Radius Server Settings." + }, + "VpnClientConfiguration": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRootCertificate" + }, + "description": "VpnClientRootCertificate for virtual network gateway." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRevokedCertificate" + }, + "description": "VpnClientRevokedCertificate for Virtual network gateway." + }, + "vpnClientProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN client protocol enabled for the virtual network gateway.", + "enum": [ + "IkeV2", + "SSTP", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnClientProtocol", + "modelAsString": true + } + }, + "description": "VpnClientProtocols for Virtual network gateway." + }, + "vpnAuthenticationTypes": { + "type": "array", + "items": { + "type": "string", + "description": "VPN authentication types enabled for the virtual network gateway.", + "enum": [ + "Certificate", + "Radius", + "AAD" + ], + "x-ms-enum": { + "name": "VpnAuthenticationType", + "modelAsString": true + } + }, + "description": "VPN authentication types for the virtual network gateway.." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for virtual network gateway P2S client." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServerSecret": { + "type": "string", + "x-ms-secret": true, + "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection. We will no longer return radiusServerSecret in VirtualNetworkGateway Create/Update/Get/List/UpdateTags APIs response. Please use VirtualNetworkGateway ListRadiusSecrets API to fetch radius server secrets." + }, + "radiusServers": { + "type": "array", + "items": { + "$ref": "#/definitions/RadiusServer" + }, + "description": "The radiusServers property for multiple radius server configuration." + }, + "aadTenant": { + "type": "string", + "description": "The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "aadAudience": { + "type": "string", + "description": "The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "aadIssuer": { + "type": "string", + "description": "The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "vngClientConnectionConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VngClientConnectionConfiguration" + }, + "description": "per ip address pool connection policy for virtual network gateway P2S client." + } + }, + "description": "VpnClientConfiguration for P2S client." + }, + "VirtualNetworkGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Gateway SKU name.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw4", + "VpnGw5", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "VpnGw4AZ", + "VpnGw5AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ", + "ErGwScale" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Gateway SKU tier.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw4", + "VpnGw5", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "VpnGw4AZ", + "VpnGw5AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ", + "ErGwScale" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuTier", + "modelAsString": true + } + }, + "capacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The capacity." + } + }, + "description": "VirtualNetworkGatewaySku details." + }, + "BgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + }, + "peerWeight": { + "type": "integer", + "format": "int32", + "description": "The weight added to routes learned from this BGP speaker." + }, + "bgpPeeringAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationBgpPeeringAddress" + }, + "description": "BGP peering address with IP configuration ID for virtual network gateway." + } + }, + "description": "BGP settings details." + }, + "BgpPeerStatus": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The virtual network gateway's local address." + }, + "neighbor": { + "type": "string", + "readOnly": true, + "description": "The remote BGP peer." + }, + "asn": { + "type": "integer", + "format": "int64", + "readOnly": true, + "minimum": 0, + "maximum": 4294967295, + "description": "The autonomous system number of the remote BGP peer." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The BGP peer state.", + "enum": [ + "Unknown", + "Stopped", + "Idle", + "Connecting", + "Connected" + ], + "x-ms-enum": { + "name": "BgpPeerState", + "modelAsString": true + } + }, + "connectedDuration": { + "type": "string", + "readOnly": true, + "description": "For how long the peering has been up." + }, + "routesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of routes learned from this peer." + }, + "messagesSent": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages sent." + }, + "messagesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages received." + } + }, + "description": "BGP peer status details." + }, + "GatewayRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The gateway's local address." + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix." + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop." + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from." + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from." + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence." + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight." + } + }, + "description": "Gateway routing details." + }, + "VirtualNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat", + "description": "Properties of the virtual network gateway." + }, + "extendedLocation": { + "$ref": "./network.json#/definitions/ExtendedLocation", + "description": "The extended location of type local virtual network gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the virtual network gateway, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VpnClientParameters": { + "properties": { + "processorArchitecture": { + "type": "string", + "description": "VPN client Processor Architecture.", + "enum": [ + "Amd64", + "X86" + ], + "x-ms-enum": { + "name": "ProcessorArchitecture", + "modelAsString": true + } + }, + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + }, + "radiusServerAuthCertificate": { + "type": "string", + "description": "The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication." + }, + "clientRootCertificates": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS." + } + }, + "description": "Vpn Client Parameters for package generation." + }, + "VirtualNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "A list of VirtualNetworkGateway resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGateways API service call." + }, + "ListVirtualNetworkGatewayNatRulesResult": { + "description": "Result of the request to list all nat rules to a virtual network gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayNatRule" + }, + "description": "List of Nat Rules." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "BgpPeerStatusListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpPeerStatus" + }, + "description": "List of BGP peers." + } + }, + "description": "Response for list BGP peer status API service call." + }, + "GatewayRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRoute" + }, + "description": "List of gateway routes." + } + }, + "description": "List of virtual network gateway routes." + }, + "RadiusAuthServer": { + "type": "object", + "properties": { + "radiusServerAddress": { + "type": "string", + "description": "Radius server IPAddress" + }, + "radiusServerSecret": { + "type": "string", + "x-ms-secret": true, + "description": "Radius server secret" + } + }, + "description": "Gateway or VpnServerConfiguration Radius server with radius secret details" + }, + "RadiusAuthServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RadiusAuthServer" + }, + "description": "List of Radius servers with respective radius secrets.", + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + }, + "description": "List of Radius servers with respective radius secrets." + }, + "GatewayResiliencyInformation": { + "type": "object", + "properties": { + "overallScore": { + "type": "string", + "description": "Current Resiliency Score for the gateway" + }, + "scoreChange": { + "type": "string", + "description": "Update in the Resiliency Score for the gateway from the last computed score" + }, + "minScoreFromRecommendations": { + "type": "string", + "description": "Minimum increase expected in the score if the at least one of the recommendations is applied for the gateway" + }, + "maxScoreFromRecommendations": { + "type": "string", + "description": "Maximum increase expected in the score if all of the recommendations are applied for the gateway" + }, + "lastComputedTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp denoting the last time when the resiliency score was computed for the gateway" + }, + "nextEligibleComputeTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp denoting the next eligible time to re-compute the resiliency score for the gateway" + }, + "components": { + "type": "array", + "items": { + "$ref": "#/definitions/ResiliencyRecommendationComponents" + }, + "description": "List of Resiliency based Recommendation Components for the gateway" + } + }, + "description": "Gateway Resiliency Information" + }, + "ResiliencyRecommendationComponents": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Resiliency based Recommendation Component" + }, + "currentScore": { + "type": "string", + "description": "Current Score of the gateway" + }, + "maxScore": { + "type": "string", + "description": "Max score that the gateway can achieve if the specified recommendation is applied" + }, + "recommendations": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayResiliencyRecommendation" + }, + "description": "List of Gateway Resiliency based Recommendations" + } + }, + "description": "Gateway Resiliency based Recommendations" + }, + "GatewayResiliencyRecommendation": { + "type": "object", + "properties": { + "recommendationTitle": { + "type": "string", + "description": "Recommendation Title" + }, + "recommendationId": { + "type": "string", + "description": "Recommendation Id" + }, + "severity": { + "type": "string", + "description": "Impact associated with the recommendation" + }, + "recommendationText": { + "type": "string", + "description": "Recommendation details" + }, + "callToActionText": { + "type": "string", + "description": "Acton items to apply the recommendation" + }, + "callToActionLink": { + "type": "string", + "description": "Link to the public documentation for the associated recommendation" + } + }, + "description": "Resiliency Recommendation details" + }, + "RouteSourceDetails": { + "type": "object", + "properties": { + "circuit": { + "type": "string", + "description": "Express Route Circuit identifier" + }, + "pri": { + "type": "string", + "description": "Flag to indicate if the route learned from the primary device is active or passive" + }, + "sec": { + "type": "string", + "description": "Flag to indicate if the route learned from the secondary device is active or passive" + } + } + }, + "CircuitMetadataMap": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Express Route Circuit Name" + }, + "link": { + "type": "string", + "description": "Link to the Express Route circuit" + }, + "location": { + "type": "string", + "description": "Peering location of the Express Route Circuit" + } + } + }, + "GatewayRouteSet": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Route Set name" + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of different locations from where the routes are learned" + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteSourceDetails" + } + }, + "description": "List of different Route Sources" + } + } + }, + "GatewayRouteSetsInformation": { + "type": "object", + "properties": { + "lastComputedTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp denoting the last time when the route sets were computed for the gateway" + }, + "nextEligibleComputeTime": { + "type": "string", + "format": "date-time", + "description": "Timestamp denoting the next eligible time to re-compute the route sets for the gateway" + }, + "routeSetVersion": { + "type": "string", + "description": "Version for the route set" + }, + "routeSets": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRouteSet" + }, + "description": "List of Gateway Route Sets" + }, + "circuitsMetadataMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CircuitMetadataMap" + }, + "description": "Dictionary containing map of the circuit id and circuit details" + } + }, + "description": "Gateway Route Sets Information" + }, + "TunnelConnectionHealth": { + "properties": { + "tunnel": { + "readOnly": true, + "type": "string", + "description": "Tunnel name." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Ingress Bytes Transferred in this connection." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Egress Bytes Transferred in this connection." + }, + "lastConnectionEstablishedUtcTime": { + "readOnly": true, + "type": "string", + "description": "The time at which connection was established in Utc format." + } + }, + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnectionPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/LocalNetworkGateway", + "description": "The reference to local network gateway resource." + }, + "ingressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of ingress NatRules." + }, + "egressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of egress NatRules." + }, + "connectionType": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionType", + "description": "Gateway connection type." + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The dead peer detection timeout of this connection in seconds." + }, + "connectionMode": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionMode", + "description": "The connection mode for this connection." + }, + "tunnelProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionTunnelProperties" + }, + "description": "Tunnel properties for virtual network gateway connection" + }, + "sharedKey": { + "type": "string", + "x-ms-secret": true, + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "gatewayCustomBgpIpAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCustomBgpIpAddressIpConfiguration" + }, + "description": "GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.", + "x-ms-identifiers": [] + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use private local Azure IP for the connection." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway connection resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway connection resource." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding." + }, + "enablePrivateLinkFastPath": { + "type": "boolean", + "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." + }, + "authenticationType": { + "$ref": "#/definitions/ConnectionAuthenticationType", + "description": "Gateway connection authentication type." + }, + "certificateAuthentication": { + "$ref": "#/definitions/CertificateAuthentication", + "description": "Certificate Authentication information for a certificate based authentication connection." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VirtualNetworkGatewayConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "A list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGatewayConnections API service call." + }, + "ConnectionResetSharedKey": { + "properties": { + "keyLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The virtual network connection reset shared key length, should between 1 and 128." + } + }, + "required": [ + "keyLength" + ], + "description": "The virtual network connection reset shared key." + }, + "ConnectionSharedKey": { + "properties": { + "value": { + "type": "string", + "description": "The virtual network connection shared key value." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "value" + ], + "description": "Response for GetConnectionSharedKey API service call." + }, + "IpsecPolicy": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." + }, + "ipsecEncryption": { + "$ref": "#/definitions/IpsecEncryption", + "description": "The IPSec encryption algorithm (IKE phase 1)." + }, + "ipsecIntegrity": { + "$ref": "#/definitions/IpsecIntegrity", + "description": "The IPSec integrity algorithm (IKE phase 1)." + }, + "ikeEncryption": { + "$ref": "#/definitions/IkeEncryption", + "description": "The IKE encryption algorithm (IKE phase 2)." + }, + "ikeIntegrity": { + "$ref": "#/definitions/IkeIntegrity", + "description": "The IKE integrity algorithm (IKE phase 2)." + }, + "dhGroup": { + "$ref": "#/definitions/DhGroup", + "description": "The DH Group used in IKE Phase 1 for initial SA." + }, + "pfsGroup": { + "$ref": "#/definitions/PfsGroup", + "description": "The Pfs Group used in IKE Phase 2 for new child SA." + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec Policy configuration for a virtual network gateway connection." + }, + "VngClientConnectionConfigurationProperties": { + "type": "object", + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "virtualNetworkGatewayPolicyGroups": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of references to virtualNetworkGatewayPolicyGroups" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VngClientConnectionConfiguration resource." + } + }, + "required": [ + "vpnClientAddressPool", + "virtualNetworkGatewayPolicyGroups" + ], + "description": "Properties of VngClientConnectionConfiguration." + }, + "VngClientConnectionConfiguration": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VngClientConnectionConfigurationProperties", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A vpn client connection configuration for client connection configuration." + }, + "VirtualNetworkGatewayPolicyGroupProperties": { + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Priority for VirtualNetworkGatewayPolicyGroup." + }, + "policyMembers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayPolicyGroupMember" + }, + "description": "Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup.", + "x-ms-identifiers": [] + }, + "vngClientConnectionConfigurations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of references to vngClientConnectionConfigurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VirtualNetworkGatewayPolicyGroup resource." + } + }, + "required": [ + "priority", + "policyMembers", + "isDefault" + ], + "description": "Properties of VirtualNetworkGatewayPolicyGroup." + }, + "VirtualNetworkGatewayPolicyGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPolicyGroupProperties", + "description": "Properties of tVirtualNetworkGatewayPolicyGroup." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Parameters for VirtualNetworkGatewayPolicyGroup." + }, + "VirtualNetworkGatewayPolicyGroupMember": { + "properties": { + "name": { + "type": "string", + "description": "Name of the VirtualNetworkGatewayPolicyGroupMember." + }, + "attributeType": { + "type": "string", + "description": "The Vpn Policy member attribute type.", + "enum": [ + "CertificateGroupId", + "AADGroupId", + "RadiusAzureGroupId" + ], + "x-ms-enum": { + "name": "VpnPolicyMemberAttributeType", + "modelAsString": true + } + }, + "attributeValue": { + "type": "string", + "description": "The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember." + } + }, + "description": "Vpn Client Connection configuration PolicyGroup member", + "type": "object" + }, + "TrafficSelectorPolicy": { + "properties": { + "localAddressRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of local address spaces in CIDR format." + }, + "remoteAddressRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of remote address spaces in CIDR format." + } + }, + "required": [ + "localAddressRanges", + "remoteAddressRanges" + ], + "description": "An traffic selector policy for a virtual network gateway connection." + }, + "ConnectionProtocol": { + "type": "string", + "description": "Gateway connection protocol.", + "enum": [ + "IKEv2", + "IKEv1" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionProtocol", + "modelAsString": true + } + }, + "VpnClientIPsecParameters": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client.." + }, + "ipsecEncryption": { + "$ref": "#/definitions/IpsecEncryption", + "description": "The IPSec encryption algorithm (IKE phase 1)." + }, + "ipsecIntegrity": { + "$ref": "#/definitions/IpsecIntegrity", + "description": "The IPSec integrity algorithm (IKE phase 1)." + }, + "ikeEncryption": { + "$ref": "#/definitions/IkeEncryption", + "description": "The IKE encryption algorithm (IKE phase 2)." + }, + "ikeIntegrity": { + "$ref": "#/definitions/IkeIntegrity", + "description": "The IKE integrity algorithm (IKE phase 2)." + }, + "dhGroup": { + "$ref": "#/definitions/DhGroup", + "description": "The DH Group used in IKE Phase 1 for initial SA." + }, + "pfsGroup": { + "$ref": "#/definitions/PfsGroup", + "description": "The Pfs Group used in IKE Phase 2 for new child SA." + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec parameters for a virtual network gateway P2S connection." + }, + "LocalNetworkGatewayPropertiesFormat": { + "properties": { + "localNetworkAddressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "Local network site address space." + }, + "gatewayIpAddress": { + "type": "string", + "description": "IP address of local network gateway." + }, + "fqdn": { + "type": "string", + "description": "FQDN of local network gateway." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the local network gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the local network gateway resource." + } + }, + "description": "LocalNetworkGateway properties." + }, + "LocalNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat", + "description": "Properties of the local network gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "LocalNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "A list of local network gateways that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLocalNetworkGateways API service call." + }, + "VirtualNetworkConnectionGatewayReference": { + "properties": { + "id": { + "type": "string", + "description": "The ID of VirtualNetworkGateway or LocalNetworkGateway resource." + } + }, + "required": [ + "id" + ], + "description": "A reference to VirtualNetworkGateway or LocalNetworkGateway resource." + }, + "VirtualNetworkGatewayConnectionListEntityPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionType", + "description": "Gateway connection type." + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "connectionMode": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionMode", + "description": "The connection mode for this connection." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key. We will no longer return sharedKey in VirtualNetworkGatewayConnection Create/Update/Get/List/UpdateTags APIs response. Please use VirtualNetworkGatewayConnection GetSharedKey API to fetch connection sharedKey." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "gatewayCustomBgpIpAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayCustomBgpIpAddressIpConfiguration" + }, + "description": "GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.", + "x-ms-identifiers": [] + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway connection resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway connection resource." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding." + }, + "enablePrivateLinkFastPath": { + "type": "boolean", + "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnectionListEntity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntityPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VirtualNetworkGatewayListConnectionsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntity" + }, + "description": "A list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the VirtualNetworkGatewayListConnections API service call." + }, + "VpnDeviceScriptParameters": { + "properties": { + "vendor": { + "type": "string", + "description": "The vendor for the vpn device." + }, + "deviceFamily": { + "type": "string", + "description": "The device family for the vpn device." + }, + "firmwareVersion": { + "type": "string", + "description": "The firmware version for the vpn device." + } + }, + "description": "Vpn device configuration script generation parameters." + }, + "DhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "IkeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "IkeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "IpsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "IpsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "PfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionStatus": { + "type": "string", + "description": "Virtual Network Gateway connection status.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionType": { + "type": "string", + "description": "Gateway connection type.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionMode": { + "type": "string", + "description": "Gateway connection type.", + "enum": [ + "Default", + "ResponderOnly", + "InitiatorOnly" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionMode", + "modelAsString": true + } + }, + "VpnClientConnectionHealthDetailListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientConnectionHealthDetail" + }, + "description": "List of vpn client connection health." + } + }, + "description": "List of virtual network gateway vpn client connection health." + }, + "VpnClientConnectionHealthDetail": { + "properties": { + "vpnConnectionId": { + "type": "string", + "readOnly": true, + "description": "The vpn client Id." + }, + "vpnConnectionDuration": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The duration time of a connected vpn client." + }, + "vpnConnectionTime": { + "type": "string", + "readOnly": true, + "description": "The start time of a connected vpn client." + }, + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "The public Ip of a connected vpn client." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The assigned private Ip of a connected vpn client." + }, + "vpnUserName": { + "type": "string", + "readOnly": true, + "description": "The user name of a connected vpn client." + }, + "maxBandwidth": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The max band width." + }, + "egressPacketsTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The egress packets per second." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The egress bytes per second." + }, + "ingressPacketsTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The ingress packets per second." + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The ingress bytes per second." + }, + "maxPacketsPerSecond": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The max packets transferred per second." + } + }, + "description": "VPN client connection health detail." + }, + "VpnPacketCaptureStopParameters": { + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on virtual network gateway." + } + }, + "description": "Stop packet capture parameters." + }, + "VpnPacketCaptureStartParameters": { + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters." + } + }, + "description": "Start packet capture parameters on virtual network gateway." + }, + "ExpressRouteFailoverAllTestDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteFailoverTestDetails" + }, + "description": "Gateway Failover All Test Details" + }, + "ExpressRouteFailoverTestDetails": { + "type": "object", + "properties": { + "peeringLocation": { + "type": "string", + "description": "Peering location of the test" + }, + "circuits": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteFailoverCircuitResourceDetails" + }, + "description": "All circuits in the peering location" + }, + "status": { + "type": "string", + "description": "The current status of the test", + "enum": [ + "NotStarted", + "Starting", + "Running", + "StartFailed", + "Stopping", + "Completed", + "StopFailed", + "Invalid", + "Expired" + ], + "x-ms-enum": { + "name": "FailoverTestStatus", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "description": "Time when the test was started" + }, + "endTime": { + "type": "string", + "description": "Time when the test was completed" + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteFailoverConnectionResourceDetails" + }, + "description": "All connections to the circuits in the peering location" + }, + "testGuid": { + "type": "string", + "description": "The unique GUID associated with the test" + }, + "testType": { + "type": "string", + "description": "The type of failover test", + "enum": [ + "SingleSiteFailover", + "MultiSiteFailover", + "All" + ], + "x-ms-enum": { + "name": "FailoverTestType", + "modelAsString": true + } + }, + "issues": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of all issues with the test" + } + }, + "description": "ExpressRoute failover test details" + }, + "ExpressRouteFailoverCircuitResourceDetails": { + "type": "object", + "properties": { + "nrpResourceUri": { + "type": "string", + "description": "NRP Resource URI of the circuit", + "format": "arm-id" + }, + "name": { + "type": "string", + "description": "Circuit Name" + }, + "connectionName": { + "type": "string", + "description": "Connection name associated with the circuit" + } + } + }, + "ExpressRouteFailoverConnectionResourceDetails": { + "type": "object", + "properties": { + "nrpResourceUri": { + "type": "string", + "description": "NRP Resource URI of the connection", + "format": "arm-id" + }, + "name": { + "type": "string", + "description": "Connection Name" + }, + "status": { + "type": "string", + "description": "The current status of the connection", + "enum": [ + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "FailoverConnectionStatus", + "modelAsString": true + } + }, + "lastUpdatedTime": { + "type": "string", + "description": "Time when the connection was last updated" + } + } + }, + "ExpressRouteFailoverSingleTestDetailsObject": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteFailoverSingleTestDetails" + }, + "description": "Gateway Failover Single Test Details Object" + }, + "ExpressRouteFailoverSingleTestDetails": { + "type": "object", + "properties": { + "peeringLocation": { + "type": "string", + "description": "Peering location of the test" + }, + "status": { + "type": "string", + "description": "The current status of the test", + "enum": [ + "NotStarted", + "Starting", + "Running", + "StartFailed", + "Stopping", + "Completed", + "StopFailed", + "Invalid", + "Expired" + ], + "x-ms-enum": { + "name": "FailoverTestStatusForSingleTest", + "modelAsString": true + } + }, + "startTimeUtc": { + "type": "string", + "description": "Time when the test was started" + }, + "endTimeUtc": { + "type": "string", + "description": "Time when the test was completed" + }, + "redundantRoutes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteFailoverRedundantRoute" + }, + "description": "List of routes received from this peering as well as some other peering location" + }, + "nonRedundantRoutes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of al the routes that were received only from this peering location" + }, + "wasSimulationSuccessful": { + "type": "boolean", + "description": "Whether the failover simulation was successful or not" + }, + "failoverConnectionDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/FailoverConnectionDetails" + }, + "description": "List of all the failover connections for this peering location" + } + }, + "description": "ExpressRoute failover single test details" + }, + "ExpressRouteFailoverRedundantRoute": { + "type": "object", + "properties": { + "peeringLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of all the peering locations for the redundant routes" + }, + "routes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of all the redundant routes in the peering locations" + } + } + }, + "FailoverConnectionDetails": { + "type": "object", + "properties": { + "failoverConnectionName": { + "type": "string", + "description": "Name of the failover connection" + }, + "failoverLocation": { + "type": "string", + "description": "Location of the failover connection" + }, + "isVerified": { + "type": "boolean", + "description": "Whether the customer was able to establish connectivity through this failover connection or not" + } + } + }, + "ExpressRouteFailoverStopApiParameters": { + "type": "object", + "properties": { + "peeringLocation": { + "type": "string", + "description": "Peering location of the test" + }, + "wasSimulationSuccessful": { + "type": "boolean", + "description": "Whether the failover simulation was successful or not" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/FailoverConnectionDetails" + }, + "description": "List of all the failover connections for this peering location" + } + }, + "description": "Start packet capture parameters on virtual network gateway." + }, + "IPConfigurationBgpPeeringAddress": { + "properties": { + "ipconfigurationId": { + "type": "string", + "description": "The ID of IP configuration which belongs to gateway." + }, + "defaultBgpIpAddresses": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of default BGP peering addresses which belong to IP configuration." + }, + "customBgpIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of custom BGP peering addresses which belong to IP configuration." + }, + "tunnelIpAddresses": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of tunnel public IP addresses which belong to IP configuration." + } + }, + "description": "Properties of IPConfigurationBgpPeeringAddress." + }, + "GatewayCustomBgpIpAddressIpConfiguration": { + "type": "object", + "properties": { + "ipConfigurationId": { + "type": "string", + "description": "The IpconfigurationId of ipconfiguration which belongs to gateway." + }, + "customBgpIpAddress": { + "type": "string", + "description": "The custom BgpPeeringAddress which belongs to IpconfigurationId." + } + }, + "required": [ + "ipConfigurationId", + "customBgpIpAddress" + ], + "description": "GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection." + }, + "VirtualNetworkGatewayConnectionTunnelProperties": { + "type": "object", + "properties": { + "tunnelIpAddress": { + "type": "string", + "description": "Tunnel remote IP address" + }, + "bgpPeeringAddress": { + "type": "string", + "description": "Tunnel BGP peering address" + } + } + }, + "ConnectionAuthenticationType": { + "type": "string", + "description": "Gateway connection authentication type.", + "enum": [ + "PSK", + "Certificate" + ], + "x-ms-enum": { + "name": "ConnectionAuthenticationType", + "modelAsString": true, + "values": [ + { + "value": "PSK", + "description": "Pre-shared key authentication method for VPN gateway connections." + }, + { + "value": "Certificate", + "description": "Certificate-based authentication method for VPN gateway connections." + } + ] + } + }, + "CertificateAuthentication": { + "type": "object", + "properties": { + "outboundAuthCertificate": { + "type": "string", + "format": "uri", + "description": "Keyvault secret ID for outbound authentication certificate." + }, + "inboundAuthCertificateSubjectName": { + "type": "string", + "description": "Inbound authentication certificate subject name." + }, + "inboundAuthCertificateChain": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Inbound authentication certificate public keys." + } + }, + "description": "Certificate Authentication information for a certificate based authentication connection." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetworkTap.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetworkTap.json new file mode 100644 index 000000000000..37172a5492c3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualNetworkTap.json @@ -0,0 +1,426 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/virtualNetworkTaps/{tapName}": { + "delete": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Delete", + "description": "Deletes the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Virtual Network Tap resource": { + "$ref": "./examples/VirtualNetworkTapDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Get", + "description": "Gets information about the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Tap": { + "$ref": "./examples/VirtualNetworkTapGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_CreateOrUpdate", + "description": "Creates or updates a Virtual Network Tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "Parameters supplied to the create or update virtual network tap operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Virtual Network Tap": { + "$ref": "./examples/VirtualNetworkTapCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_UpdateTags", + "description": "Updates an VirtualNetworkTap tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap." + }, + { + "name": "tapParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualNetworkTap tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tap tags": { + "$ref": "./examples/VirtualNetworkTapUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListAll", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual network taps": { + "$ref": "./examples/VirtualNetworkTapListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListByResourceGroup", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual network taps in resource group": { + "$ref": "./examples/VirtualNetworkTapList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualNetworkTap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkTapPropertiesFormat", + "description": "Virtual Network Tap Properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network Tap resource." + }, + "VirtualNetworkTapPropertiesFormat": { + "description": "Virtual Network Tap properties.", + "properties": { + "networkInterfaceTapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceTapConfiguration", + "description": "The reference to the Network Interface." + }, + "description": "Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the virtual network tap resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network tap resource." + }, + "destinationNetworkInterfaceIPConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "The reference to the private IP Address of the collector nic that will receive the tap." + }, + "destinationLoadBalancerFrontEndIPConfiguration": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration", + "description": "The reference to the private IP address on the internal Load Balancer that will receive the tap." + }, + "destinationPort": { + "type": "integer", + "description": "The VXLAN destination port that will receive the tapped traffic." + } + } + }, + "VirtualNetworkTapListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "A list of VirtualNetworkTaps in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListVirtualNetworkTap API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualRouter.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualRouter.json new file mode 100644 index 000000000000..d5bcb8179823 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualRouter.json @@ -0,0 +1,698 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2025-03-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.Network/virtualRouters/{virtualRouterName}": { + "delete": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_Delete", + "description": "Deletes the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete VirtualRouter": { + "$ref": "./examples/VirtualRouterDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_Get", + "description": "Gets the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get VirtualRouter": { + "$ref": "./examples/VirtualRouterGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_CreateOrUpdate", + "description": "Creates or updates the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualRouter" + }, + "description": "Parameters supplied to the create or update Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create VirtualRouter": { + "$ref": "./examples/VirtualRouterPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters": { + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_ListByResourceGroup", + "description": "Lists all Virtual Routers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Router for a given resource group": { + "$ref": "./examples/VirtualRouterListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualRouters": { + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_List", + "description": "Gets all the Virtual Routers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Routers for a given subscription": { + "$ref": "./examples/VirtualRouterListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_Delete", + "description": "Deletes the specified peering from a Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete VirtualRouterPeering": { + "$ref": "./examples/VirtualRouterPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_Get", + "description": "Gets the specified Virtual Router Peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router Peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get Virtual Router Peering": { + "$ref": "./examples/VirtualRouterPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_CreateOrUpdate", + "description": "Creates or updates the specified Virtual Router Peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router Peering." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + }, + "description": "Parameters supplied to the create or update Virtual Router Peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create Virtual Router Peering": { + "$ref": "./examples/VirtualRouterPeeringPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings": { + "get": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_List", + "description": "Lists all Virtual Router Peerings in a Virtual Router resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router Peering resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Router Peerings for a given Virtual Router": { + "$ref": "./examples/VirtualRouterPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualRouter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualRouterPropertiesFormat", + "description": "Properties of the Virtual Router." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualRouter Resource." + }, + "VirtualRouterPropertiesFormat": { + "properties": { + "virtualRouterAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualRouter ASN." + }, + "virtualRouterIps": { + "type": "array", + "readOnly": false, + "description": "VirtualRouter IPs.", + "items": { + "type": "string" + } + }, + "hostedSubnet": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Subnet on which VirtualRouter is hosted." + }, + "hostedGateway": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Gateway on which VirtualRouter is hosted." + }, + "peerings": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualRouterPeerings.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Virtual Router definition." + }, + "VirtualRouterPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualRouterPeeringProperties", + "description": "The properties of the Virtual Router Peering." + }, + "name": { + "type": "string", + "description": "Name of the virtual router peering that is unique within a virtual router." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Peering type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Router Peering resource." + }, + "VirtualRouterPeeringProperties": { + "properties": { + "peerAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Peer ASN." + }, + "peerIp": { + "type": "string", + "readOnly": false, + "description": "Peer IP." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the rule group." + }, + "VirtualRouterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualRouter" + }, + "description": "List of Virtual Routers." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListVirtualRouters API service call." + }, + "VirtualRouterPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualRouterPeering" + }, + "description": "List of VirtualRouterPeerings in a VirtualRouter." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListVirtualRouterPeerings API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualWan.json new file mode 100644 index 000000000000..455922b7cd72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/virtualWan.json @@ -0,0 +1,10104 @@ +{ + "swagger": "2.0", + "info": { + "title": "VirtualWANAsAServiceManagementClient", + "description": "REST API for Azure VirtualWAN As a Service.", + "version": "2025-03-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.Network/virtualWans/{VirtualWANName}": { + "get": { + "operationId": "VirtualWans_Get", + "x-ms-examples": { + "VirtualWANGet": { + "$ref": "./examples/VirtualWANGet.json" + } + }, + "description": "Retrieves the details of a VirtualWAN.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN retrieved.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualWans_CreateOrUpdate", + "x-ms-examples": { + "VirtualWANCreate": { + "$ref": "./examples/VirtualWANPut.json" + } + }, + "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "Parameters supplied to create or update VirtualWAN." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN created or updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualWAN resource.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualWans_UpdateTags", + "x-ms-examples": { + "VirtualWANUpdate": { + "$ref": "./examples/VirtualWANUpdateTags.json" + } + }, + "description": "Updates a VirtualWAN tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update VirtualWAN tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VirtualWans_Delete", + "x-ms-examples": { + "VirtualWANDelete": { + "$ref": "./examples/VirtualWANDelete.json" + } + }, + "description": "Deletes a VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualWAN deleted." + }, + "202": { + "description": "Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualWANs exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_ListByResourceGroup", + "x-ms-examples": { + "VirtualWANListByResourceGroup": { + "$ref": "./examples/VirtualWANListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualWANs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_List", + "x-ms-examples": { + "VirtualWANList": { + "$ref": "./examples/VirtualWANList.json" + } + }, + "description": "Lists all the VirtualWANs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { + "get": { + "operationId": "VpnSites_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteGet.json" + } + }, + "description": "Retrieves the details of a VPN site.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite retrieved.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnSites_CreateOrUpdate", + "x-ms-examples": { + "VpnSiteCreate": { + "$ref": "./examples/VpnSitePut.json" + } + }, + "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnSite" + }, + "description": "Parameters supplied to create or update VpnSite." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnSites" + ], + "operationId": "VpnSites_UpdateTags", + "x-ms-examples": { + "VpnSiteUpdate": { + "$ref": "./examples/VpnSiteUpdateTags.json" + } + }, + "description": "Updates VpnSite tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnSite tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnSites_Delete", + "x-ms-examples": { + "VpnSiteDelete": { + "$ref": "./examples/VpnSiteDelete.json" + } + }, + "description": "Deletes a VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnSite deleted." + }, + "202": { + "description": "Request received successfully. VpnSite deletion is in progress." + }, + "204": { + "description": "No VpnSites exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_ListByResourceGroup", + "x-ms-examples": { + "VpnSiteListByResourceGroup": { + "$ref": "./examples/VpnSiteListByResourceGroup.json" + } + }, + "description": "Lists all the vpnSites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}": { + "get": { + "operationId": "VpnSiteLinks_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteLinkGet.json" + } + }, + "description": "Retrieves the details of a VPN site link.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite." + }, + { + "name": "vpnSiteLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSiteLink being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSiteLink retrieved.", + "schema": { + "$ref": "#/definitions/VpnSiteLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks": { + "get": { + "operationId": "VpnSiteLinks_ListByVpnSite", + "x-ms-examples": { + "VpnSiteLinkListByVpnSite": { + "$ref": "./examples/VpnSiteLinkListByVpnSite.json" + } + }, + "description": "Lists all the vpnSiteLinks in a resource group for a vpn site.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSiteLinksResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_List", + "x-ms-examples": { + "VpnSiteList": { + "$ref": "./examples/VpnSiteList.json" + } + }, + "description": "Lists all the VpnSites in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnSites in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { + "post": { + "operationId": "VpnSitesConfiguration_Download", + "x-ms-examples": { + "VpnSitesConfigurationDownload": { + "$ref": "./examples/VpnSitesConfigurationDownload.json" + } + }, + "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetVpnSitesConfigurationRequest" + }, + "description": "Parameters supplied to download vpn-sites configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders": { + "get": { + "operationId": "SupportedSecurityProviders", + "x-ms-examples": { + "supportedSecurityProviders": { + "$ref": "./examples/VirtualWanSupportedSecurityProviders.json" + } + }, + "description": "Gives the supported security providers for the virtual wan.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which supported security providers are needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the object containing supported security providers.", + "schema": { + "$ref": "#/definitions/VirtualWanSecurityProviders" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}": { + "get": { + "operationId": "VpnServerConfigurations_Get", + "x-ms-examples": { + "VpnServerConfigurationGet": { + "$ref": "./examples/VpnServerConfigurationGet.json" + } + }, + "description": "Retrieves the details of a VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnServerConfigurations_CreateOrUpdate", + "x-ms-examples": { + "VpnServerConfigurationCreate": { + "$ref": "./examples/VpnServerConfigurationPut.json" + } + }, + "description": "Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + }, + "description": "Parameters supplied to create or update VpnServerConfiguration." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnServerConfigurations" + ], + "operationId": "VpnServerConfigurations_UpdateTags", + "x-ms-examples": { + "VpnServerConfigurationUpdate": { + "$ref": "./examples/VpnServerConfigurationUpdateTags.json" + } + }, + "description": "Updates VpnServerConfiguration tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnServerConfiguration tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnServerConfigurations_Delete", + "x-ms-examples": { + "VpnServerConfigurationDelete": { + "$ref": "./examples/VpnServerConfigurationDelete.json" + } + }, + "description": "Deletes a VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnServerConfiguration deleted." + }, + "202": { + "description": "Request received successfully. VpnServerConfiguration deletion is in progress." + }, + "204": { + "description": "No VpnServerConfigurations exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations": { + "get": { + "operationId": "VpnServerConfigurations_ListByResourceGroup", + "x-ms-examples": { + "VpnServerConfigurationListByResourceGroup": { + "$ref": "./examples/VpnServerConfigurationListByResourceGroup.json" + } + }, + "description": "Lists all the vpnServerConfigurations in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnServerConfigurations in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups/{configurationPolicyGroupName}": { + "put": { + "operationId": "ConfigurationPolicyGroups_CreateOrUpdate", + "x-ms-examples": { + "ConfigurationPolicyGroupPut": { + "$ref": "./examples/ConfigurationPolicyGroupPut.json" + } + }, + "description": "Creates a ConfigurationPolicyGroup if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the ConfigurationPolicyGroup." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "name": "configurationPolicyGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ConfigurationPolicyGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationPolicyGroupParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + }, + "description": "Parameters supplied to create or update a VpnServerConfiguration PolicyGroup." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration PolicyGroup created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "201": { + "description": "Request successful. Returns the details of the VpnServerConfiguration PolicyGroup retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "ConfigurationPolicyGroups_Delete", + "x-ms-examples": { + "ConfigurationPolicyGroupDelete": { + "$ref": "./examples/ConfigurationPolicyGroupDelete.json" + } + }, + "description": "Deletes a ConfigurationPolicyGroup.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the ConfigurationPolicyGroup." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "name": "configurationPolicyGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ConfigurationPolicyGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. ConfigurationPolicyGroup deleted." + }, + "202": { + "description": "Request received successfully. ConfigurationPolicyGroup deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No ConfigurationPolicyGroup exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "operationId": "ConfigurationPolicyGroups_Get", + "x-ms-examples": { + "ConfigurationPolicyGroupGet": { + "$ref": "./examples/ConfigurationPolicyGroupGet.json" + } + }, + "description": "Retrieves the details of a ConfigurationPolicyGroup.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "name": "configurationPolicyGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ConfigurationPolicyGroup being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the ConfigurationPolicyGroup retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/configurationPolicyGroups": { + "get": { + "operationId": "configurationPolicyGroups_ListByVpnServerConfiguration", + "x-ms-examples": { + "ConfigurationPolicyGroupListByVpnServerConfiguration": { + "$ref": "./examples/ConfigurationPolicyGroupListByVpnServerConfiguration.json" + } + }, + "description": "Lists all the configurationPolicyGroups in a resource group for a vpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnServerConfigurations in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationPolicyGroupsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations": { + "get": { + "operationId": "VpnServerConfigurations_List", + "x-ms-examples": { + "VpnServerConfigurationList": { + "$ref": "./examples/VpnServerConfigurationList.json" + } + }, + "description": "Lists all the VpnServerConfigurations in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnServerConfigurations in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}/listRadiusSecrets": { + "post": { + "tags": [ + "VpnServerConfigurations" + ], + "operationId": "VpnServerConfigurations_ListRadiusSecrets", + "description": "List all Radius servers with respective radius secrets from VpnServerConfiguration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the VpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List all Radius servers with respective radius secrets from VpnServerConfiguration.", + "schema": { + "$ref": "./virtualNetworkGateway.json#/definitions/RadiusAuthServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListAllVpnServerConfigurationRadiusServerSecrets": { + "$ref": "./examples/AllVpnServerConfigurationRadiusServerSecretsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { + "get": { + "operationId": "VirtualHubs_Get", + "x-ms-examples": { + "VirtualHubGet": { + "$ref": "./examples/VirtualHubGet.json" + } + }, + "description": "Retrieves the details of a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubs_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubPut": { + "$ref": "./examples/VirtualHubPut.json" + } + }, + "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "Parameters supplied to create or update VirtualHub." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualHubs_UpdateTags", + "x-ms-examples": { + "VirtualHubUpdate": { + "$ref": "./examples/VirtualHubUpdateTags.json" + } + }, + "description": "Updates VirtualHub tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualHub tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VirtualHubs_Delete", + "x-ms-examples": { + "VirtualHubDelete": { + "$ref": "./examples/VirtualHubDelete.json" + } + }, + "description": "Deletes a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHub deleted." + }, + "202": { + "description": "Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubs exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_ListByResourceGroup", + "x-ms-examples": { + "VirtualHubListByResourceGroup": { + "$ref": "./examples/VirtualHubListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualHubs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_List", + "x-ms-examples": { + "VirtualHubList": { + "$ref": "./examples/VirtualHubList.json" + } + }, + "description": "Lists all the VirtualHubs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps/{routeMapName}": { + "get": { + "operationId": "RouteMaps_Get", + "x-ms-examples": { + "RouteMapGet": { + "$ref": "./examples/RouteMapGet.json" + } + }, + "description": "Retrieves the details of a RouteMap.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "name": "routeMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteMap retrieved.", + "schema": { + "$ref": "#/definitions/RouteMap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "RouteMaps_CreateOrUpdate", + "x-ms-examples": { + "RouteMapPut": { + "$ref": "./examples/RouteMapPut.json" + } + }, + "description": "Creates a RouteMap if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "name": "routeMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routeMapParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteMap" + }, + "description": "Parameters supplied to create or update a RouteMap." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteMap created or updated.", + "schema": { + "$ref": "#/definitions/RouteMap" + } + }, + "201": { + "description": "Request successful. Returns the details of the RouteMap retrieved.", + "schema": { + "$ref": "#/definitions/RouteMap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "RouteMaps_Delete", + "x-ms-examples": { + "RouteMapDelete": { + "$ref": "./examples/RouteMapDelete.json" + } + }, + "description": "Deletes a RouteMap.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "name": "routeMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RouteMap deleted." + }, + "202": { + "description": "Request received successfully. RouteMap deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RouteMaps exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeMaps": { + "get": { + "operationId": "RouteMaps_List", + "x-ms-examples": { + "RouteMapList": { + "$ref": "./examples/RouteMapList.json" + } + }, + "description": "Retrieves the details of all RouteMaps.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteMap's resource group'." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub containing the RouteMap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RouteMaps for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListRouteMapsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { + "put": { + "operationId": "HubVirtualNetworkConnections_CreateOrUpdate", + "x-ms-examples": { + "HubVirtualNetworkConnectionPut": { + "$ref": "./examples/HubVirtualNetworkConnectionPut.json" + } + }, + "description": "Creates a hub virtual network connection if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the HubVirtualNetworkConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HubVirtualNetworkConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "hubVirtualNetworkConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "Parameters supplied to create or update a hub virtual network connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the hub virtual network connection created or updated.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the hub virtual network connection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "HubVirtualNetworkConnections_Delete", + "x-ms-examples": { + "HubVirtualNetworkConnectionDelete": { + "$ref": "./examples/HubVirtualNetworkConnectionDelete.json" + } + }, + "description": "Deletes a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HubVirtualNetworkConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. HubVirtualNetworkConnection deleted." + }, + "202": { + "description": "Request received successfully. HubVirtualNetworkConnection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No HubVirtualNetworkConnection exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "operationId": "HubVirtualNetworkConnections_Get", + "x-ms-examples": { + "HubVirtualNetworkConnectionGet": { + "$ref": "./examples/HubVirtualNetworkConnectionGet.json" + } + }, + "description": "Retrieves the details of a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { + "get": { + "operationId": "HubVirtualNetworkConnections_List", + "x-ms-examples": { + "HubVirtualNetworkConnectionList": { + "$ref": "./examples/HubVirtualNetworkConnectionList.json" + } + }, + "description": "Retrieves the details of all HubVirtualNetworkConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { + "get": { + "operationId": "VpnGateways_Get", + "x-ms-examples": { + "VpnGatewayGet": { + "$ref": "./examples/VpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnGateways_CreateOrUpdate", + "x-ms-examples": { + "VpnGatewayPut": { + "$ref": "./examples/VpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_UpdateTags", + "x-ms-examples": { + "VpnGatewayUpdate": { + "$ref": "./examples/VpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan vpn gateway tags." + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VpnGateways_Delete", + "x-ms-examples": { + "VpnGatewayDelete": { + "$ref": "./examples/VpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Gateway deleted." + }, + "202": { + "description": "Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn gateways exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_Reset", + "description": "Resets the primary of the vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "ipConfigurationId", + "in": "query", + "required": false, + "type": "string", + "description": "VpnGateway ipConfigurationId to specify the gateway instance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the primary of the VpnGateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVpnGateway": { + "$ref": "./examples/VpnGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/startpacketcapture": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_StartPacketCapture", + "description": "Starts packet capture on vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnGatewayPacketCaptureStartParameters" + }, + "description": "Vpn gateway packet capture parameters supplied to start packet capture on vpn gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation packet capture started on vpn gateway.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Start packet capture on vpn gateway without filter": { + "$ref": "./examples/VpnGatewayStartPacketCapture.json" + }, + "Start packet capture on vpn gateway with filter": { + "$ref": "./examples/VpnGatewayStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/stoppacketcapture": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_StopPacketCapture", + "description": "Stops packet capture on vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnGatewayPacketCaptureStopParameters" + }, + "description": "Vpn gateway packet capture parameters supplied to stop packet capture on vpn gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation packet capture stopped on vpn gateway.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Stop packet capture on vpn gateway": { + "$ref": "./examples/VpnGatewayStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/resetconnection": { + "post": { + "tags": [ + "vpnLinkConnections" + ], + "operationId": "VpnLinkConnections_ResetConnection", + "description": "Resets the VpnLink connection specified.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation ResetConnection will complete asynchronously." + }, + "default": { + "description": "The operation ResetConnection could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResetVpnLinkConnection": { + "$ref": "./examples/VpnSiteLinkConnectionReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys": { + "get": { + "operationId": "VpnLinkConnections_GetAllSharedKeys", + "description": "Lists all shared keys of VpnLink connection specified.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the shared key of the vpn link connection.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKeyResultList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VpnSiteLinkConnectionSharedKeysGet": { + "$ref": "./examples/VpnSiteLinkConnectionSharedKeysGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys/default": { + "get": { + "operationId": "VpnLinkConnections_GetDefaultSharedKey", + "description": "Gets the shared key of VpnLink connection specified.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the shared key of the vpn link connection.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKeyResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VpnSiteLinkConnectionDefaultSharedKeyGet": { + "$ref": "./examples/VpnSiteLinkConnectionDefaultSharedKeyGet.json" + } + } + }, + "put": { + "operationId": "VpnLinkConnections_SetOrInitDefaultSharedKey", + "x-ms-examples": { + "VpnSiteLinkConnectionDefaultSharedKeyPut": { + "$ref": "./examples/VpnSiteLinkConnectionDefaultSharedKeyPut.json" + } + }, + "description": "Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "ConnectionSharedKeyParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSharedKeyResult" + }, + "description": "Parameters supplied to set or auto generate the shared key for the vpn link connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the length of the shared key for the vpn link connection.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKeyResult" + } + }, + "201": { + "description": "Request successful. Returns the length of the shared key for the vpn link connection.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKeyResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/sharedKeys/default/listSharedKey": { + "post": { + "operationId": "VpnLinkConnections_ListDefaultSharedKey", + "description": "Gets the value of the shared key of VpnLink connection specified.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the shared key of the vpn link connection.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKeyResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VpnSiteLinkConnectionDefaultSharedKeyList": { + "$ref": "./examples/VpnSiteLinkConnectionDefaultSharedKeyList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_ListByResourceGroup", + "x-ms-examples": { + "VpnGatewayListByResourceGroup": { + "$ref": "./examples/VpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the VpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_List", + "x-ms-examples": { + "VpnGatewayListBySubscription": { + "$ref": "./examples/VpnGatewayList.json" + } + }, + "description": "Lists all the VpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { + "get": { + "operationId": "VpnConnections_Get", + "x-ms-examples": { + "VpnConnectionGet": { + "$ref": "./examples/VpnConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnConnections_CreateOrUpdate", + "x-ms-examples": { + "VpnConnectionPut": { + "$ref": "./examples/VpnConnectionPut.json" + } + }, + "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "Parameters supplied to create or Update a VPN Connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VpnConnections_Delete", + "x-ms-examples": { + "VpnConnectionDelete": { + "$ref": "./examples/VpnConnectionDelete.json" + } + }, + "description": "Deletes a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Connection deleted." + }, + "202": { + "description": "Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn connections exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}": { + "get": { + "operationId": "VpnSiteLinkConnections_Get", + "x-ms-examples": { + "VpnSiteLinkConnectionGet": { + "$ref": "./examples/VpnSiteLinkConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn site link connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnSiteLinkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}/getikesas": { + "post": { + "operationId": "VpnLinkConnections_GetIkeSas", + "x-ms-examples": { + "GetVpnLinkConnectionIkeSa": { + "$ref": "./examples/VpnSiteLinkConnectionGetIkeSas.json" + } + }, + "description": "Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn link connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation GetIkeSas will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation getikesas completed on vpn site link connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "The operation GetIkeSas could not be completed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/startpacketcapture": { + "post": { + "operationId": "VpnConnections_StartPacketCapture", + "description": "Starts packet capture on Vpn connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "vpnConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnConnectionPacketCaptureStartParameters" + }, + "description": "Vpn Connection packet capture parameters supplied to start packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on vpn connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Start packet capture on vpn connection without filter": { + "$ref": "./examples/VpnConnectionStartPacketCapture.json" + }, + "Start packet capture on vpn connection with filter": { + "$ref": "./examples/VpnConnectionStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{vpnConnectionName}/stoppacketcapture": { + "post": { + "operationId": "VpnConnections_StopPacketCapture", + "description": "Stops packet capture on Vpn connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "vpnConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnConnectionPacketCaptureStopParameters" + }, + "description": "Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on vpn connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Start packet capture on vpn connection without filter": { + "$ref": "./examples/VpnConnectionStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { + "get": { + "operationId": "VpnConnections_ListByVpnGateway", + "x-ms-examples": { + "VpnConnectionList": { + "$ref": "./examples/VpnConnectionList.json" + } + }, + "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections": { + "get": { + "operationId": "VpnLinkConnections_ListByVpnConnection", + "x-ms-examples": { + "VpnSiteLinkConnectionList": { + "$ref": "./examples/VpnSiteLinkConnectionList.json" + } + }, + "description": "Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the vpn gateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnSiteLinkConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules/{natRuleName}": { + "get": { + "operationId": "NatRules_Get", + "x-ms-examples": { + "NatRuleGet": { + "$ref": "./examples/NatRuleGet.json" + } + }, + "description": "Retrieves the details of a nat ruleGet.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule.", + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "NatRules_CreateOrUpdate", + "x-ms-examples": { + "NatRulePut": { + "$ref": "./examples/NatRulePut.json" + } + }, + "description": "Creates a nat rule to a scalable vpn gateway if it doesn't exist else updates the existing nat rules.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "NatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + }, + "description": "Parameters supplied to create or Update a Nat Rule." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + }, + "201": { + "description": "Request successful. Returns the details of the nat rule created or updated.", + "schema": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "NatRules_Delete", + "x-ms-examples": { + "NatRuleDelete": { + "$ref": "./examples/NatRuleDelete.json" + } + }, + "description": "Deletes a nat rule.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "natRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Nat Rule deleted." + }, + "202": { + "description": "Request received successfully. Nat Rule deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No nat rules exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/natRules": { + "get": { + "operationId": "NatRules_ListByVpnGateway", + "x-ms-examples": { + "NatRuleList": { + "$ref": "./examples/NatRuleList.json" + } + }, + "description": "Retrieves all nat rules for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Nat rules for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnGatewayNatRulesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": { + "get": { + "operationId": "P2sVpnGateways_Get", + "x-ms-examples": { + "P2SVpnGatewayGet": { + "$ref": "./examples/P2SVpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "P2sVpnGateways_CreateOrUpdate", + "x-ms-examples": { + "P2SVpnGatewayPut": { + "$ref": "./examples/P2SVpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_UpdateTags", + "x-ms-examples": { + "P2SVpnGatewayUpdate": { + "$ref": "./examples/P2SVpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan p2s vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan p2s vpn gateway tags." + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "P2sVpnGateways_Delete", + "x-ms-examples": { + "P2SVpnGatewayDelete": { + "$ref": "./examples/P2SVpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. P2SVpnGateway deleted." + }, + "202": { + "description": "Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No p2s vpn gateways exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_ListByResourceGroup", + "x-ms-examples": { + "P2SVpnGatewayListByResourceGroup": { + "$ref": "./examples/P2SVpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the P2SVpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_List", + "x-ms-examples": { + "P2SVpnGatewayListBySubscription": { + "$ref": "./examples/P2SVpnGatewayList.json" + } + }, + "description": "Lists all the P2SVpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/reset": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2SVpnGateways_Reset", + "description": "Resets the primary of the p2s vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the primary of the P2SVpnGateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetP2SVpnGateway": { + "$ref": "./examples/P2SVpnGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnProfileParameters" + }, + "description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateP2SVpnGatewayVPNProfile": { + "$ref": "./examples/P2SVpnGatewayGenerateVpnProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealth", + "description": "Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "P2S Vpn Gateway with P2S connection health details.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "P2SVpnGatewayGetConnectionHealth": { + "$ref": "./examples/P2SVpnGatewayGetConnectionHealth.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealthDetailed": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealthDetailed", + "description": "Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnConnectionHealthRequest" + }, + "description": "Request parameters supplied to get p2s vpn connections detailed health." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "P2S connections detailed health report.", + "schema": { + "$ref": "#/definitions/P2SVpnConnectionHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "P2SVpnGatewayGetConnectionHealthDetailed": { + "$ref": "./examples/P2SVpnGatewayGetConnectionHealthDetailed.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations": { + "post": { + "operationId": "VpnServerConfigurationsAssociatedWithVirtualWan_List", + "x-ms-examples": { + "GetVirtualWanVpnServerConfigurations": { + "$ref": "./examples/GetVirtualWanVpnServerConfigurations.json" + } + }, + "description": "Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN whose associated VpnServerConfigurations is needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of associated VpnServerConfigurations list.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationsResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for list of associated VpnServerConfigurations list." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/GenerateVpnProfile": { + "post": { + "operationId": "generatevirtualwanvpnserverconfigurationvpnprofile", + "x-ms-examples": { + "GenerateVirtualWanVpnServerConfigurationVpnProfile": { + "$ref": "./examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json" + } + }, + "description": "Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN whose associated VpnServerConfigurations is needed." + }, + { + "name": "vpnClientParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWanVpnProfileParameters" + }, + "description": "Parameters supplied to the generate VirtualWan VPN profile generation operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}": { + "get": { + "operationId": "VirtualHubRouteTableV2s_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubRouteTableV2Get.json" + } + }, + "description": "Retrieves the details of a VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubRouteTableV2." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHubRouteTableV2 retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualHubRouteTableV2s_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubRouteTableV2Put": { + "$ref": "./examples/VirtualHubRouteTableV2Put.json" + } + }, + "description": "Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubRouteTableV2Parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + }, + "description": "Parameters supplied to create or update VirtualHubRouteTableV2." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHubRouteTableV2 created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHubRouteTableV2 created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubRouteTableV2s_Delete", + "x-ms-examples": { + "VirtualHubRouteTableV2Delete": { + "$ref": "./examples/VirtualHubRouteTableV2Delete.json" + } + }, + "description": "Deletes a VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubRouteTableV2." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubRouteTableV2 deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubRouteTableV2 deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubRouteTableV2s exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables": { + "get": { + "operationId": "VirtualHubRouteTableV2s_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubRouteTableV2List.json" + } + }, + "description": "Retrieves the details of all VirtualHubRouteTableV2s.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubRouteTableV2s for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubRouteTableV2sResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_DisconnectP2sVpnConnections", + "description": "Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "p2sVpnGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2S Vpn Gateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnConnectionRequest" + }, + "description": "The parameters are supplied to disconnect p2s vpn connections." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation disconnects the requested vpn connections." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disconnect VpnConnections from P2sVpn Gateway": { + "$ref": "./examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListBySubscription", + "x-ms-examples": { + "ExpressRouteGatewayListBySubscription": { + "$ref": "./examples/ExpressRouteGatewayListBySubscription.json" + } + }, + "description": "Lists ExpressRoute gateways under a given subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListByResourceGroup", + "x-ms-examples": { + "ExpressRouteGatewayListByResourceGroup": { + "$ref": "./examples/ExpressRouteGatewayListByResourceGroup.json" + } + }, + "description": "Lists ExpressRoute gateways in a given resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}": { + "put": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteGatewayCreate": { + "$ref": "./examples/ExpressRouteGatewayCreate.json" + } + }, + "description": "Creates or updates a ExpressRoute gateway in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "putExpressRouteGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "Parameters required in an ExpressRoute gateway PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_UpdateTags", + "x-ms-examples": { + "ExpressRouteGatewayUpdate": { + "$ref": "./examples/ExpressRouteGatewayUpdateTags.json" + } + }, + "description": "Updates express route gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the ExpressRouteGateway." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "expressRouteGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan express route gateway tags." + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Get", + "x-ms-examples": { + "ExpressRouteGatewayGet": { + "$ref": "./examples/ExpressRouteGatewayGet.json" + } + }, + "description": "Fetches the details of a ExpressRoute gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation succeeded. The operation returns the ExpressRoute gateway.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Delete", + "x-ms-examples": { + "ExpressRouteGatewayDelete": { + "$ref": "./examples/ExpressRouteGatewayDelete.json" + } + }, + "description": "Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}": { + "put": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteConnectionCreate": { + "$ref": "./examples/ExpressRouteConnectionCreate.json" + } + }, + "description": "Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "name": "putExpressRouteConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "Parameters required in an ExpressRouteConnection PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Get", + "x-ms-examples": { + "ExpressRouteConnectionGet": { + "$ref": "./examples/ExpressRouteConnectionGet.json" + } + }, + "description": "Gets the specified ExpressRouteConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Delete", + "x-ms-examples": { + "ExpressRouteConnectionDelete": { + "$ref": "./examples/ExpressRouteConnectionDelete.json" + } + }, + "description": "Deletes a connection to a ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted, and the operation will continue asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections": { + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_List", + "x-ms-examples": { + "ExpressRouteConnectionList": { + "$ref": "./examples/ExpressRouteConnectionList.json" + } + }, + "description": "Lists ExpressRouteConnections.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections/{connectionName}": { + "put": { + "operationId": "NetworkVirtualApplianceConnections_CreateOrUpdate", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionPut": { + "$ref": "./examples/NetworkVirtualApplianceConnectionPut.json" + } + }, + "description": "Creates a connection to Network Virtual Appliance, if it doesn't exist else updates the existing NVA connection'", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the NVA connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "NetworkVirtualApplianceConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + }, + "description": "Parameters supplied in an NetworkVirtualApplianceConnection PUT operation." + } + ], + "responses": { + "200": { + "description": "Update successful. Returns the details of the NVA connection created or updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + } + }, + "201": { + "description": "Create successful. Returns the details of the NVA connection created or updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "NetworkVirtualApplianceConnections_Get", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionGet": { + "$ref": "./examples/NetworkVirtualApplianceConnectionGet.json" + } + }, + "description": "Retrieves the details of specified NVA connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NVA connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the NVA connection", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "NetworkVirtualApplianceConnections_Delete", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionDelete": { + "$ref": "./examples/NetworkVirtualApplianceConnectionDelete.json" + } + }, + "description": "Deletes a NVA connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NVA connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful.NVA Connection deleted." + }, + "202": { + "description": "Accepted, and the operation will continue asynchronously.", + "headers": { + "location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "No NVA connections exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/networkVirtualApplianceConnections": { + "get": { + "operationId": "NetworkVirtualApplianceConnections_List", + "x-ms-examples": { + "NetworkVirtualApplianceConnectionList": { + "$ref": "./examples/NetworkVirtualApplianceConnectionList.json" + } + }, + "description": "Lists NetworkVirtualApplianceConnections under the NVA.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_]+", + "description": "The name of the Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Lists all the NVA connections under an NVA.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}": { + "get": { + "operationId": "VirtualHubBgpConnection_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubBgpConnectionGet.json" + } + }, + "description": "Retrieves the details of a Virtual Hub Bgp Connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the Bgp Connection retrieved.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubBgpConnection_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubRouteTableV2Put": { + "$ref": "./examples/VirtualHubBgpConnectionPut.json" + } + }, + "description": "Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BgpConnection" + }, + "description": "Parameters of Bgp connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the BgpConnection created or updated.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the BgpConnection created or updated.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubBgpConnection_Delete", + "x-ms-examples": { + "VirtualHubRouteTableV2Delete": { + "$ref": "./examples/VirtualHubBgpConnectionDelete.json" + } + }, + "description": "Deletes a VirtualHubBgpConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubBgpConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubBgpConnection deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubBgpConnection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubBgpConnection exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections": { + "get": { + "operationId": "VirtualHubBgpConnections_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubBgpConnectionList.json" + } + }, + "description": "Retrieves the details of all VirtualHubBgpConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubBgpConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubBgpConnectionResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/learnedRoutes": { + "post": { + "operationId": "VirtualHubBgpConnections_ListLearnedRoutes", + "description": "Retrieves a list of routes the virtual hub bgp connection has learned.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub bgp connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes.", + "schema": { + "$ref": "#/definitions/PeerRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualRouterPeerListLearnedRoutes": { + "$ref": "./examples/VirtualRouterPeerListLearnedRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{hubName}/bgpConnections/{connectionName}/advertisedRoutes": { + "post": { + "operationId": "VirtualHubBgpConnections_ListAdvertisedRoutes", + "description": "Retrieves a list of routes the virtual hub bgp connection is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual hub bgp connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes.", + "schema": { + "$ref": "#/definitions/PeerRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VirtualRouterPeerListAdvertisedRoutes": { + "$ref": "./examples/VirtualRouterPeerListAdvertisedRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}": { + "get": { + "operationId": "VirtualHubIpConfiguration_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubIpConfigurationGet.json" + } + }, + "description": "Retrieves the details of a Virtual Hub Ip configuration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the Bgp Connection retrieved.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubIpConfiguration_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubIpConfigurationPut": { + "$ref": "./examples/VirtualHubIpConfigurationPut.json" + } + }, + "description": "Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + }, + "description": "Hub Ip Configuration parameters." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the IpConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the IpConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubIpConfiguration_Delete", + "x-ms-examples": { + "VirtualHubIpConfigurationDelete": { + "$ref": "./examples/VirtualHubIpConfigurationDelete.json" + } + }, + "description": "Deletes a VirtualHubIpConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubBgpConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubIpConfiguration deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubIpConfiguration deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubIpConfiguration exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations": { + "get": { + "operationId": "VirtualHubIpConfiguration_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubIpConfigurationList.json" + } + }, + "description": "Retrieves the details of all VirtualHubIpConfigurations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubIpConfigurations for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubIpConfigurationResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}": { + "put": { + "operationId": "HubRouteTables_CreateOrUpdate", + "x-ms-examples": { + "RouteTablePut": { + "$ref": "./examples/HubRouteTablePut.json" + } + }, + "description": "Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routeTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubRouteTable" + }, + "description": "Parameters supplied to create or update RouteTable." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteTable created or updated.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the RouteTable created or updated.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "HubRouteTables_Get", + "x-ms-examples": { + "RouteTableGet": { + "$ref": "./examples/HubRouteTableGet.json" + } + }, + "description": "Retrieves the details of a RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteTable retrieved.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "HubRouteTables_Delete", + "x-ms-examples": { + "RouteTableDelete": { + "$ref": "./examples/HubRouteTableDelete.json" + } + }, + "description": "Deletes a RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteTable." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RouteTable deleted." + }, + "202": { + "description": "Request received successfully. RouteTable deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RouteTables exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables": { + "get": { + "operationId": "HubRouteTables_List", + "x-ms-examples": { + "RouteTableList": { + "$ref": "./examples/HubRouteTableList.json" + } + }, + "description": "Retrieves the details of all RouteTables.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RouteTables for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubRouteTablesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/effectiveRoutes": { + "post": { + "operationId": "VirtualHubs_GetEffectiveVirtualHubRoutes", + "x-ms-examples": { + "Effective Routes for the Virtual Hub": { + "$ref": "./examples/EffectiveRoutesListForVirtualHub.json" + }, + "Effective Routes for a Route Table resource": { + "$ref": "./examples/EffectiveRoutesListForRouteTable.json" + }, + "Effective Routes for a Connection resource": { + "$ref": "./examples/EffectiveRoutesListForConnection.json" + } + }, + "description": "Gets the effective routes configured for the Virtual Hub resource or the specified resource .", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "effectiveRoutesParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EffectiveRoutesParameters" + }, + "description": "Parameters supplied to get the effective routes for a specific resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of the effective routes or follow the location header for the effective routes list.", + "schema": { + "$ref": "#/definitions/VirtualHubEffectiveRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/inboundRoutes": { + "post": { + "operationId": "VirtualHubs_GetInboundRoutes", + "x-ms-examples": { + "Inbound Routes for the Virtual Hub on a Particular Connection": { + "$ref": "./examples/GetInboundRoutes.json" + } + }, + "description": "Gets the inbound routes configured for the Virtual Hub on a particular connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "getInboundRoutesParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetInboundRoutesParameters" + }, + "description": "Parameters supplied to get the inbound routes for a connection resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of the effective route map routes or follow the location header for the inbound routes list.", + "schema": { + "$ref": "#/definitions/EffectiveRouteMapRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/outboundRoutes": { + "post": { + "operationId": "VirtualHubs_GetOutboundRoutes", + "x-ms-examples": { + "Outbound Routes for the Virtual Hub on a Particular Connection": { + "$ref": "./examples/GetOutboundRoutes.json" + } + }, + "description": "Gets the outbound routes configured for the Virtual Hub on a particular connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "getOutboundRoutesParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetOutboundRoutesParameters" + }, + "description": "Parameters supplied to get the outbound routes for a connection resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the list of the effective route map routes or follow the location header for the outbound routes list.", + "schema": { + "$ref": "#/definitions/EffectiveRouteMapRouteList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent/{routingIntentName}": { + "put": { + "operationId": "RoutingIntent_CreateOrUpdate", + "x-ms-examples": { + "RouteTablePut": { + "$ref": "./examples/RoutingIntentPut.json" + } + }, + "description": "Creates a RoutingIntent resource if it doesn't exist else updates the existing RoutingIntent.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RoutingIntent." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routingIntentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the per VirtualHub singleton Routing Intent resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routingIntentParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoutingIntent" + }, + "description": "Parameters supplied to create or update RoutingIntent." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RoutingIntent created or updated.", + "schema": { + "$ref": "#/definitions/RoutingIntent" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the RoutingIntent created or updated.", + "schema": { + "$ref": "#/definitions/RoutingIntent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "RoutingIntent_Get", + "x-ms-examples": { + "RouteTableGet": { + "$ref": "./examples/RoutingIntentGet.json" + } + }, + "description": "Retrieves the details of a RoutingIntent.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RoutingIntent." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routingIntentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RoutingIntent." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RoutingIntent retrieved.", + "schema": { + "$ref": "#/definitions/RoutingIntent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "RoutingIntent_Delete", + "x-ms-examples": { + "RouteTableDelete": { + "$ref": "./examples/RoutingIntentDelete.json" + } + }, + "description": "Deletes a RoutingIntent.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RoutingIntent." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routingIntentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RoutingIntent." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RoutingIntent deleted." + }, + "202": { + "description": "Request received successfully. RoutingIntent deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RoutingIntent exists by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routingIntent": { + "get": { + "operationId": "RoutingIntent_List", + "x-ms-examples": { + "RoutingIntentList": { + "$ref": "./examples/RoutingIntentList.json" + } + }, + "description": "Retrieves the details of all RoutingIntent child resources of the VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RoutingIntent resources for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListRoutingIntentResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualWanProperties": { + "properties": { + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "virtualHubs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VirtualHubs in the VirtualWAN." + }, + "vpnSites": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VpnSites in the VirtualWAN." + }, + "allowBranchToBranchTraffic": { + "type": "boolean", + "description": "True if branch to branch traffic is allowed." + }, + "allowVnetToVnetTraffic": { + "type": "boolean", + "description": "True if Vnet to Vnet traffic is allowed." + }, + "office365LocalBreakoutCategory": { + "description": "The office local breakout category.", + "$ref": "#/definitions/OfficeTrafficCategory" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual WAN resource." + }, + "type": { + "type": "string", + "description": "The type of the VirtualWAN." + } + }, + "description": "Parameters for VirtualWAN." + }, + "VirtualWAN": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualWanProperties", + "description": "Properties of the virtual WAN." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualWAN Resource." + }, + "ListVirtualWANsResult": { + "description": "Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "List of VirtualWANs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the vpnSite belongs." + }, + "deviceProperties": { + "description": "The device properties.", + "$ref": "#/definitions/DeviceProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site." + }, + "siteKey": { + "type": "string", + "description": "The key for vpn-site that can be used for connections." + }, + "addressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges." + }, + "bgpProperties": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site resource." + }, + "isSecuritySite": { + "type": "boolean", + "description": "IsSecuritySite flag." + }, + "vpnSiteLinks": { + "type": "array", + "description": "List of all vpn site links.", + "items": { + "$ref": "#/definitions/VpnSiteLink" + } + }, + "o365Policy": { + "readOnly": false, + "description": "Office365 Policy.", + "$ref": "#/definitions/O365PolicyProperties" + } + }, + "description": "Parameters for VpnSite." + }, + "VpnSite": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteProperties", + "description": "Properties of the VPN site." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnSite Resource." + }, + "ListVpnSitesResult": { + "description": "Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSite" + }, + "description": "List of VpnSites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteLinkProperties": { + "properties": { + "linkProperties": { + "description": "The link provider properties.", + "$ref": "#/definitions/VpnLinkProviderProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site-link." + }, + "fqdn": { + "type": "string", + "description": "FQDN of vpn-site-link." + }, + "bgpProperties": { + "$ref": "#/definitions/VpnLinkBgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site link resource." + } + }, + "description": "Parameters for VpnSite." + }, + "VpnSiteLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteLinkProperties", + "description": "Properties of the VPN site link." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnSiteLink Resource." + }, + "ListVpnSiteLinksResult": { + "description": "Result of the request to list VpnSiteLinks. It contains a list of VpnSiteLinks and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSiteLink" + }, + "description": "List of VpnSitesLinks." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "GetVpnSitesConfigurationRequest": { + "properties": { + "vpnSites": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of resource-ids of the vpn-sites for which config is to be downloaded." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the configurations for vpn-sites." + } + }, + "required": [ + "outputBlobSasUrl" + ], + "description": "List of Vpn-Sites." + }, + "VirtualHubProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the VirtualHub belongs." + }, + "vpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnGateway associated with this VirtualHub." + }, + "p2SVpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The P2SVpnGateway associated with this VirtualHub." + }, + "expressRouteGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The expressRouteGateway associated with this VirtualHub." + }, + "azureFirewall": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The azureFirewall associated with this VirtualHub." + }, + "securityPartnerProvider": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The securityPartnerProvider associated with this VirtualHub." + }, + "addressPrefix": { + "type": "string", + "description": "Address-prefix for this VirtualHub." + }, + "routeTable": { + "$ref": "#/definitions/VirtualHubRouteTable", + "description": "The routeTable associated with this virtual hub." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual hub resource." + }, + "securityProviderName": { + "type": "string", + "description": "The Security Provider name." + }, + "virtualHubRouteTableV2s": { + "type": "array", + "description": "List of all virtual hub route table v2s associated with this VirtualHub.", + "items": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "sku": { + "type": "string", + "description": "The sku of this VirtualHub." + }, + "routingState": { + "$ref": "#/definitions/RoutingState", + "description": "The routing state." + }, + "bgpConnections": { + "type": "array", + "readOnly": true, + "description": "List of references to Bgp Connections.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "ipConfigurations": { + "type": "array", + "readOnly": true, + "description": "List of references to IpConfigurations.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "routeMaps": { + "type": "array", + "readOnly": true, + "description": "List of references to RouteMaps.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "virtualRouterAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualRouter ASN." + }, + "virtualRouterIps": { + "type": "array", + "readOnly": false, + "description": "VirtualRouter IPs.", + "items": { + "type": "string" + } + }, + "allowBranchToBranchTraffic": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control transit for VirtualRouter hub." + }, + "preferredRoutingGateway": { + "$ref": "#/definitions/PreferredRoutingGateway", + "description": "The preferred gateway to route on-prem traffic" + }, + "hubRoutingPreference": { + "$ref": "#/definitions/HubRoutingPreference", + "description": "The hubRoutingPreference of this VirtualHub." + }, + "virtualRouterAutoScaleConfiguration": { + "$ref": "#/definitions/VirtualRouterAutoScaleConfiguration", + "description": "The VirtualHub Router autoscale configuration." + } + }, + "description": "Parameters for VirtualHub." + }, + "VirtualRouterAutoScaleConfiguration": { + "type": "object", + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The minimum number of scale units for VirtualHub Router." + } + }, + "description": "The VirtualHub Router autoscale configuration." + }, + "PreferredRoutingGateway": { + "type": "string", + "description": "The preferred routing gateway types", + "enum": [ + "ExpressRoute", + "VpnGateway", + "None" + ], + "x-ms-enum": { + "name": "PreferredRoutingGateway", + "modelAsString": true + } + }, + "HubRoutingPreference": { + "type": "string", + "description": "The hub routing preference gateway types", + "enum": [ + "ExpressRoute", + "VpnGateway", + "ASPath" + ], + "x-ms-enum": { + "name": "HubRoutingPreference", + "modelAsString": true + } + }, + "RoutingState": { + "type": "string", + "description": "The current routing state of the VirtualHub.", + "readOnly": true, + "enum": [ + "None", + "Provisioned", + "Provisioning", + "Failed" + ], + "x-ms-enum": { + "name": "RoutingState", + "modelAsString": true + } + }, + "BgpConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpConnectionProperties", + "description": "The properties of the Bgp connections." + }, + "name": { + "type": "string", + "description": "Name of the connection." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Connection type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Appliance Site resource." + }, + "BgpConnectionProperties": { + "properties": { + "peerAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Peer ASN." + }, + "peerIp": { + "type": "string", + "readOnly": false, + "description": "Peer IP." + }, + "hubVirtualNetworkConnection": { + "description": "The reference to the HubVirtualNetworkConnection resource.", + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + }, + "connectionState": { + "type": "string", + "description": "The current state of the VirtualHub to Peer.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubBgpConnectionStatus", + "modelAsString": true + } + } + }, + "description": "Properties of the bgp connection." + }, + "PeerRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The peer's local address." + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix." + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop." + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from." + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from." + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence." + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight." + } + }, + "description": "Peer routing details." + }, + "PeerRouteList": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerRoute" + }, + "x-ms-identifiers": [], + "description": "List of peer routes." + }, + "description": "Map from virtual router instance to list of peer routes." + }, + "HubIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubIPConfigurationPropertiesFormat", + "description": "The properties of the Virtual Hub IPConfigurations." + }, + "name": { + "type": "string", + "description": "Name of the Ip Configuration." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Ipconfiguration type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IpConfigurations." + }, + "HubIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration resource." + } + }, + "description": "Properties of IP configuration." + }, + "VirtualHubRouteTable": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRoute" + } + } + }, + "description": "VirtualHub route table." + }, + "VirtualHubRoute": { + "properties": { + "addressPrefixes": { + "type": "array", + "description": "List of all addressPrefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "NextHop ip address." + } + }, + "description": "VirtualHub route." + }, + "VirtualHub": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubProperties", + "description": "Properties of the virtual hub." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of service virtual hub. This is metadata used for the Azure portal experience for Route Server." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualHub Resource." + }, + "ListVirtualHubsResult": { + "description": "Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "List of VirtualHubs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs." + }, + "connections": { + "type": "array", + "description": "List of all vpn connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnConnection" + } + }, + "bgpSettings": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN gateway resource." + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this vpn gateway." + }, + "ipConfigurations": { + "type": "array", + "readOnly": true, + "description": "List of all IPs configured on the gateway.", + "items": { + "$ref": "#/definitions/VpnGatewayIpConfiguration" + } + }, + "enableBgpRouteTranslationForNat": { + "type": "boolean", + "description": "Enable BGP routes translation for NAT on this VpnGateway." + }, + "isRoutingPreferenceInternet": { + "type": "boolean", + "description": "Enable Routing Preference property for the Public IP Interface of the VpnGateway." + }, + "natRules": { + "type": "array", + "description": "List of all the nat Rules associated with the gateway.", + "items": { + "$ref": "#/definitions/VpnGatewayNatRule" + } + } + }, + "description": "Parameters for VpnGateway." + }, + "VpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayProperties", + "description": "Properties of the VPN gateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnGateway Resource." + }, + "VpnGatewayIpConfiguration": { + "description": "IP Configuration of a VPN Gateway Resource.", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the IP configuration for a VPN Gateway." + }, + "publicIpAddress": { + "type": "string", + "description": "The public IP address of this IP configuration." + }, + "privateIpAddress": { + "type": "string", + "description": "The private IP address of this IP configuration." + } + } + }, + "ListVpnGatewaysResult": { + "description": "Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "List of VpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnNatRuleMapping": { + "properties": { + "addressSpace": { + "type": "string", + "description": "Address space for Vpn NatRule mapping." + }, + "portRange": { + "type": "string", + "description": "Port range for Vpn NatRule mapping." + } + }, + "description": "Vpn NatRule mapping." + }, + "VpnGatewayNatRuleProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT Rule resource." + }, + "type": { + "type": "string", + "description": "The type of NAT rule for VPN NAT.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "VpnNatRuleType", + "modelAsString": true + } + }, + "mode": { + "type": "string", + "description": "The Source NAT direction of a VPN NAT.", + "enum": [ + "EgressSnat", + "IngressSnat" + ], + "x-ms-enum": { + "name": "VpnNatRuleMode", + "modelAsString": true + } + }, + "internalMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address internal mapping for NAT." + }, + "externalMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnNatRuleMapping" + }, + "description": "The private IP address external mapping for NAT." + }, + "ipConfigurationId": { + "type": "string", + "description": "The IP Configuration ID this NAT rule applies to." + }, + "egressVpnSiteLinkConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of egress VpnSiteLinkConnections." + }, + "ingressVpnSiteLinkConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of ingress VpnSiteLinkConnections." + } + }, + "description": "Parameters for VpnGatewayNatRule." + }, + "VpnGatewayNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayNatRuleProperties", + "description": "Properties of the VpnGateway NAT rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnGatewayNatRule Resource." + }, + "ListVpnGatewayNatRulesResult": { + "description": "Result of the request to list all nat rules to a virtual wan vpn gateway. It contains a list of Nat rules and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGatewayNatRule" + }, + "description": "List of Nat Rules." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionProperties": { + "properties": { + "remoteVpnSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "Routing weight for vpn connection." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "DPD timeout in seconds for vpn connection." + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection.", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "Deprecated: SharedKey for the vpn connection. This is no more used." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use local azure ip to initiate connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN connection resource." + }, + "vpnLinkConnections": { + "type": "array", + "description": "List of all vpn site link connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnSiteLinkConnection" + } + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Parameters for VpnConnection." + }, + "VpnConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnConnectionProperties", + "description": "Properties of the VPN connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnConnection Resource." + }, + "ListVpnConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "List of Vpn Connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionPacketCaptureStartParameters": { + "description": "Vpn Connection packet capture parameters supplied to start packet capture on gateway connection.", + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters on vpn connection." + }, + "linkConnectionNames": { + "type": "array", + "description": "List of site link connection names.", + "items": { + "type": "string" + } + } + } + }, + "VpnConnectionPacketCaptureStopParameters": { + "description": "Vpn Connection packet capture parameters supplied to stop packet capture on gateway connection.", + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on vpn connection." + }, + "linkConnectionNames": { + "type": "array", + "description": "List of site link connection names.", + "items": { + "type": "string" + } + } + } + }, + "VpnGatewayPacketCaptureStartParameters": { + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters on vpn gateway." + } + }, + "description": "Start packet capture parameters." + }, + "VpnGatewayPacketCaptureStopParameters": { + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on vpn gateway." + } + }, + "description": "Stop packet capture parameters." + }, + "VpnSiteLinkConnectionProperties": { + "properties": { + "vpnSiteLink": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site link." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "Routing weight for vpn connection." + }, + "vpnLinkConnectionMode": { + "type": "string", + "description": "Vpn link connection mode.", + "enum": [ + "Default", + "ResponderOnly", + "InitiatorOnly" + ], + "x-ms-enum": { + "name": "VpnLinkConnectionMode", + "modelAsString": true + } + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection.", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "x-ms-secret": true, + "description": "SharedKey for the vpn link connection. We will no longer return sharedKey in any Create/Update/Get/List/UpdateTags VpnGateway/VpnConnection/VpnLinkConnection APIs response. Please use 'Vpn Link Connections - List Default Shared Key' API to fetch Vpn link connection sharedKey." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "vpnGatewayCustomBgpAddresses": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/GatewayCustomBgpIpAddressIpConfiguration" + }, + "description": "vpnGatewayCustomBgpAddresses used by this connection.", + "x-ms-identifiers": [] + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use local azure ip to initiate connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site link connection resource." + }, + "ingressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of ingress NatRules." + }, + "egressNatRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of egress NatRules." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "Dead Peer Detection timeout in seconds for VpnLink connection." + } + }, + "description": "Parameters for VpnConnection." + }, + "VpnSiteLinkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteLinkConnectionProperties", + "description": "Properties of the VPN site link connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnSiteLinkConnection Resource." + }, + "ListVpnSiteLinkConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSiteLinkConnection" + }, + "description": "List of VpnSiteLinkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubVirtualNetworkConnectionProperties": { + "properties": { + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the remote virtual network." + }, + "allowHubToRemoteVnetTransit": { + "type": "boolean", + "description": "Deprecated: VirtualHub to RemoteVnet transit to enabled or not." + }, + "allowRemoteVnetToUseHubVnetGateways": { + "type": "boolean", + "description": "Deprecated: Allow RemoteVnet to use Virtual Hub's gateways." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the hub virtual network connection resource." + } + }, + "description": "Parameters for HubVirtualNetworkConnection." + }, + "HubVirtualNetworkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubVirtualNetworkConnectionProperties", + "description": "Properties of the hub virtual network connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "HubVirtualNetworkConnection Resource." + }, + "ListHubVirtualNetworkConnectionsResult": { + "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "List of HubVirtualNetworkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubRouteTableProperties": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/HubRoute" + } + }, + "labels": { + "type": "array", + "description": "List of labels associated with this route table.", + "items": { + "type": "string" + } + }, + "associatedConnections": { + "type": "array", + "description": "List of all connections associated with this route table.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "propagatingConnections": { + "type": "array", + "description": "List of all connections that advertise to this route table.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RouteTable resource." + } + }, + "description": "Parameters for RouteTable." + }, + "HubRouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubRouteTableProperties", + "description": "Properties of the RouteTable resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "RouteTable resource in a virtual hub." + }, + "HubRoute": { + "required": [ + "name", + "destinationType", + "destinations", + "nextHopType", + "nextHop" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the Route that is unique within a RouteTable. This name can be used to access this route." + }, + "destinationType": { + "type": "string", + "description": "The type of destinations (eg: CIDR, ResourceId, Service)." + }, + "destinations": { + "type": "array", + "description": "List of all destinations.", + "items": { + "type": "string" + } + }, + "nextHopType": { + "type": "string", + "description": "The type of next hop (eg: ResourceId)." + }, + "nextHop": { + "type": "string", + "description": "NextHop resource ID." + } + }, + "description": "RouteTable route." + }, + "ListHubRouteTablesResult": { + "description": "List of RouteTables and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubRouteTable" + }, + "description": "List of RouteTables." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteId": { + "properties": { + "vpnSite": { + "type": "string", + "readOnly": true, + "description": "The resource-uri of the vpn-site for which config is to be fetched." + } + }, + "description": "VpnSite Resource." + }, + "DeviceProperties": { + "properties": { + "deviceVendor": { + "type": "string", + "description": "Name of the device Vendor." + }, + "deviceModel": { + "type": "string", + "description": "Model of the device." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of the device." + }, + "VirtualWanSecurityProviders": { + "properties": { + "supportedProviders": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWanSecurityProvider" + }, + "description": "List of VirtualWAN security providers." + } + }, + "description": "Collection of SecurityProviders." + }, + "VirtualWanSecurityProvider": { + "properties": { + "name": { + "type": "string", + "description": "Name of the security provider." + }, + "url": { + "type": "string", + "description": "Url of the security provider." + }, + "type": { + "$ref": "#/definitions/VirtualWanSecurityProviderType", + "description": "Name of the security provider." + } + }, + "description": "Collection of SecurityProviders." + }, + "VpnConnectionStatus": { + "type": "string", + "description": "The current state of the vpn connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VpnConnectionStatus", + "modelAsString": true + } + }, + "TunnelConnectionStatus": { + "type": "string", + "description": "The current state of the tunnel.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "TunnelConnectionStatus", + "modelAsString": true + } + }, + "HubVirtualNetworkConnectionStatus": { + "type": "string", + "description": "The current state of the VirtualHub to vnet connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubVirtualNetworkConnectionStatus", + "modelAsString": true + } + }, + "OfficeTrafficCategory": { + "type": "string", + "description": "The office traffic category.", + "readOnly": true, + "enum": [ + "Optimize", + "OptimizeAndAllow", + "All", + "None" + ], + "x-ms-enum": { + "name": "OfficeTrafficCategory", + "modelAsString": true + } + }, + "VirtualWanSecurityProviderType": { + "type": "string", + "description": "The virtual wan security provider type.", + "readOnly": true, + "enum": [ + "External", + "Native" + ], + "x-ms-enum": { + "name": "VirtualWanSecurityProviderType", + "modelAsString": true + } + }, + "VpnServerConfigVpnClientRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "publicCertData": { + "type": "string", + "description": "The certificate public data." + } + }, + "description": "Properties of VPN client root certificate of VpnServerConfiguration." + }, + "VpnServerConfigRadiusServerRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "publicCertData": { + "type": "string", + "description": "The certificate public data." + } + }, + "description": "Properties of Radius Server root certificate of VpnServerConfiguration." + }, + "VpnServerConfigVpnClientRevokedCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + } + }, + "description": "Properties of the revoked VPN client certificate of VpnServerConfiguration." + }, + "VpnServerConfigRadiusClientRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "thumbprint": { + "type": "string", + "description": "The Radius client root certificate thumbprint." + } + }, + "description": "Properties of the Radius client root certificate of VpnServerConfiguration." + }, + "AadAuthenticationParameters": { + "properties": { + "aadTenant": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD tenant." + }, + "aadAudience": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD audience." + }, + "aadIssuer": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD issuer." + } + }, + "description": "AAD Vpn authentication type related parameters." + }, + "VpnServerConfigurationProperties": { + "properties": { + "name": { + "type": "string", + "description": "The name of the VpnServerConfiguration that is unique within a resource group." + }, + "vpnProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN protocol enabled for the VpnServerConfiguration.", + "enum": [ + "IkeV2", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnGatewayTunnelingProtocol", + "modelAsString": true + } + }, + "description": "VPN protocols for the VpnServerConfiguration." + }, + "vpnAuthenticationTypes": { + "type": "array", + "items": { + "type": "string", + "description": "VPN authentication types enabled for the VpnServerConfiguration.", + "enum": [ + "Certificate", + "Radius", + "AAD" + ], + "x-ms-enum": { + "name": "VpnAuthenticationType", + "modelAsString": true + } + }, + "description": "VPN authentication types for the VpnServerConfiguration." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigVpnClientRootCertificate" + }, + "description": "VPN client root certificate of VpnServerConfiguration." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigVpnClientRevokedCertificate" + }, + "description": "VPN client revoked certificate of VpnServerConfiguration." + }, + "radiusServerRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigRadiusServerRootCertificate" + }, + "description": "Radius Server root certificate of VpnServerConfiguration." + }, + "radiusClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigRadiusClientRootCertificate" + }, + "description": "Radius client root certificate of VpnServerConfiguration." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for VpnServerConfiguration." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VpnServerConfiguration resource for point to site client connection." + }, + "radiusServerSecret": { + "type": "string", + "x-ms-secret": true, + "description": "The radius secret property of the VpnServerConfiguration resource for point to site client connection. We will no longer return radiusServerSecret in VpnServerConfiguration Create/Update/Get/List/UpdateTags APIs response. Please use VpnServerConfiguration ListRadiusSecrets API to fetch radius server secrets." + }, + "radiusServers": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/RadiusServer" + }, + "description": "Multiple Radius Server configuration for VpnServerConfiguration." + }, + "aadAuthenticationParameters": { + "$ref": "#/definitions/AadAuthenticationParameters", + "description": "The set of aad vpn authentication parameters." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "p2SVpnGateways": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of references to P2SVpnGateways." + }, + "configurationPolicyGroups": { + "type": "array", + "description": "List of all VpnServerConfigurationPolicyGroups.", + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + } + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Parameters for VpnServerConfiguration." + }, + "VpnServerConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnServerConfigurationProperties", + "description": "Properties of the P2SVpnServer configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnServerConfiguration Resource." + }, + "ListVpnServerConfigurationsResult": { + "description": "Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfiguration" + }, + "description": "List of VpnServerConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnClientConnectionHealth": { + "properties": { + "totalIngressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection." + }, + "totalEgressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Egress Bytes Transferred in this connection." + }, + "vpnClientConnectionsCount": { + "type": "integer", + "format": "int32", + "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." + }, + "allocatedIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allocated ip addresses to the connected p2s vpn clients." + } + }, + "description": "VpnClientConnectionHealth properties." + }, + "VpnServerConfigurationPolicyGroupProperties": { + "type": "object", + "properties": { + "isDefault": { + "type": "boolean", + "description": "Shows if this is a Default VpnServerConfigurationPolicyGroup or not." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Priority for VpnServerConfigurationPolicyGroup." + }, + "policyMembers": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroupMember" + }, + "description": "Multiple PolicyMembers for VpnServerConfigurationPolicyGroup.", + "x-ms-identifiers": [] + }, + "p2SConnectionConfigurations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of references to P2SConnectionConfigurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VpnServerConfigurationPolicyGroup resource." + } + }, + "description": "Parameters for VpnServerConfigurationPolicyGroup." + }, + "VpnServerConfigurationPolicyGroup": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnServerConfigurationPolicyGroupProperties", + "description": "Properties of the VpnServerConfigurationPolicyGroup." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnServerConfigurationPolicyGroup Resource." + }, + "VpnServerConfigurationPolicyGroupMember": { + "properties": { + "name": { + "type": "string", + "description": "Name of the VpnServerConfigurationPolicyGroupMember." + }, + "attributeType": { + "type": "string", + "description": "The Vpn Policy member attribute type.", + "enum": [ + "CertificateGroupId", + "AADGroupId", + "RadiusAzureGroupId" + ], + "x-ms-enum": { + "name": "VpnPolicyMemberAttributeType", + "modelAsString": true + } + }, + "attributeValue": { + "type": "string", + "description": "The value of Attribute used for this VpnServerConfigurationPolicyGroupMember." + } + }, + "description": "VpnServerConfiguration PolicyGroup member", + "type": "object" + }, + "ListVpnServerConfigurationPolicyGroupsResult": { + "type": "object", + "description": "Result of the request to list VpnServerConfigurationPolicyGroups. It contains a list of VpnServerConfigurationPolicyGroups and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + }, + "description": "List of VpnServerConfigurationPolicyGroups." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs." + }, + "p2SConnectionConfigurations": { + "type": "array", + "description": "List of all p2s connection configurations of the gateway.", + "items": { + "$ref": "#/definitions/P2SConnectionConfiguration" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the P2S VPN gateway resource." + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this p2s vpn gateway." + }, + "vpnServerConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnServerConfiguration to which the p2sVpnGateway is attached to." + }, + "vpnClientConnectionHealth": { + "readOnly": true, + "$ref": "#/definitions/VpnClientConnectionHealth", + "description": "All P2S VPN clients' connection health status." + }, + "customDnsServers": { + "type": "array", + "description": "List of all customer specified DNS servers IP addresses.", + "items": { + "type": "string" + } + }, + "isRoutingPreferenceInternet": { + "type": "boolean", + "description": "Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway." + } + }, + "description": "Parameters for P2SVpnGateway." + }, + "P2SVpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnGatewayProperties", + "description": "Properties of the P2SVpnGateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "P2SVpnGateway Resource." + }, + "ListP2SVpnGatewaysResult": { + "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of P2SVpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnProfileParameters": { + "properties": { + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + } + }, + "description": "Vpn Client Parameters for package generation." + }, + "VpnProfileResponse": { + "properties": { + "profileUrl": { + "type": "string", + "description": "URL to the VPN profile." + } + }, + "description": "Vpn Profile Response for package generation." + }, + "VpnLinkBgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + } + }, + "description": "BGP settings details for a link." + }, + "VpnLinkProviderProperties": { + "properties": { + "linkProviderName": { + "type": "string", + "description": "Name of the link provider." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of a link provider." + }, + "VpnServerConfigurationsResponse": { + "properties": { + "vpnServerConfigurationResourceIds": { + "type": "array", + "items": { + "type": "string", + "description": "VpnServerConfiguration partial resource uri." + }, + "description": "List of VpnServerConfigurations associated with VirtualWan." + } + }, + "description": "VpnServerConfigurations list associated with VirtualWan Response." + }, + "VirtualWanVpnProfileParameters": { + "properties": { + "vpnServerConfigurationResourceId": { + "type": "string", + "description": "VpnServerConfiguration partial resource uri with which VirtualWan is associated to." + }, + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + } + }, + "description": "Virtual Wan Vpn profile parameters Vpn profile generation." + }, + "P2SVpnConnectionHealthRequest": { + "properties": { + "vpnUserNamesFilter": { + "type": "array", + "items": { + "type": "string", + "description": "P2S vpn user name." + }, + "description": "The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the P2S Vpn connection health detail." + } + }, + "description": "List of P2S Vpn connection health request." + }, + "P2SVpnConnectionHealth": { + "properties": { + "sasUrl": { + "type": "string", + "description": "Returned sas url of the blob to which the p2s vpn connection detailed health will be written." + } + }, + "description": "P2S Vpn connection detailed health written to sas url." + }, + "P2SConnectionConfigurationProperties": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not." + }, + "configurationPolicyGroupAssociations": { + "type": "array", + "readOnly": false, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to." + }, + "previousConfigurationPolicyGroupAssociations": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VpnServerConfigurationPolicyGroup" + }, + "description": "List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the P2SConnectionConfiguration resource." + } + }, + "description": "Parameters for P2SConnectionConfiguration." + }, + "P2SConnectionConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SConnectionConfigurationProperties", + "description": "Properties of the P2S connection configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "P2SConnectionConfiguration Resource." + }, + "VirtualHubRouteTableV2Properties": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRouteV2" + } + }, + "attachedConnections": { + "type": "array", + "description": "List of all connections attached to this route table v2.", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the virtual hub route table v2 resource." + } + }, + "description": "Parameters for VirtualHubRouteTableV2." + }, + "VirtualHubRouteTableV2": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubRouteTableV2Properties", + "description": "Properties of the virtual hub route table v2." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VirtualHubRouteTableV2 Resource." + }, + "VirtualHubRouteV2": { + "properties": { + "destinationType": { + "type": "string", + "description": "The type of destinations." + }, + "destinations": { + "type": "array", + "description": "List of all destinations.", + "items": { + "type": "string" + } + }, + "nextHopType": { + "type": "string", + "description": "The type of next hops." + }, + "nextHops": { + "type": "array", + "description": "NextHops ip address.", + "items": { + "type": "string" + } + } + }, + "description": "VirtualHubRouteTableV2 route." + }, + "ListVirtualHubRouteTableV2sResult": { + "description": "List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + }, + "description": "List of VirtualHubRouteTableV2s." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnConnectionRequest": { + "description": "List of p2s vpn connections to be disconnected.", + "properties": { + "vpnConnectionIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of p2s vpn connection Ids." + } + } + }, + "VirtualHubId": { + "properties": { + "id": { + "type": "string", + "description": "The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription." + } + }, + "description": "Virtual Hub identifier." + }, + "ExpressRouteCircuitPeeringId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the ExpressRoute circuit peering." + } + }, + "description": "ExpressRoute circuit peering identifier." + }, + "ExpressRouteConnectionId": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the ExpressRouteConnection." + } + }, + "description": "The ID of the ExpressRouteConnection." + }, + "ExpressRouteGatewayProperties": { + "required": [ + "virtualHub" + ], + "properties": { + "autoScaleConfiguration": { + "properties": { + "bounds": { + "properties": { + "min": { + "type": "integer", + "description": "Minimum number of scale units deployed for ExpressRoute gateway." + }, + "max": { + "type": "integer", + "description": "Maximum number of scale units deployed for ExpressRoute gateway." + } + }, + "description": "Minimum and maximum number of scale units to deploy." + } + }, + "description": "Configuration for auto scaling." + }, + "expressRouteConnections": { + "type": "array", + "description": "List of ExpressRoute connections to the ExpressRoute gateway.", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route gateway resource." + }, + "virtualHub": { + "$ref": "#/definitions/VirtualHubId", + "description": "The Virtual Hub where the ExpressRoute gateway is or will be deployed." + }, + "allowNonVirtualWanTraffic": { + "type": "boolean", + "description": "Configures this gateway to accept traffic from non Virtual WAN networks." + } + }, + "description": "ExpressRoute gateway resource properties." + }, + "ExpressRouteGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteGatewayProperties", + "description": "Properties of the express route gateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRoute gateway resource." + }, + "ExpressRouteGatewayList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "List of ExpressRoute gateways." + } + }, + "description": "List of ExpressRoute gateways." + }, + "ExpressRouteConnectionProperties": { + "required": [ + "expressRouteCircuitPeering" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route connection resource." + }, + "expressRouteCircuitPeering": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringId", + "description": "The ExpressRoute circuit peering." + }, + "authorizationKey": { + "type": "string", + "description": "Authorization key to establish the connection." + }, + "routingWeight": { + "type": "integer", + "description": "The routing weight associated to the connection." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Enable FastPath to vWan Firewall hub." + }, + "enablePrivateLinkFastPath": { + "type": "boolean", + "description": "Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Properties of the ExpressRouteConnection subresource." + }, + "ExpressRouteConnection": { + "required": [ + "name" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteConnectionProperties", + "description": "Properties of the express route connection." + }, + "name": { + "type": "string", + "description": "The name of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ExpressRouteConnection resource." + }, + "ExpressRouteConnectionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "The list of ExpressRoute connections." + } + }, + "description": "ExpressRouteConnection list." + }, + "NetworkVirtualApplianceConnectionProperties": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NetworkVirtualApplianceConnection resource." + }, + "asn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Network Virtual Appliance ASN." + }, + "tunnelIdentifier": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Unique identifier for the connection." + }, + "bgpPeerAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of bgpPeerAddresses for the NVA instances" + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Properties of the NetworkVirtualApplianceConnection subresource." + }, + "NetworkVirtualApplianceConnection": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualApplianceConnectionProperties", + "description": "Properties of the express route connection." + }, + "name": { + "type": "string", + "description": "The name of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NetworkVirtualApplianceConnection resource." + }, + "NetworkVirtualApplianceConnectionList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceConnection" + }, + "description": "The list of NetworkVirtualAppliance connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "NetworkVirtualApplianceConnection list." + }, + "ListVirtualHubBgpConnectionResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpConnection" + }, + "description": "The list of VirtualHubBgpConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "VirtualHubBgpConnections list." + }, + "ListVirtualHubIpConfigurationResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubIpConfiguration" + }, + "description": "The list of VirtualHubIpConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "VirtualHubIpConfigurations list." + }, + "RoutingConfiguration": { + "description": "Routing Configuration indicating the associated and propagated route tables for this connection.", + "properties": { + "associatedRouteTable": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id RouteTable associated with this RoutingConfiguration." + }, + "propagatedRouteTables": { + "$ref": "#/definitions/PropagatedRouteTable", + "description": "The list of RouteTables to advertise the routes to." + }, + "vnetRoutes": { + "$ref": "#/definitions/VnetRoute", + "description": "List of routes that control routing from VirtualHub into a virtual network connection." + }, + "inboundRouteMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes." + }, + "outboundRouteMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes." + } + } + }, + "PropagatedRouteTable": { + "description": "The list of RouteTables to advertise the routes to.", + "properties": { + "labels": { + "type": "array", + "description": "The list of labels.", + "items": { + "type": "string" + } + }, + "ids": { + "type": "array", + "description": "The list of resource ids of all the RouteTables.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + } + } + }, + "VnetRoute": { + "description": "List of routes that control routing from VirtualHub into a virtual network connection.", + "properties": { + "staticRoutesConfig": { + "$ref": "#/definitions/StaticRoutesConfig", + "description": "Configuration for static routes on this HubVnetConnection." + }, + "staticRoutes": { + "type": "array", + "description": "List of all Static Routes.", + "items": { + "$ref": "#/definitions/StaticRoute" + } + }, + "bgpConnections": { + "type": "array", + "readOnly": true, + "description": "The list of references to HubBgpConnection objects.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + } + } + }, + "StaticRoutesConfig": { + "description": "Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection.", + "type": "object", + "properties": { + "propagateStaticRoutes": { + "description": "Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to.", + "type": "boolean", + "readOnly": true + }, + "vnetLocalRouteOverrideCriteria": { + "description": "Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke.", + "$ref": "#/definitions/VnetLocalRouteOverrideCriteria" + } + } + }, + "StaticRoute": { + "description": "List of all Static Routes.", + "properties": { + "name": { + "type": "string", + "description": "The name of the StaticRoute that is unique within a VnetRoute." + }, + "addressPrefixes": { + "type": "array", + "description": "List of all address prefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "The ip address of the next hop." + } + } + }, + "VirtualHubEffectiveRouteList": { + "description": "EffectiveRoutes List.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHubEffectiveRoute" + }, + "description": "The list of effective routes configured on the virtual hub or the specified resource." + } + } + }, + "VirtualHubEffectiveRoute": { + "description": "The effective route configured on the virtual hub or specified resource.", + "properties": { + "addressPrefixes": { + "description": "The list of address prefixes.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextHops": { + "description": "The list of next hops.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextHopType": { + "description": "The type of the next hop.", + "type": "string" + }, + "asPath": { + "description": "The ASPath of this route.", + "type": "string" + }, + "routeOrigin": { + "description": "The origin of this route.", + "type": "string" + } + } + }, + "EffectiveRoutesParameters": { + "description": "The parameters specifying the resource whose effective routes are being requested.", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource whose effective routes are being requested." + }, + "virtualWanResourceType": { + "type": "string", + "description": "The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + }, + "EffectiveRouteMapRouteList": { + "description": "EffectiveRouteMapRoute List.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRouteMapRoute" + }, + "description": "The list of Effective RouteMap Routes configured on the connection resource.", + "x-ms-identifiers": [] + } + } + }, + "EffectiveRouteMapRoute": { + "description": "The effective RouteMap route configured on the connection resource.", + "type": "object", + "properties": { + "prefix": { + "description": "The address prefix of the route.", + "type": "string" + }, + "bgpCommunities": { + "description": "BGP communities of the route.", + "type": "string" + }, + "asPath": { + "description": "The ASPath of this route.", + "type": "string" + } + } + }, + "GetInboundRoutesParameters": { + "description": "The parameters specifying the connection resource whose inbound routes are being requested.", + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "description": "The connection resource whose inbound routes are being requested." + }, + "connectionType": { + "type": "string", + "description": "The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + }, + "GetOutboundRoutesParameters": { + "description": "The parameters specifying the connection resource whose outbound routes are being requested.", + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "description": "The connection resource whose outbound routes are being requested." + }, + "connectionType": { + "type": "string", + "description": "The type of the specified connection resource like ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + }, + "O365PolicyProperties": { + "properties": { + "breakOutCategories": { + "readOnly": false, + "description": "Office365 breakout categories.", + "$ref": "#/definitions/O365BreakOutCategoryPolicies" + } + }, + "description": "The Office365 breakout policy." + }, + "O365BreakOutCategoryPolicies": { + "properties": { + "allow": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control allow category." + }, + "optimize": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control optimize category." + }, + "default": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control default category." + } + }, + "description": "Office365 breakout categories." + }, + "ListRoutingIntentResult": { + "description": "List of the routing intent result and a URL nextLink to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoutingIntent" + }, + "description": "List of RoutingIntent resource." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "RoutingIntent": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutingIntentProperties", + "description": "Properties of the RoutingIntent resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The routing intent child resource of a Virtual hub.", + "type": "object" + }, + "RoutingIntentProperties": { + "properties": { + "routingPolicies": { + "type": "array", + "description": "List of routing policies.", + "readOnly": false, + "items": { + "$ref": "#/definitions/RoutingPolicy" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RoutingIntent resource." + } + }, + "description": "The properties of a RoutingIntent resource.", + "type": "object" + }, + "RoutingPolicy": { + "required": [ + "name", + "destinations", + "nextHop" + ], + "properties": { + "name": { + "type": "string", + "description": "The unique name for the routing policy." + }, + "destinations": { + "type": "array", + "description": "List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic).", + "items": { + "type": "string" + } + }, + "nextHop": { + "type": "string", + "description": "The next hop resource id on which this routing policy is applicable to." + } + }, + "description": "The routing policy object used in a RoutingIntent resource.", + "type": "object" + }, + "RouteMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteMapProperties", + "description": "Properties of the RouteMap resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource id." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The RouteMap child resource of a Virtual hub.", + "type": "object" + }, + "ListRouteMapsResult": { + "description": "List of RouteMaps and a URL nextLink to get the next set of results.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteMap" + }, + "description": "List of RouteMaps." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "RouteMapProperties": { + "properties": { + "associatedInboundConnections": { + "type": "array", + "description": "List of connections which have this RoutMap associated for inbound traffic.", + "items": { + "type": "string" + } + }, + "associatedOutboundConnections": { + "type": "array", + "description": "List of connections which have this RoutMap associated for outbound traffic.", + "items": { + "type": "string" + } + }, + "rules": { + "type": "array", + "description": "List of RouteMap rules to be applied.", + "items": { + "$ref": "#/definitions/RouteMapRule" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RouteMap resource." + } + }, + "description": "Properties of RouteMap resource", + "type": "object" + }, + "RouteMapRule": { + "properties": { + "name": { + "type": "string", + "description": "The unique name for the rule." + }, + "matchCriteria": { + "type": "array", + "description": "List of matching criterion which will be applied to traffic.", + "items": { + "$ref": "#/definitions/Criterion" + }, + "x-ms-identifiers": [] + }, + "actions": { + "type": "array", + "description": "List of actions which will be applied on a match.", + "items": { + "$ref": "#/definitions/Action" + }, + "x-ms-identifiers": [] + }, + "nextStepIfMatched": { + "$ref": "#/definitions/NextStep", + "description": "Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'." + } + }, + "description": "A RouteMap Rule.", + "type": "object" + }, + "Criterion": { + "properties": { + "routePrefix": { + "type": "array", + "description": "List of route prefixes which this criteria matches.", + "items": { + "type": "string" + } + }, + "community": { + "type": "array", + "description": "List of BGP communities which this criteria matches.", + "items": { + "type": "string" + } + }, + "asPath": { + "type": "array", + "description": "List of AS paths which this criteria matches.", + "items": { + "type": "string" + } + }, + "matchCondition": { + "$ref": "#/definitions/RouteMapMatchCondition", + "description": "Match condition to apply RouteMap rules." + } + }, + "description": "A matching criteria which matches routes based on route prefix, community, and AS path.", + "type": "object" + }, + "Action": { + "properties": { + "type": { + "$ref": "#/definitions/RouteMapActionType", + "description": "Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.'" + }, + "parameters": { + "type": "array", + "description": "List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added", + "items": { + "$ref": "#/definitions/Parameter" + }, + "x-ms-identifiers": [] + } + }, + "description": "Action to be taken on a route matching a RouteMap criterion.", + "type": "object" + }, + "Parameter": { + "properties": { + "routePrefix": { + "type": "array", + "description": "List of route prefixes.", + "items": { + "type": "string" + } + }, + "community": { + "type": "array", + "description": "List of BGP communities.", + "items": { + "type": "string" + } + }, + "asPath": { + "type": "array", + "description": "List of AS paths.", + "items": { + "type": "string" + } + } + }, + "description": "Parameters for an Action.", + "type": "object" + }, + "RouteMapMatchCondition": { + "type": "string", + "description": "Match condition to apply RouteMap rules.", + "enum": [ + "Unknown", + "Contains", + "Equals", + "NotContains", + "NotEquals" + ], + "x-ms-enum": { + "name": "RouteMapMatchCondition", + "modelAsString": true + } + }, + "NextStep": { + "type": "string", + "description": "Supported next step behaviors after a rule is applied to a matched route", + "enum": [ + "Unknown", + "Continue", + "Terminate" + ], + "x-ms-enum": { + "name": "NextStep", + "modelAsString": true + } + }, + "RouteMapActionType": { + "type": "string", + "description": "Kind of actions which can be taken on a matched route. Add, Replace, Remove refer to parameters on the route, like community or prefix", + "enum": [ + "Unknown", + "Remove", + "Add", + "Replace", + "Drop" + ], + "x-ms-enum": { + "name": "RouteMapActionType", + "modelAsString": true + } + }, + "VnetLocalRouteOverrideCriteria": { + "type": "string", + "description": "Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke vnet.", + "enum": [ + "Contains", + "Equal" + ], + "x-ms-enum": { + "name": "VnetLocalRouteOverrideCriteria", + "modelAsString": true + } + }, + "SharedKeyProperties": { + "type": "object", + "properties": { + "sharedKey": { + "type": "string", + "x-ms-secret": true, + "description": "The value of the shared key for the vpn link connection." + }, + "sharedKeyLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The length of the shared key for the vpn link connection." + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the SharedKey resource." + } + }, + "description": "Parameters for SharedKey." + }, + "ConnectionSharedKeyResult": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SharedKeyProperties", + "description": "Properties of the shared key." + }, + "id": { + "type": "string", + "description": "The identifier of the shared key for a vpn link connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SharedKey Resource ." + }, + "ConnectionSharedKeyResultList": { + "description": "The list of shared keys for the vpn link connection. It should only contain one shared key for each vpn link connection.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionSharedKeyResult" + }, + "description": "List of SharedKeys." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/vmssNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/vmssNetworkInterface.json new file mode 100644 index 000000000000..89562aa3062c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/vmssNetworkInterface.json @@ -0,0 +1,374 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-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/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetVMNetworkInterfaces", + "description": "Gets information about all network interfaces in a virtual machine in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set vm network interfaces": { + "$ref": "./examples/VmssVmNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetNetworkInterfaces", + "description": "Gets all network interfaces in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interfaces": { + "$ref": "./examples/VmssNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", + "description": "Get the specified network interface in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { + "$ref": "./examples/VmssNetworkInterfaceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetIpConfigurations", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of resulting NetworkInterfaceIPConfigurations resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interface ip configurations": { + "$ref": "./examples/VmssNetworkInterfaceIpConfigList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetIpConfiguration", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterfaceIPConfiguration resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { + "$ref": "./examples/VmssNetworkInterfaceIpConfigGet.json" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/vmssPublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/vmssPublicIpAddress.json new file mode 100644 index 000000000000..d100152e7711 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/vmssPublicIpAddress.json @@ -0,0 +1,241 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-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/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", + "description": "Gets information about all public IP addresses on a virtual machine scale set level.", + "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 virtual machine scale set." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { + "$ref": "./examples/VmssPublicIpListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", + "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { + "$ref": "./examples/VmssVmPublicIpList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", + "description": "Get the specified public IP address in a virtual machine scale set.", + "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 virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { + "$ref": "./examples/VmssPublicIpGet.json" + } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/webapplicationfirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/webapplicationfirewall.json new file mode 100644 index 000000000000..8d6771d8b51d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2025-03-01/webapplicationfirewall.json @@ -0,0 +1,1181 @@ +{ + "swagger": "2.0", + "info": { + "version": "2025-03-01", + "title": "WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules." + }, + "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.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "WebApplicationFirewallPolicies_List", + "x-ms-examples": { + "Lists all WAF policies in a resource group": { + "$ref": "./examples/WafListPolicies.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Gets all the WAF policies in a subscription.", + "operationId": "WebApplicationFirewallPolicies_ListAll", + "x-ms-examples": { + "Lists all WAF policies in a subscription": { + "$ref": "./examples/WafListAllPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_Get", + "x-ms-examples": { + "Gets a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Creates or update policy with specified rule set name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy.", + "operationId": "WebApplicationFirewallPolicies_Delete", + "x-ms-examples": { + "Deletes a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/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 policy was not found." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "WebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebApplicationFirewallPolicyPropertiesFormat", + "description": "Properties of the web application firewall policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "WebApplicationFirewallPolicyPropertiesFormat": { + "description": "Defines web application firewall policy properties.", + "required": [ + "managedRules" + ], + "properties": { + "policySettings": { + "description": "The PolicySettings for policy.", + "$ref": "#/definitions/PolicySettings" + }, + "customRules": { + "description": "The custom rules inside the policy.", + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallCustomRule" + } + }, + "applicationGateways": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGateway" + }, + "description": "A collection of references to application gateways." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall policy resource." + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "type": "string", + "description": "Resource status of the policy.", + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallPolicyResourceState", + "modelAsString": true + } + }, + "managedRules": { + "description": "Describes the managedRules structure.", + "$ref": "#/definitions/ManagedRulesDefinition" + }, + "httpListeners": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway http listeners." + }, + "pathBasedRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway path rules." + }, + "applicationGatewayForContainers": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayForContainersReferenceDefinition" + }, + "description": "A collection of references to application gateway for containers." + } + } + }, + "WebApplicationFirewallPolicyListResult": { + "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + }, + "description": "List of WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "ManagedRulesDefinition": { + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "required": [ + "managedRuleSets" + ], + "properties": { + "exceptions": { + "type": "array", + "items": { + "$ref": "#/definitions/ExceptionEntry" + }, + "description": "The exceptions that are applied on the policy." + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/OwaspCrsExclusionEntry" + }, + "description": "The Exclusions that are applied on the policy." + }, + "managedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the policy." + } + } + }, + "PolicySettings": { + "description": "Defines contents of a web application firewall global configuration.", + "properties": { + "state": { + "description": "The state of the policy.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "The mode of the policy.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMode", + "modelAsString": true + } + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether to allow WAF to check request Body." + }, + "requestBodyInspectLimitInKB": { + "type": "integer", + "format": "int32", + "description": "Max inspection limit in KB for request body inspection for WAF." + }, + "requestBodyEnforcement": { + "type": "boolean", + "default": true, + "description": "Whether allow WAF to enforce request body limits." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadEnforcement": { + "type": "boolean", + "default": true, + "description": "Whether allow WAF to enforce file upload limits." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + }, + "customBlockResponseStatusCode": { + "description": "If the action type is block, customer can override the response status code.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "customBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "maxLength": 32768 + }, + "logScrubbing": { + "description": "To scrub sensitive log fields", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "The rules that are applied to the logs for scrubbing." + } + } + }, + "jsChallengeCookieExpirationInMins": { + "description": "Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes.", + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 1440 + } + } + }, + "WebApplicationFirewallCustomRule": { + "description": "Defines contents of a web application rule.", + "required": [ + "priority", + "ruleType", + "matchConditions", + "action" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is unique within a policy. This name can be used to access the resource.", + "maxLength": 128 + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "priority": { + "description": "Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", + "type": "integer" + }, + "state": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallState", + "modelAsString": true + } + }, + "rateLimitDuration": { + "type": "string", + "description": "Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule.", + "enum": [ + "OneMin", + "FiveMins" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallRateLimitDuration", + "modelAsString": true + } + }, + "rateLimitThreshold": { + "description": "Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1", + "type": "integer", + "format": "int32" + }, + "ruleType": { + "description": "The rule type.", + "type": "string", + "enum": [ + "MatchRule", + "RateLimitRule", + "Invalid" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallRuleType", + "modelAsString": true + } + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + } + }, + "groupByUserSession": { + "description": "List of user session identifier group by clauses.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/GroupByUserSession" + } + }, + "action": { + "description": "Type of Actions.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "JSChallenge" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallAction", + "modelAsString": true + } + } + } + }, + "Transform": { + "description": "Transforms applied before matching.", + "type": "string", + "enum": [ + "Uppercase", + "Lowercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls", + "HtmlEntityDecode" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallTransform", + "modelAsString": true + } + }, + "MatchVariable": { + "description": "Define match variables.", + "required": [ + "variableName" + ], + "properties": { + "variableName": { + "description": "Match Variable.", + "type": "string", + "enum": [ + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeaders", + "RequestBody", + "RequestCookies" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "The selector of match variable.", + "type": "string" + } + } + }, + "MatchCondition": { + "description": "Define match conditions.", + "required": [ + "matchVariables", + "operator", + "matchValues" + ], + "properties": { + "matchVariables": { + "description": "List of match variables.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchVariable" + } + }, + "operator": { + "description": "The operator to be matched.", + "type": "string", + "enum": [ + "IPMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "Regex", + "GeoMatch", + "Any" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallOperator", + "modelAsString": true + } + }, + "negationConditon": { + "description": "Whether this is negate condition or not.", + "type": "boolean" + }, + "matchValues": { + "description": "Match value.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + } + } + } + }, + "GroupByVariable": { + "type": "object", + "description": "Define user session group by clause variables.", + "required": [ + "variableName" + ], + "properties": { + "variableName": { + "description": "User Session clause variable.", + "type": "string", + "enum": [ + "ClientAddr", + "GeoLocation", + "None", + "ClientAddrXFFHeader", + "GeoLocationXFFHeader" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallUserSessionVariable", + "modelAsString": true + } + } + } + }, + "GroupByUserSession": { + "type": "object", + "description": "Define user session identifier group by clauses.", + "required": [ + "groupByVariables" + ], + "properties": { + "groupByVariables": { + "description": "List of group by clause variables.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/GroupByVariable" + } + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "ruleGroupOverrides": { + "description": "Defines the rule group overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + } + }, + "computedDisabledRules": { + "readOnly": true, + "description": "Stores the final list of disabled rule groups", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetRuleGroup" + } + } + } + }, + "ManagedRuleGroupOverride": { + "type": "object", + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "The managed rule group to override.", + "type": "string" + }, + "rules": { + "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + } + } + } + }, + "ManagedRuleOverride": { + "type": "object", + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "state": { + "description": "The state of the managed rule. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + }, + "sensitivity": { + "description": "Describes the override sensitivity to be applied when rule matches.", + "$ref": "#/definitions/SensitivityType" + } + } + }, + "ManagedRuleSetRuleGroup": { + "description": "Defines a managed rule set rule group", + "type": "object", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Name of the rule group", + "type": "string" + }, + "rules": { + "description": "List of rules within the rule group", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExclusionManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set for Exclusions.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "ruleGroups": { + "description": "Defines the rule groups to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRuleGroup" + } + } + } + }, + "ExclusionManagedRuleGroup": { + "type": "object", + "description": "Defines a managed rule group to use for exclusion.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "The managed rule group for exclusion.", + "type": "string" + }, + "rules": { + "description": "List of rules that will be excluded. If none specified, all rules in the group will be excluded.", + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRule" + } + } + } + }, + "ExclusionManagedRule": { + "type": "object", + "description": "Defines a managed rule to use for exclusion.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + } + } + }, + "OwaspCrsExclusionEntry": { + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "RequestArgNames", + "RequestHeaderKeys", + "RequestHeaderValues", + "RequestCookieKeys", + "RequestCookieValues", + "RequestArgKeys", + "RequestArgValues" + ], + "description": "The variable to be excluded.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntrySelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + }, + "exclusionManagedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the exclusion." + } + } + }, + "ExceptionEntry": { + "required": [ + "matchVariable", + "valueMatchOperator" + ], + "description": "Adds exception to allow a request when the condition is satisfied.", + "type": "object", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestURI", + "RemoteAddr", + "RequestHeader" + ], + "description": "The variable on which we evaluate the exception condition", + "x-ms-enum": { + "name": "ExceptionEntryMatchVariable", + "modelAsString": true + } + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed values for the matchVariable" + }, + "valueMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "IPMatch" + ], + "x-ms-enum": { + "name": "ExceptionEntryValueMatchOperator", + "modelAsString": true + }, + "description": "Operates on the allowed values for the matchVariable" + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith" + ], + "description": "When the matchVariable points to a key-value pair (e.g, RequestHeader), this operates on the selector", + "x-ms-enum": { + "name": "ExceptionEntrySelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When the matchVariable points to a key-value pair (e.g, RequestHeader), this identifies the key." + }, + "exceptionManagedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ExclusionManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the exception." + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "AnomalyScoring", + "Allow", + "Block", + "Log", + "JSChallenge" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + "SensitivityType": { + "description": "Defines the sensitivity for the rule.", + "type": "string", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "SensitivityType", + "modelAsString": true + } + }, + "WebApplicationFirewallScrubbingRules": { + "description": "Allow certain variables to be scrubbed on WAF logs", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "RequestArgNames", + "RequestPostArgNames", + "RequestJSONArgNames", + "RequestIPAddress" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of log scrubbing rule. Default value is Enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + }, + "ApplicationGatewayForContainersReferenceDefinition": { + "type": "object", + "description": "Defines an application gateway for containers reference.", + "required": [ + "id" + ], + "properties": { + "id": { + "description": "Resource Id of the application gateway for containers.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ServiceNetworking/trafficControllers" + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index acfde133cd95..8720a7a788b6 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -28,7 +28,119 @@ These are the global settings for the Network API. title: NetworkManagementClient description: Network Client openapi-type: arm -tag: package-2025-01-01 +tag: package-2025-03-01 +``` + +### Tag: package-2025-03-01 + +These settings apply only when `--tag=package-2025-03-01` is specified on the command line. + +```yaml $(tag) == 'package-2025-03-01' +input-file: + - Microsoft.Network/stable/2025-03-01/applicationGateway.json + - Microsoft.Network/stable/2025-03-01/applicationGatewayWafDynamicManifests.json + - Microsoft.Network/stable/2025-03-01/applicationSecurityGroup.json + - Microsoft.Network/stable/2025-03-01/availableDelegations.json + - Microsoft.Network/stable/2025-03-01/availableServiceAliases.json + - Microsoft.Network/stable/2025-03-01/azureFirewall.json + - Microsoft.Network/stable/2025-03-01/azureFirewallFqdnTag.json + - Microsoft.Network/stable/2025-03-01/azureWebCategory.json + - Microsoft.Network/stable/2025-03-01/bastionHost.json + - Microsoft.Network/stable/2025-03-01/checkDnsAvailability.json + - Microsoft.Network/stable/2025-03-01/cloudServiceNetworkInterface.json + - Microsoft.Network/stable/2025-03-01/cloudServicePublicIpAddress.json + - Microsoft.Network/stable/2025-03-01/cloudServiceSwap.json + - Microsoft.Network/stable/2025-03-01/customIpPrefix.json + - Microsoft.Network/stable/2025-03-01/ddosCustomPolicy.json + - Microsoft.Network/stable/2025-03-01/ddosProtectionPlan.json + - Microsoft.Network/stable/2025-03-01/dscpConfiguration.json + - Microsoft.Network/stable/2025-03-01/endpointService.json + - Microsoft.Network/stable/2025-03-01/expressRouteCircuit.json + - Microsoft.Network/stable/2025-03-01/expressRouteCrossConnection.json + - Microsoft.Network/stable/2025-03-01/expressRoutePort.json + - Microsoft.Network/stable/2025-03-01/expressRouteProviderPort.json + - Microsoft.Network/stable/2025-03-01/firewallPolicy.json + - Microsoft.Network/stable/2025-03-01/ipAddressManager.json + - Microsoft.Network/stable/2025-03-01/ipAllocation.json + - Microsoft.Network/stable/2025-03-01/ipGroups.json + - Microsoft.Network/stable/2025-03-01/loadBalancer.json + - Microsoft.Network/stable/2025-03-01/natGateway.json + - Microsoft.Network/stable/2025-03-01/network.json + - Microsoft.Network/stable/2025-03-01/networkInterface.json + - Microsoft.Network/stable/2025-03-01/networkManager.json + - Microsoft.Network/stable/2025-03-01/networkManagerActiveConfiguration.json + - Microsoft.Network/stable/2025-03-01/networkManagerConnection.json + - Microsoft.Network/stable/2025-03-01/networkManagerConnectivityConfiguration.json + - Microsoft.Network/stable/2025-03-01/networkManagerEffectiveConfiguration.json + - Microsoft.Network/stable/2025-03-01/networkManagerGroup.json + - Microsoft.Network/stable/2025-03-01/networkManagerRoutingConfiguration.json + - Microsoft.Network/stable/2025-03-01/networkManagerScopeConnection.json + - Microsoft.Network/stable/2025-03-01/networkManagerSecurityAdminConfiguration.json + - Microsoft.Network/stable/2025-03-01/networkManagerSecurityUserConfiguration.json + - Microsoft.Network/stable/2025-03-01/networkProfile.json + - Microsoft.Network/stable/2025-03-01/networkSecurityGroup.json + - Microsoft.Network/stable/2025-03-01/networkSecurityPerimeter.json + - Microsoft.Network/stable/2025-03-01/networkVerifier.json + - Microsoft.Network/stable/2025-03-01/networkVirtualAppliance.json + - Microsoft.Network/stable/2025-03-01/networkWatcher.json + - Microsoft.Network/stable/2025-03-01/operation.json + - Microsoft.Network/stable/2025-03-01/privateEndpoint.json + - Microsoft.Network/stable/2025-03-01/privateLinkService.json + - Microsoft.Network/stable/2025-03-01/publicIpAddress.json + - Microsoft.Network/stable/2025-03-01/publicIpPrefix.json + - Microsoft.Network/stable/2025-03-01/routeFilter.json + - Microsoft.Network/stable/2025-03-01/routeTable.json + - Microsoft.Network/stable/2025-03-01/securityPartnerProvider.json + - Microsoft.Network/stable/2025-03-01/serviceCommunity.json + - Microsoft.Network/stable/2025-03-01/serviceEndpointPolicy.json + - Microsoft.Network/stable/2025-03-01/serviceTags.json + - Microsoft.Network/stable/2025-03-01/usage.json + - Microsoft.Network/stable/2025-03-01/virtualNetwork.json + - Microsoft.Network/stable/2025-03-01/virtualNetworkGateway.json + - Microsoft.Network/stable/2025-03-01/virtualNetworkTap.json + - Microsoft.Network/stable/2025-03-01/virtualRouter.json + - Microsoft.Network/stable/2025-03-01/virtualWan.json + - Microsoft.Network/stable/2025-03-01/vmssNetworkInterface.json + - Microsoft.Network/stable/2025-03-01/vmssPublicIpAddress.json + - Microsoft.Network/stable/2025-03-01/webapplicationfirewall.json +suppressions: + - code: PutResponseCodes + reason: Required for multiple response codes. Reviewed by ARM team. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations/{associationName}"].put + - code: DeleteResponseCodes + reason: Required for multiple response codes. Reviewed by ARM team. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations/{associationName}"].delete + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/linkReferences/{linkReferenceName}"].delete + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/links/{linkName}"].delete + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}"].delete + - code: PatchIdentityProperty + reason: False alarm. + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}"].patch.parameters[2] + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}"].patch.parameters[3] + - code: SystemDataDefinitionsCommonTypes + from: networkVerifier.json + reason: False alarm for common type errors. + - code: SystemDataDefinitionsCommonTypes + from: network.json + reason: False alarm. +directive: + - from: specification/common-types/resource-management/v6/types.json + where: "$.definitions.ProxyResource" + transform: > + $["x-ms-client-name"] = "SecurityPerimeterProxyResource" + + - from: specification/common-types/resource-management/v6/types.json + where: "$.definitions.Resource" + transform: > + $["x-ms-client-name"] = "SecurityPerimeterResource" + + - from: specification/common-types/resource-management/v6/types.json + where: "$.definitions.systemData" + transform: > + $["x-ms-client-name"] = "SecurityPerimeterSystemData" ``` ### Tag: package-2025-01-01 diff --git a/specification/network/resource-manager/sdk-suppressions.yaml b/specification/network/resource-manager/sdk-suppressions.yaml index 50aa4279b5b5..82bdf7d76d0b 100644 --- a/specification/network/resource-manager/sdk-suppressions.yaml +++ b/specification/network/resource-manager/sdk-suppressions.yaml @@ -10,6 +10,8 @@ suppressions: - Function `*ConnectionMonitorsClient.BeginQuery` has been removed - Function `*ConnectionMonitorsClient.BeginStart` has been removed - Type of `LoadBalancerHealthPerRulePerBackendAddress.NetworkInterfaceIPConfigurationID` has been changed from `*InterfaceIPConfiguration` to `*string` + - "`ApplicationGatewayWafRuleSensitivityTypesNone` from enum `ApplicationGatewayWafRuleSensitivityTypes` has been removed" + - "`SensitivityTypeNone` from enum `SensitivityType` has been removed" azure-sdk-for-js: - package: '@azure/arm-network' breaking-changes: diff --git a/specification/newrelic/NewRelic.Management/cadl-project.yaml b/specification/newrelic/NewRelic.Management/cadl-project.yaml deleted file mode 100644 index 9c1dbbb3e2d9..000000000000 --- a/specification/newrelic/NewRelic.Management/cadl-project.yaml +++ /dev/null @@ -1,6 +0,0 @@ -emit: - - "@azure-tools/cadl-autorest" -options: - "@azure-tools/cadl-autorest": - azure-resource-provider-folder: ./swagger/newrelic/resource-manager - examples-directory: ./examples \ No newline at end of file diff --git a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json deleted file mode 100644 index 4a2433e12609..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MaximumSet_Gen.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "Accounts_List", - "title": "Accounts_List_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "ycdsgeiitvxcd", - "properties": { - "organizationId": "wvdclwi", - "accountId": "igmdjq", - "accountName": "accname", - "region": "xnsylopqwcggudcln" - } - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json deleted file mode 100644 index f7e237017bd9..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Accounts_List_MinimumSet_Gen.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "operationId": "Accounts_List", - "title": "Accounts_List_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "ycdsgeiitvxcd" - } - ] - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json deleted file mode 100644 index e49241329e0a..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json +++ /dev/null @@ -1,203 +0,0 @@ -{ - "operationId": "Monitors_CreateOrUpdate", - "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", - "monitorName": "cdlymktqw", - "resource": { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "ingestionKey": "wltnimmhqt", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "type": "None", - "userAssignedIdentities": { - "key8903": {} - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k" - } - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - }, - "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, - "body": { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json deleted file mode 100644 index 844180915106..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MaximumSet_Gen.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "Monitors_Delete", - "title": "Monitors_Delete_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json deleted file mode 100644 index ed150f60437e..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Delete_MinimumSet_Gen.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "Monitors_Delete", - "title": "Monitors_Delete_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json deleted file mode 100644 index 1ac93fd575bf..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MaximumSet_Gen.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "Monitors_GetMetricRules", - "title": "Monitors_GetMetricRules_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", - "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", - "request": { - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" - } - }, - "responses": { - "200": { - "body": { - "sendMetrics": "Enabled", - "userEmail": "test@testing.com", - "filteringTags": [ - { - "name": "qnvixg", - "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge", - "action": "Include" - } - ] - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json deleted file mode 100644 index 197e8d04d4a1..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Get_MaximumSet_Gen.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "operationId": "Monitors_Get", - "title": "Monitors_Get_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", - "monitorName": "cdlymktqw" - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json deleted file mode 100644 index 4c6a891b3a76..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "operationId": "Monitors_ListByResourceGroup", - "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json deleted file mode 100644 index c03b1c416021..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListBySubscription_MaximumSet_Gen.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "operationId": "Monitors_ListBySubscription", - "title": "Monitors_ListBySubscription_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json deleted file mode 100644 index 820cb2ae9bb5..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MaximumSet_Gen.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "operationId": "Monitors_ListHosts", - "title": "Monitors_ListHosts_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "request": { - "vmIds": [ - "xzphvxvfmvjrnsgyns" - ], - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "vmId": "gwyoa", - "agentVersion": "tbinulnoozxnbr", - "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz" - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json deleted file mode 100644 index e170c607db4b..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListHosts_MinimumSet_Gen.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "operationId": "Monitors_ListHosts", - "title": "Monitors_ListHosts_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "request": { - "vmIds": [ - "xzphvxvfmvjrnsgyns" - ], - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" - } - }, - "responses": { - "200": { - "body": { - "value": [], - "nextLink": null - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json deleted file mode 100644 index 636e66cfc49b..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "operationId": "Monitors_ListMonitoredResources", - "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "qmtrcoxuctyphc", - "sendingMetrics": "Enabled", - "reasonForMetricsStatus": "k", - "sendingLogs": "Enabled", - "reasonForLogsStatus": "agzxviwuxgr" - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json deleted file mode 100644 index f145a401f995..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "operationId": "Monitors_ListMonitoredResources", - "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": { - "body": { - "value": [], - "nextLink": null - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json deleted file mode 100644 index 96b311607fe5..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MaximumSet_Gen.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "operationId": "Monitors_SwitchBilling", - "title": "Monitors_SwitchBilling_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", - "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", - "request": { - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", - "organizationId": "k", - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json deleted file mode 100644 index 6e22dc73bca6..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_Update_MaximumSet_Gen.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "operationId": "Monitors_Update", - "title": "Monitors_Update_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", - "monitorName": "cdlymktqw", - "properties": { - "identity": { - "type": "None", - "userAssignedIdentities": { - "key8903": {} - } - }, - "tags": { - "key164": "jqakdrrmmyzytqu" - }, - "properties": { - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "ingestionKey": "wltnimmhqt", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", - "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", - "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", - "accountInfo": { - "accountId": "xhqmg", - "region": "ljcf" - }, - "organizationInfo": { - "organizationId": "k" - }, - "singleSignOnProperties": { - "singleSignOnState": "Initial", - "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" - }, - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } - } - }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", - "systemData": { - "createdBy": "pcdjzdldbwsdlfi", - "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", - "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" - } - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json deleted file mode 100644 index 7c53ae5e36d7..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MaximumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Monitors_VmHostPayload", - "title": "Monitors_VmHostPayload_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": { - "body": { - "ingestionKey": "ltqewhfexphvqgttoevaywrl" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json deleted file mode 100644 index 5df94de4f3cd..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_VmHostPayload_MinimumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Monitors_VmHostPayload", - "title": "Monitors_VmHostPayload_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": { - "body": { - "ingestionKey": "ltqewhfexphvqgttoevaywrl" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Operations_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Operations_List_MaximumSet_Gen.json deleted file mode 100644 index 64494322c06c..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Operations_List_MaximumSet_Gen.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "operationId": "Operations_List", - "title": "Operations_List_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "zhlrjcljiysnufaerhpzg", - "isDataAction": true, - "display": { - "provider": "v", - "resource": "w", - "operation": "ybyzweygkffbydgaowg", - "description": "sekhimcuecttketh" - }, - "origin": "user", - "actionType": "Internal" - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Operations_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Operations_List_MinimumSet_Gen.json deleted file mode 100644 index 9f1b43954d2f..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Operations_List_MinimumSet_Gen.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "operationId": "Operations_List", - "title": "Operations_List_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview" - }, - "responses": { - "200": { - "body": {} - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json deleted file mode 100644 index 7d51c73537a1..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MaximumSet_Gen.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "operationId": "Organizations_List", - "title": "Organizations_List_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "ycdsgeiitvxcd", - "properties": { - "organizationId": "tjmcifofzirili", - "organizationName": "orgname", - "billingSource": "AZURE" - } - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json deleted file mode 100644 index c5f56aebbda9..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Organizations_List_MinimumSet_Gen.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "operationId": "Organizations_List", - "title": "Organizations_List_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" - }, - "responses": { - "200": { - "body": { - "value": [] - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json deleted file mode 100644 index d98c6f874c9a..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Plans_List_MaximumSet_Gen.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "operationId": "Plans_List", - "title": "Plans_List_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "accountId": "pwuxgvrmkk", - "organizationId": "hilawwjz" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "ycdsgeiitvxcd", - "properties": { - "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", - "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - } - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json deleted file mode 100644 index 7881d45caeb8..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/Plans_List_MinimumSet_Gen.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "operationId": "Plans_List", - "title": "Plans_List_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "organizationId": "hilawwjz" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "qmtrcoxuctyphc", - "properties": { - "orgCreationSource": "NEWRELIC" - } - } - ] - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json deleted file mode 100644 index 5aca2dfc466d..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json +++ /dev/null @@ -1,121 +0,0 @@ -{ - "operationId": "TagRules_CreateOrUpdate", - "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", - "resource": { - "properties": { - "provisioningState": "Accepted", - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "userEmail": "test@testing.com", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - }, - "id": "ycdsgeiitvxcd", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", - "systemData": { - "createdBy": "wqrkemruqrvclsoevdftfeof", - "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", - "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" - } - } - }, - "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, - "body": { - "properties": { - "provisioningState": "Accepted", - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - }, - "id": "ycdsgeiitvxcd", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", - "systemData": { - "createdBy": "wqrkemruqrvclsoevdftfeof", - "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", - "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" - } - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json deleted file mode 100644 index a3b33401e6d6..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "operationId": "TagRules_CreateOrUpdate", - "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", - "resource": { - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "properties": {}, - "id": "ycdsgeiitvxcd" - } - }, - "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, - "body": { - "properties": {}, - "id": "ycdsgeiitvxcd" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json deleted file mode 100644 index d2c5b3338bea..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MaximumSet_Gen.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "TagRules_Delete", - "title": "TagRules_Delete_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json deleted file mode 100644 index ece4c4d2d6f7..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Delete_MinimumSet_Gen.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "TagRules_Delete", - "title": "TagRules_Delete_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - } - }, - "204": {} - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json deleted file mode 100644 index 4c3da6213c04..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MaximumSet_Gen.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "operationId": "TagRules_Get", - "title": "TagRules_Get_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "userEmail": "test@testing.com", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - }, - "id": "ycdsgeiitvxcd", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", - "systemData": { - "createdBy": "wqrkemruqrvclsoevdftfeof", - "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", - "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" - } - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json deleted file mode 100644 index 7e94172a562e..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Get_MinimumSet_Gen.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "operationId": "TagRules_Get", - "title": "TagRules_Get_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" - }, - "responses": { - "200": { - "body": { - "properties": {}, - "id": "ycdsgeiitvxcd" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json deleted file mode 100644 index e32af021e1b3..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "operationId": "TagRules_ListByNewRelicMonitorResource", - "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "provisioningState": "Accepted", - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "userEmail": "test@testing.com", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - }, - "id": "ycdsgeiitvxcd", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", - "systemData": { - "createdBy": "wqrkemruqrvclsoevdftfeof", - "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", - "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" - } - } - ], - "nextLink": "http://testlink.com" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json deleted file mode 100644 index f4b3973f91c9..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "operationId": "TagRules_ListByNewRelicMonitorResource", - "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": {}, - "id": "ycdsgeiitvxcd" - } - ] - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json deleted file mode 100644 index e309fccc33fb..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MaximumSet_Gen.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "operationId": "TagRules_Update", - "title": "TagRules_Update_MaximumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", - "properties": { - "properties": { - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "userEmail": "test@testing.com", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "provisioningState": "Accepted", - "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - }, - "metricRules": { - "userEmail": "test@testing.com", - "filteringTags": [ - { - "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" - } - ] - } - }, - "id": "ycdsgeiitvxcd", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", - "systemData": { - "createdBy": "wqrkemruqrvclsoevdftfeof", - "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", - "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" - } - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json deleted file mode 100644 index 4ce64658f2b0..000000000000 --- a/specification/newrelic/NewRelic.Management/examples/TagRules_Update_MinimumSet_Gen.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "operationId": "TagRules_Update", - "title": "TagRules_Update_MinimumSet_Gen", - "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", - "properties": {} - }, - "responses": { - "200": { - "body": { - "properties": {}, - "id": "ycdsgeiitvxcd" - } - } - } -} diff --git a/specification/newrelic/NewRelic.Management/main.cadl b/specification/newrelic/NewRelic.Management/main.cadl deleted file mode 100644 index 09ac1bb5a80c..000000000000 --- a/specification/newrelic/NewRelic.Management/main.cadl +++ /dev/null @@ -1,740 +0,0 @@ -import "@cadl-lang/rest"; -import "@cadl-lang/versioning"; -import "@azure-tools/cadl-providerhub"; -import "@azure-tools/cadl-azure-core"; -import "@azure-tools/cadl-azure-resource-manager"; - - -@armProviderNamespace -@service(#{ - title: "NewRelic.Observability", - version: "2022-07-01-preview", -}) -namespace NewRelic.Observability; - -using Azure.ResourceManager; -using Cadl.Rest; -using Cadl.Http; -using Cadl.Versioning; -using Azure.Core; - -@doc("Reusable representation of an email address") -@pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") -scalar email extends string; - -@doc("Credential string.") -@secret -scalar SecureString extends string; - -@doc("A Monitor Resource by NewRelic") -model NewRelicMonitorResource is TrackedResource { - @key("monitorName") - @segment("monitors") - @doc("Name of the Monitors resource") - @path - name: string; - ...ManagedServiceIdentity; - -} - -interface Operations extends Azure.ResourceManager.Operations {} - -@armResourceOperations -interface Monitors { - op Get is - ArmResourceRead; - - op CreateOrUpdate is - ArmResourceCreateOrUpdateAsync; - - op Update is - ArmResourcePatchSync; - - op Delete is - ArmResourceDeleteAsync; - - op ListBySubscription is ArmListBySubscription; - - op LIstByRG is ArmResourceListByParent; - - @post - @doc("List the resources currently being monitored by the NewRelic monitor resource.") - @armResourceAction(NewRelicMonitorResource) - @segment("monitoredResources") - op ListMonitoredResources( - ...ResourceInstanceParameters - ): ArmResponse | ErrorResponse; - - @post - @doc("Returns the payload that needs to be passed in the request body for installing NewRelic agent on a VM.") - @segment("vmHostPayloads") - op VMHostPayload( - ...ResourceInstanceParameters - ): ArmResponse | ErrorResponse; - - @post - @doc("List the compute vm resources currently being monitored by the NewRelic resource.") - @segment("listHosts") - op ListHosts( - ...ResourceInstanceParameters, - ...HostsGetParameter - ): ArmResponse | ErrorResponse; - - @post - @doc("List the app service resources currently being monitored by the NewRelic resource.") - @segment("listAppServices") - op ListAppServices( - ...ResourceInstanceParameters, - ...AppServicesGetParameter - ): ArmResponse | ErrorResponse; - - @post - @doc("Switches the billing for NewRelic monitor resource.") - @segment("switchBilling") - op SwitchBilling( - ...ResourceInstanceParameters, - ...SwitchBillingParameter - ): ArmResponse | ArmAcceptedResponse | void | ErrorResponse; - - @post - @doc("Get metric rules") - @segment("getMetricRules") - op getMetricRules( - ...ResourceInstanceParameters, - ...MetricsRequestParameter - ): ArmResponse | ErrorResponse; - - @post - @doc("Get metric status") - @segment("getMetricStatus") - op getMetricStatus( - ...ResourceInstanceParameters, - ...MetricsStatusRequestParameter - ): ArmResponse | ErrorResponse; -} - -interface accounts { - @doc("List all the existing accounts") - @tag("Accounts") - @route("/subscriptions/{subscriptionId}/providers/NewRelic.Observability/accounts") - op list(...ApiVersionParameter, - ...SubscriptionIdParameter, - ...UserEmailParameter, - ...LocationParameter):ArmResponse | ErrorResponse -} - -interface organizations { - @doc("List all the existing organizations") - @tag("Organizations") - @route("/subscriptions/{subscriptionId}/providers/NewRelic.Observability/organizations") - op list(...ApiVersionParameter, - ...SubscriptionIdParameter, - ...UserEmailParameter, - ...LocationParameter):ArmResponse | ErrorResponse -} - -interface plans { - @doc("List plans data") - @tag("Plan") - @route("/subscriptions/{subscriptionId}/providers/NewRelic.Observability/plans") - op list(...ApiVersionParameter, - ...SubscriptionIdParameter, - ...AccountIdParameter, - ...OrganizationIdParameter):ArmResponse | ErrorResponse -} - -@doc("A tag rule belonging to NewRelic account") -@parentResource(NewRelicMonitorResource) -model TagRule is ProxyResource { - @key("ruleSetName") - @segment("tagRules") - @doc("Name of the TagRule") - @path - name: string; - -} - -@armResourceOperations -interface TagRules extends ProxyResourceOperations,ProxyResourceUpdate{ -} - -@doc("Properties specific to the NewRelic Monitor resource") -model MonitorProperties { - @visibility("read") - @doc("Provisioning State of the resource") - provisioningState?: ProvisioningState; - - @visibility("read") - @doc("MonitoringStatus of the resource") - monitoringStatus?: MonitoringStatus; - - @visibility("read") - @doc("NewRelic Organization properties of the resource") - marketplaceSubscriptionStatus?: MarketplaceSubscriptionStatus; - - @visibility("read") - @doc("Marketplace Subscription Id") - marketplaceSubscriptionId?: string; - - @doc("MarketplaceSubscriptionStatus of the resource") - newRelicAccountProperties?: NewRelicAccountProperties; - - @doc("User Info") - userInfo?: UserInfo; - - @doc("Plan details") - planData?: PlanData; - - @visibility("read") - @doc("Liftr resource category") - liftrResourceCategory?: LiftrResourceCategories; - - @visibility("read") - @doc("Liftr resource preference. The priority of the resource.") - liftrResourcePreference?: int32; - - @doc("Source of org creation") - orgCreationSource?: OrgCreationSource; - - @doc("Source of account creation") - accountCreationSource?: AccountCreationSource; - -} - -@doc("Properties of the NewRelic account") -model NewRelicAccountProperties{ - - @doc("User id") - userId?: string; - - @doc("NewRelic Account Information") - accountInfo?: AccountInfo; - - @doc("NewRelic Organization Information") - organizationInfo?: OrganizationInfo; - - @doc("date when plan was applied") - singleSignOnProperties?: NewRelicSingleSignOnProperties; -} - -@doc("Single sign on Info of the NewRelic account") -model NewRelicSingleSignOnProperties{ - - @doc("Single sign-on state") - singleSignOnState?: SingleSignOnStates; - - @doc("The Id of the Enterprise App used for Single sign-on.") - enterpriseAppId?: string; - - @doc("The login URL specific to this NewRelic Organization") - singleSignOnUrl?: string; - - @doc("Provisioning state") - provisioningState?: ProvisioningState; -} - - -@doc("Account Info of the NewRelic account") -model AccountInfo{ - - @doc("Account id") - accountId?: string; - - @doc("ingestion key of account") - ingestionKey?: SecureString; - - @doc("NewRelic account region") - region?: string; -} - -@doc("Organization Info of the NewRelic account") -model OrganizationInfo{ - - @doc("Organization id") - organizationId?: string; -} - -@doc("Plan data of NewRelic Monitor resource") -model PlanData{ - - @doc("Different usage type like PAYG/COMMITTED. this could be enum") - usageType?: UsageType; - - @doc("Different billing cycles like MONTHLY/WEEKLY. this could be enum") - billingCycle?: BillingCycle; - - @doc("plan id as published by NewRelic") - planDetails?: string; - - @doc("date when plan was applied") - effectiveDate?: zonedDateTime; -} - -@doc("User Info of NewRelic Monitor resource") -model UserInfo{ - - @maxLength(50) - @doc("First name") - firstName?: string; - - @maxLength(50) - @doc("Last name") - lastName?: string; - - @doc("User Email") - emailAddress?: email; - - @maxLength(40) - @doc("Contact phone number") - phoneNumber?: string; - - @doc("country if user") - country?: string; -} - -@doc("Provisioning State of the Monitor resource") -enum ProvisioningState { - @doc("Monitor resource creation request accepted") - "Accepted", - @doc("Monitor resource creation started") - "Creating", - @doc("Monitor resource is being updated") - "Updating", - @doc("Monitor resource deletion started") - "Deleting", - @doc("Monitor resource creation successful") - "Succeeded", - @doc("Monitor resource creation failed") - "Failed", - @doc("Monitor resource creation canceled") - "Canceled", - @doc("Monitor resource is deleted") - "Deleted", - @doc("Monitor resource state is unknown") - "NotSpecified" -} - -@doc("Flag specifying if the resource monitoring is enabled or disabled.") -enum MonitoringStatus { - @doc("monitoring is enabled") - "Enabled", - @doc("monitoring is disabled") - "Disabled" -} - -@doc("Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.") -enum MarketplaceSubscriptionStatus { - @doc("monitoring is enabled") - "Active", - @doc("monitoring is disabled") - "Suspended" -} - -@doc("Liftr Resource category.") -enum LiftrResourceCategories { - "Unknown", - "MonitorLogs" -} - -@doc("Various states of the SSO resource") -enum SingleSignOnStates { - "Initial", - "Enable", - "Disable", - "Existing" -} - -@doc("The resource-specific properties for this resource.") -model MonitoringTagRulesProperties { - @visibility("read") - @doc("Provisioning State of the resource") - provisioningState?: ProvisioningState; - - @doc("Set of rules for sending logs for the Monitor resource.") - logRules?: LogRules; - - @doc("Set of rules for sending metrics for the Monitor resource.") - metricRules?: MetricRules; -} - -@doc("Set of rules for sending logs for the Monitor resource.") -model LogRules { - @doc("Flag specifying if AAD logs should be sent for the Monitor resource.") - sendAadLogs?: SendAadLogsStatus; - - @doc("Flag specifying if subscription logs should be sent for the Monitor resource.") - sendSubscriptionLogs?: SendSubscriptionLogsStatus; - - @doc("Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.") - sendActivityLogs?: SendActivityLogsStatus; - - @doc("List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.\nIf only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.") - filteringTags?: FilteringTag[]; -} - -@doc("Set of rules for sending metrics for the Monitor resource.") -model MetricRules { - @doc("Flag specifying if metrics should be sent for the Monitor resource.") - sendMetrics?: SendMetricsStatus; - - @doc("List of filtering tags to be used for capturing metrics.") - filteringTags?: FilteringTag[]; - - @doc("User Email") - userEmail?: email; -} - -@doc("Indicates whether AAD logs are being sent.") -enum SendAadLogsStatus { - "Enabled", - "Disabled" -} - -@doc("Indicates whether metrics are being sent.") -enum SendMetricsStatus { - "Enabled", - "Disabled" -} - -@doc("Indicates whether subscription logs are being sent.") -enum SendSubscriptionLogsStatus { - "Enabled", - "Disabled" -} - -@doc("Indicates whether activity logs are being sent.") -enum SendActivityLogsStatus { - "Enabled", - "Disabled" -} - -@doc("The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.") -model FilteringTag{ - - @doc("The name (also known as the key) of the tag.") - name?: string; - - @doc("The value of the tag.") - value?: string; - - @doc("Valid actions for a filtering tag. Exclusion takes priority over inclusion.") - action?: TagAction; -} - -@doc("Valid actions for a filtering tag. Exclusion takes priority over inclusion.") -enum TagAction { - "Include", - "Exclude" -} - -@doc("Details of resource being monitored by NewRelic monitor resource") -model MonitoredResource { - @doc("The ARM id of the resource.") - id?: string; - - @doc("Flag indicating if resource is sending metrics to NewRelic.") - sendingMetrics?: SendingMetricsStatus; - - @doc("Reason for why the resource is sending metrics (or why it is not sending).") - reasonForMetricsStatus?: string; - - @doc("Flag indicating if resource is sending logs to NewRelic.") - sendingLogs?: SendingLogsStatus; - - @doc("Reason for why the resource is sending logs (or why it is not sending).") - reasonForLogsStatus?: string; -} - -@doc("Indicates whether metrics are being sent.") -enum SendingMetricsStatus { - "Enabled", - "Disabled" -} - -@doc("Indicates whether logs are being sent.") -enum SendingLogsStatus { - "Enabled", - "Disabled" -} - -@doc("List of all the resources being monitored by NewRelic monitor resource") -model MonitoredResourceListResponse extends Azure.Core.Page {} - -@doc("Response of payload to be passed while installing VM agent.") -model VMExtensionPayload { - @doc("Ingestion key of the account") - ingestionKey?: string; -} - -@doc("Host Get Parameter specification.") -model HostsGetParameter { - @doc("The details of the Hosts get request.") - @body - request: HostsGetRequest; -} - -@doc("User email specification.") -model UserEmailParameter { - @doc("User Email.") - @query - userEmail: string; -} - -@doc("Location for NewRelic resource") -model LocationParameter { - @doc("Location for NewRelic.") - @query - location: string; -} - -@doc("Account Id parameter") -model AccountIdParameter { - @doc("Account Id.") - @query - accountId?: string; -} - -@doc("Organization Id parameter") -model OrganizationIdParameter { - @doc("Organization Id.") - @query - organizationId?: string; -} - -@doc("Request of a Hosts get Operation.") -model HostsGetRequest { - @doc("VM resource IDs") - vmIds?: string[]; - - @doc("User Email") - userEmail: email; -} - -@doc("App services Get Parameter specification.") -model AppServicesGetParameter { - @doc("The details of the app services get request.") - @body - request: AppServicesGetRequest; -} - -@doc("Request of a app services get Operation.") -model AppServicesGetRequest { - @doc("Azure resource IDs") - azureResourceIds?: string[]; - - @doc("User Email") - userEmail: email; -} - -@doc("Switch Billing Parameter specification.") -model SwitchBillingParameter { - @doc("The details of the switch billing request.") - @body - request: SwitchBillingRequest; -} - -@doc("Request of a switch billing Operation.") -model SwitchBillingRequest { - @doc("Azure resource Id") - azureResourceId?: string; - - @doc("Organization id") - organizationId?: string; - - @doc("Plan details") - planData?: PlanData; - - @doc("User Email") - userEmail: email; -} - -@doc("Get Metrics Status Parameter specification.") -model MetricsStatusRequestParameter { - @doc("The details of the get metrics status request.") - @body - request: MetricsStatusRequest; -} - -@doc("Request of get metrics status Operation.") -model MetricsStatusRequest { - @doc("Azure resource IDs") - azureResourceIds?: string[]; - - @doc("User Email") - userEmail: email; - -} - -@doc("Response of get metrics status Operation.") -model MetricsStatusResponse { - @doc("Azure resource IDs") - azureResourceIds?: string[]; - -} - -@doc("Get Metrics Status Parameter specification.") -model MetricsRequestParameter { - @doc("The details of the get metrics status request.") - @body - request: MetricsRequest; -} - -@doc("Request of get metrics Operation.") -model MetricsRequest { - - @doc("User Email") - userEmail: email; - -} - -@doc("Response of a list VM Host Operation.") -model VMHostsListResponse extends Azure.Core.Page {} - -@doc("Details of VM Resource having NewRelic OneAgent installed") -model VMInfo { - @doc("Azure VM resource ID") - vmId?: string; - - @doc("Version of the NewRelic agent installed on the VM.") - agentVersion?: string; - - @doc("Status of the NewRelic agent installed on the VM.") - agentStatus?: string; -} - -@doc("Response of a list app services Operation.") -model AppServicesListResponse extends Azure.Core.Page {} - -@doc("Details of VM Resource having NewRelic OneAgent installed") -model AppServiceInfo { - @doc("Azure App service resource ID") - azureResourceId?: string; - - @doc("Version of the NewRelic agent installed on the App service.") - agentVersion?: string; - - @doc("Status of the NewRelic agent installed on the App service.") - agentStatus?: string; -} - -@doc("The details of a Organization resource.") -model OrganizationResource is ProxyResource { - @key("organization") - @segment("organizations") - @doc("The name of the Organization resource") - @path - name: string; -} - -@doc("Response of get all organizations Operation.") -model OrganizationsListResponse extends Azure.Core.Page {} - -@doc("Details of Organizations") -model OrganizationProperties { - @doc("organization id") - organizationId?: string; - - @doc("organization name") - organizationName?: string; - - @doc("Billing source") - billingSource?: BillingSource; -} - -@doc("The details of a account resource.") -model AccountResource is ProxyResource { - @key("account") - @segment("accounts") - @doc("The name of the Account resource") - @path - name: string; -} - -@doc("List of all the New relic accounts for the given user") -model AccountProperties { - @doc("organization id") - organizationId?: string; - - @doc("account id") - accountId?: string; - - @doc("account name") - accountName?: string; - - @doc("region") - region?: string; -} - -@doc("Response of get all accounts Operation.") -model AccountsListResponse extends Azure.Core.Page {} - -@doc("The details of a PlanData resource.") -model PlanDataResource is ProxyResource { - @key("plan") - @segment("plans") - @doc("The name of the PlanData resource") - @path - name: string; -} - -@doc("Response of get all plan data Operation.") -model PlanDataListResponse extends Azure.Core.Page {} - -@doc("Plan details") -model PlanDataProperties { - @doc("Plan details") - planData?: PlanData; - - @doc("Source of org creation") - orgCreationSource?: OrgCreationSource; - - @doc("Source of account creation") - accountCreationSource?: AccountCreationSource; -} - -@doc("Billing source") -enum BillingSource { - @doc("Billing source is Azure") - "AZURE", - "NEWRELIC" -} - -@doc("Source of Org creation") -enum OrgCreationSource { - @doc("Org is created from LIFTR") - "LIFTR", - - @doc("Org is created from NEWRELIC") - "NEWRELIC" -} - -@doc("Source of Account creation") -enum AccountCreationSource { - @doc("Account is created from LIFTR") - "LIFTR", - - @doc("Account is created from NEWRELIC") - "NEWRELIC" -} - -@doc("Different usage type like PAYG/COMMITTED") -enum UsageType { - @doc("Usage type is PAYG") - "PAYG", - @doc("Usage type is COMMITTED") - "COMMITTED" -} - -@doc("Different usage type like YEARLY/MONTHLY") -enum BillingCycle { - @doc("Billing cycle is YEARLY") - "YEARLY", - @doc("Billing cycle is MONTHLY") - "MONTHLY", - @doc("Billing cycle is WEEKLY") - "WEEKLY" -} \ No newline at end of file diff --git a/specification/newrelic/NewRelic.Management/package.json b/specification/newrelic/NewRelic.Management/package.json deleted file mode 100644 index 30cd49319588..000000000000 --- a/specification/newrelic/NewRelic.Management/package.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "name": "cadl", - "version": "1.0.0", - "main": "index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "keywords": [], - "author": "", - "license": "ISC", - "dependencies": { - "@azure-tools/cadl-autorest": "0.26.0", - "@azure-tools/cadl-azure-core": "0.26.0", - "@azure-tools/cadl-azure-resource-manager": "0.26.0", - "@azure-tools/cadl-providerhub": "0.26.0", - "@azure-tools/cadl-providerhub-controller": "0.26.0", - "@cadl-lang/compiler": "0.40.0", - "@cadl-lang/openapi": "0.40.0", - "@cadl-lang/openapi3": "0.40.0", - "@cadl-lang/rest": "0.40.0", - "@cadl-lang/versioning": "0.40.0", - "oav": "3.0.4" - }, - "devDependencies": {}, - "directories": { - "example": "examples" - }, - "description": "" -} diff --git a/specification/newrelic/NewRelicObservability.Management/MonitoredSubscriptionProperties.tsp b/specification/newrelic/NewRelicObservability.Management/MonitoredSubscriptionProperties.tsp new file mode 100644 index 000000000000..4be8f6736efb --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/MonitoredSubscriptionProperties.tsp @@ -0,0 +1,66 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./NewRelicMonitorResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace NewRelic.Observability; +/** + * The request to update subscriptions needed to be monitored by the NewRelic monitor resource. + */ +@parentResource(NewRelicMonitorResource) +model MonitoredSubscriptionProperties + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = MonitoredSubscriptionProperties, + KeyName = "configurationName", + SegmentName = "monitoredSubscriptions", + Type = ConfigurationName + >; +} + +@armResourceOperations +interface MonitoredSubscriptions { + @summary("Lists all the subscriptions currently being monitored by the NewRelic monitor resource.") + get is ArmResourceRead; + + @summary("Add subscriptions to be monitored by the New Relic monitor resource, enabling observability and monitoring.") + createOrUpdate is Legacy.CreateOrUpdateAsync< + MonitoredSubscriptionProperties, + LroHeaders = ArmLroLocationHeader & + Azure.Core.Foundations.RetryAfterHeader, + OptionalRequestBody = true + >; + + @summary("Update subscriptions to be monitored by the New Relic monitor resource, ensuring optimal observability and performance") + @patch(#{ implicitOptionality: false }) + update is Azure.ResourceManager.Legacy.CustomPatchAsync< + MonitoredSubscriptionProperties, + PatchModel = MonitoredSubscriptionProperties, + OptionalRequestBody = true + >; + + @summary("Delete subscriptions being monitored by the New Relic monitor resource, removing their observability and monitoring capabilities") + delete is ArmResourceDeleteWithoutOkAsync; + + @summary("Lists all the subscriptions currently being monitored by the NewRelic monitor resource.") + list is ArmResourceListByParent< + MonitoredSubscriptionProperties, + Response = ArmResponse + >; +} + +@@doc(MonitoredSubscriptionProperties.name, + "The configuration name. Only 'default' value is supported." +); +@@doc(MonitoredSubscriptionProperties.properties, + "The request to update subscriptions needed to be monitored by the NewRelic monitor resource." +); +@@doc(MonitoredSubscriptions.createOrUpdate::parameters.resource, ""); +@@doc(MonitoredSubscriptions.update::parameters.properties, ""); diff --git a/specification/newrelic/NewRelicObservability.Management/NewRelicMonitorResource.tsp b/specification/newrelic/NewRelicObservability.Management/NewRelicMonitorResource.tsp new file mode 100644 index 000000000000..09eaa4482298 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/NewRelicMonitorResource.tsp @@ -0,0 +1,248 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; + +namespace NewRelic.Observability; +/** + * A Monitor Resource by NewRelic + */ +model NewRelicMonitorResource + is Azure.ResourceManager.TrackedResource { + ...ResourceNameParameter< + Resource = NewRelicMonitorResource, + KeyName = "monitorName", + SegmentName = "monitors", + NamePattern = "^.*$" + >; + + /** + * The managed service identities assigned to this resource. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + identity?: Azure.ResourceManager.CommonTypes.ManagedServiceIdentity; +} + +@armResourceOperations +interface NewRelicMonitorResources { + /** + * Retrieves the properties and configuration details of a specific New Relic monitor resource, providing insight into its setup and status + */ + get is ArmResourceRead; + + /** + * Creates a new or updates an existing New Relic monitor resource in your Azure subscription. This sets up the integration between Azure and your New Relic account, enabling observability and monitoring of your Azure resources through New Relic + */ + createOrUpdate is ArmResourceCreateOrUpdateAsync; + + /** + * Updates an existing New Relic monitor resource from your Azure subscription + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchAsync< + NewRelicMonitorResource, + PatchModel = NewRelicMonitorResourceUpdate + >; + + /** + * Deletes an existing New Relic monitor resource from your Azure subscription, removing the integration and stopping the observability of your Azure resources through New Relic + */ + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + delete is ArmResourceDeleteWithoutOkAsync< + NewRelicMonitorResource, + Parameters = { + /** + * User Email. + */ + @query("userEmail") + userEmail: string; + }, + Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse + >; + + /** + * Retrieves a list of all New Relic monitor resources either a specific resource group + */ + listByResourceGroup is ArmResourceListByParent; + + /** + * Lists all New Relic monitor resources either within a specific subscription + */ + listBySubscription is ArmListBySubscription; + + /** + * Retrieves the metric rules that are configured in the New Relic monitor resource + */ + getMetricRules is ArmResourceActionSync< + NewRelicMonitorResource, + MetricsRequest, + ArmResponse + >; + + /** + * Retrieves the metric status that are configured in the New Relic monitor resource + */ + getMetricStatus is ArmResourceActionSync< + NewRelicMonitorResource, + MetricsStatusRequest, + ArmResponse + >; + + /** + * Lists the app service resources currently being monitored by the New Relic resource, helping you understand which app services are under monitoring + */ + @list + listAppServices is ArmResourceActionSync< + NewRelicMonitorResource, + AppServicesGetRequest, + ArmResponse + >; + + /** + * Switches the billing for the New Relic Monitor resource to be billed by Azure Marketplace + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + switchBilling is ArmResourceActionSync< + NewRelicMonitorResource, + SwitchBillingRequest, + ArmResponse | AcceptedResponse | NoContentResponse + >; + + /** + * Lists all VM resources currently being monitored by the New Relic monitor resource, helping you manage observability + */ + @list + listHosts is ArmResourceActionSync< + NewRelicMonitorResource, + HostsGetRequest, + ArmResponse + >; + + /** + * Refreshes the ingestion key for all monitors linked to the same account associated to the underlying monitor. + */ + refreshIngestionKey is ArmResourceActionSync< + NewRelicMonitorResource, + void, + NoContentResponse + >; + + /** + * Lists all Azure resources that are currently being monitored by the specified New Relic monitor resource, providing insight into the coverage of your observability setup + */ + @list + @action("monitoredResources") + listMonitoredResources is ArmResourceActionSync< + NewRelicMonitorResource, + void, + ArmResponse + >; + + /** + * Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration + */ + @list + @summary("Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration") + listLinkedResources is ArmResourceActionSync< + NewRelicMonitorResource, + void, + ArmResponse + >; + + /** + * Returns the payload that needs to be passed in the request body for installing the New Relic agent on a VM, providing the necessary configuration details + */ + @action("vmHostPayloads") + vmHostPayload is ArmResourceActionSync< + NewRelicMonitorResource, + void, + ArmResponse + >; + + /** + * Returns the latest SaaS linked to the newrelic organization of the underlying monitor. + */ + latestLinkedSaaS is ArmResourceActionSync< + NewRelicMonitorResource, + void, + ArmResponse + >; + + /** + * Links a new SaaS to the newrelic organization of the underlying monitor. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @summary("Links a new SaaS to the newrelic organization of the underlying monitor.") + @Azure.Core.useFinalStateVia("azure-async-operation") + linkSaaS is ArmResourceActionAsync< + NewRelicMonitorResource, + SaaSData, + ArmResponse, + LroHeaders = ArmCombinedLroHeaders & + Azure.Core.Foundations.RetryAfterHeader + >; + + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.Core.useFinalStateVia("azure-async-operation") + @summary("Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace") + resubscribe is ArmResourceActionAsync< + NewRelicMonitorResource, + ResubscribeProperties, + ArmResponse, + LroHeaders = ArmCombinedLroHeaders & + Azure.Core.Foundations.RetryAfterHeader, + OptionalRequestBody = true + >; + + @action("getBillingInfo") + @summary("Retrieves marketplace and organization information mapped to the given New Relic monitor resource") + billingInfoGet is ArmResourceActionSync< + NewRelicMonitorResource, + void, + ArmResponse + >; + + @list + @action("listConnectedPartnerResources") + @summary("List of all active deployments that are associated with the marketplace subscription linked to the given monitor.") + list is ArmResourceActionSync< + NewRelicMonitorResource, + email, + ArmResponse, + OptionalRequestBody = true + >; +} + +@@doc(NewRelicMonitorResource.name, "Name of the Monitors resource"); +@@doc(NewRelicMonitorResource.properties, + "The resource-specific properties for this resource." +); +@@doc(NewRelicMonitorResources.getMetricRules::parameters.body, + "The details of the get metrics status request." +); +@@doc(NewRelicMonitorResources.getMetricStatus::parameters.body, + "The details of the get metrics status request." +); +@@doc(NewRelicMonitorResources.listAppServices::parameters.body, + "The details of the app services get request." +); +@@doc(NewRelicMonitorResources.switchBilling::parameters.body, + "The details of the switch billing request." +); +@@doc(NewRelicMonitorResources.listHosts::parameters.body, + "The details of the Hosts get request." +); +@@doc(NewRelicMonitorResources.linkSaaS::parameters.body, + "Link SaaS body parameter" +); +@@doc(NewRelicMonitorResources.resubscribe::parameters.body, + "Resubscribe Properties" +); +@@doc(NewRelicMonitorResources.list::parameters.body, "Email Id of the user"); diff --git a/specification/newrelic/NewRelicObservability.Management/TagRule.tsp b/specification/newrelic/NewRelicObservability.Management/TagRule.tsp new file mode 100644 index 000000000000..9ed71e50560f --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/TagRule.tsp @@ -0,0 +1,66 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/openapi"; +import "@typespec/rest"; +import "./models.tsp"; +import "./NewRelicMonitorResource.tsp"; + +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Http; +using TypeSpec.OpenAPI; + +namespace NewRelic.Observability; +/** + * A tag rule belonging to NewRelic account + */ +@parentResource(NewRelicMonitorResource) +model TagRule + is Azure.ResourceManager.ProxyResource { + ...ResourceNameParameter< + Resource = TagRule, + KeyName = "ruleSetName", + SegmentName = "tagRules", + NamePattern = "" + >; +} + +@armResourceOperations +interface TagRules { + /** + * Retrieves the details of the tag rules for a specific New Relic monitor resource, providing insight into its setup and status + */ + get is ArmResourceRead; + + /** + * Creates a new set of tag rules for a specific New Relic monitor resource, determining which Azure resources are monitored based on their tags + */ + createOrUpdate is ArmResourceCreateOrUpdateAsync; + + /** + * Updates the tag rules for a specific New Relic monitor resource, allowing you to modify the rules that control which Azure resources are monitored + */ + @patch(#{ implicitOptionality: false }) + update is ArmCustomPatchSync; + + /** + * Deletes a tag rule set for a given New Relic monitor resource, removing fine-grained control over observability based on resource tags + */ + #suppress "@azure-tools/typespec-azure-resource-manager/lro-location-header" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + delete is ArmResourceDeleteWithoutOkAsync< + TagRule, + Response = ArmDeletedResponse | ArmDeleteAcceptedLroResponse | ArmDeletedNoContentResponse + >; + + /** + * Lists all tag rules associated with a specific New Relic monitor resource, helping you manage and audit the rules that control resource monitoring + */ + listByNewRelicMonitorResource is ArmResourceListByParent; +} + +@@doc(TagRule.name, "Name of the TagRule"); +@@doc(TagRule.properties, + "The resource-specific properties for this resource." +); diff --git a/specification/newrelic/NewRelicObservability.Management/back-compatible.tsp b/specification/newrelic/NewRelicObservability.Management/back-compatible.tsp new file mode 100644 index 000000000000..52872f0461e1 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/back-compatible.tsp @@ -0,0 +1,75 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using NewRelic.Observability; + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AccountResource.properties); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OrganizationResource.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PlanDataResource.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NewRelicMonitorResourceUpdate.properties +); + +#suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagRuleUpdate.properties); + +@@clientLocation(NewRelicMonitorResources.get, "Monitors"); +@@clientLocation(NewRelicMonitorResources.createOrUpdate, "Monitors"); +@@clientLocation(NewRelicMonitorResources.update, "Monitors"); +@@clientLocation(NewRelicMonitorResources.delete, "Monitors"); +@@clientLocation(NewRelicMonitorResources.listByResourceGroup, "Monitors"); +@@clientLocation(NewRelicMonitorResources.listBySubscription, "Monitors"); +@@clientLocation(NewRelicMonitorResources.getMetricRules, "Monitors"); +@@clientName(NewRelicMonitorResources.getMetricRules::parameters.body, + "request" +); +@@clientLocation(NewRelicMonitorResources.getMetricStatus, "Monitors"); +@@clientName(NewRelicMonitorResources.getMetricStatus::parameters.body, + "request" +); +@@clientLocation(NewRelicMonitorResources.listAppServices, "Monitors"); +@@clientName(NewRelicMonitorResources.listAppServices::parameters.body, + "request" +); +@@clientLocation(NewRelicMonitorResources.switchBilling, "Monitors"); +@@clientName(NewRelicMonitorResources.switchBilling::parameters.body, + "request" +); +@@clientLocation(NewRelicMonitorResources.listHosts, "Monitors"); +@@clientName(NewRelicMonitorResources.listHosts::parameters.body, "request"); +@@clientLocation(NewRelicMonitorResources.refreshIngestionKey, "Monitors"); +@@clientLocation(NewRelicMonitorResources.listMonitoredResources, "Monitors"); +@@clientLocation(NewRelicMonitorResources.listLinkedResources, "Monitors"); +@@clientLocation(NewRelicMonitorResources.vmHostPayload, "Monitors"); +@@clientLocation(NewRelicMonitorResources.latestLinkedSaaS, "Monitors"); +@@clientLocation(NewRelicMonitorResources.linkSaaS, "Monitors"); +@@clientLocation(NewRelicMonitorResources.resubscribe, "Monitors"); +@@clientLocation(NewRelicMonitorResources.billingInfoGet, "BillingInfo"); +@@clientName(NewRelicMonitorResources.billingInfoGet, "Get"); +@@clientLocation(NewRelicMonitorResources.list, "ConnectedPartnerResources"); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NewRelicMonitorResource.properties +); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TagRule.properties); + +@@clientName(MonitoredSubscriptions.createOrUpdate::parameters.resource, + "body" +); +@@clientName(MonitoredSubscriptions.update::parameters.properties, "body"); + +@@clientLocation(AccountsOperationGroup.list, "Accounts"); + +@@clientLocation(OrganizationsOperationGroup.list, "Organizations"); + +@@clientLocation(PlansOperationGroup.list, "Plans"); + +@@clientLocation(SaaSOperationGroup.activateResource, "SaaS"); +@@clientName(SaaSOperationGroup.activateResource::parameters.body, "request"); diff --git a/specification/newrelic/NewRelicObservability.Management/client.tsp b/specification/newrelic/NewRelicObservability.Management/client.tsp new file mode 100644 index 000000000000..9aad9b68d70c --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/client.tsp @@ -0,0 +1,19 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(NewRelic.Observability, + "NewRelicObservabilityMgmtClient", + "python" +); + +@@clientName(NewRelic.Observability.NewRelicAccountProperties, + "AccountPropertiesForNewRelic", + "go" +); + +@@clientName(NewRelic.Observability.MonitoredSubscriptions.createOrUpdate, + "createorUpdate", + "go" +); diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Accounts_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..488a7ef0cc79 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Accounts_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Accounts_List", + "parameters": { + "api-version": "2025-05-01-preview", + "location": "egh", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "title": "Accounts_List_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "accountId": "igmdjq", + "accountName": "accname", + "organizationId": "wvdclwi", + "region": "xnsylopqwcggudcln" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Accounts_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..e1eab7df2472 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Accounts_List_MinimumSet_Gen.json @@ -0,0 +1,21 @@ +{ + "operationId": "Accounts_List", + "parameters": { + "api-version": "2025-05-01-preview", + "location": "egh", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "title": "Accounts_List_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/ActivateSaaS.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/ActivateSaaS.json new file mode 100644 index 000000000000..9c96c9974fae --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/ActivateSaaS.json @@ -0,0 +1,19 @@ +{ + "operationId": "SaaS_ActivateResource", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "request": { + "publisherId": "publisherId", + "saasGuid": "00000000-0000-0000-0000-000005430000" + } + }, + "title": "ActivateSaaS", + "responses": { + "200": { + "body": { + "saasId": "00000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/BillingInfo_Get.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/BillingInfo_Get.json new file mode 100644 index 000000000000..6768e20c05ae --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/BillingInfo_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzNewRelic_b1190c8f", + "marketplaceStatus": "Active", + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceSubscriptionName": "AzNewRelic_b1190c8f", + "offerId": "offerId", + "publisherId": "publisherId" + }, + "partnerBillingEntity": { + "organizationId": "1234567890", + "organizationName": "NROrganizationName" + } + } + } + }, + "operationId": "BillingInfo_Get", + "title": "BillingInfo_Get" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/ConnectedPartnerResources_List.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..43bb335984fc --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/ConnectedPartnerResources_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "accountId": "1156243", + "accountName": "accountName", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + }, + "operationId": "ConnectedPartnerResources_List", + "title": "ConnectedPartnerResources_List" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/LinkedResources_List.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/LinkedResources_List.json new file mode 100644 index 000000000000..92b9d4f87cdd --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/LinkedResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + } + ] + } + } + }, + "operationId": "Monitors_ListLinkedResources", + "title": "Monitors_ListLinkedResources" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_CreateOrUpdate.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..5c8efd7a7959 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_CreateOrUpdate.json @@ -0,0 +1,216 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "configurationName": "default", + "monitorName": "myMonitor", + "requestBody": { + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ], + "operation": "AddBegin" + } + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ] + } + } + } + }, + "operationId": "MonitoredSubscriptions_CreateOrUpdate", + "title": "Monitors_AddMonitoredSubscriptions" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Delete.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..ff2249051634 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2025-05-01-preview" + } + }, + "204": {} + }, + "operationId": "MonitoredSubscriptions_Delete", + "title": "Monitors_DeleteMonitoredSubscriptions" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Get.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..a16d2771d25a --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Get.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "configurationName": "default", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ] + } + } + } + }, + "operationId": "MonitoredSubscriptions_Get", + "title": "Monitors_GetMonitoredSubscriptions" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_List.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..e62de84186d7 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_List.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "name": "default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ] + } + } + ] + } + } + }, + "operationId": "MonitoredSubscriptions_List", + "title": "Monitors_GetMonitoredSubscriptions" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Update.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..b65145e934e6 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/MonitoredSubscriptions_Update.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "configurationName": "default", + "monitorName": "myMonitor", + "requestBody": { + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ], + "operation": "AddComplete" + } + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", + "properties": { + "monitoredSubscriptionList": [ + { + "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + { + "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "tagRules": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2025-05-01-preview" + } + } + }, + "operationId": "MonitoredSubscriptions_Update", + "title": "Monitors_UpdateMonitoredSubscriptions" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..866f60599f93 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,212 @@ +{ + "operationId": "Monitors_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "cdlymktqw", + "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", + "saaSData": { + "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" + }, + "subscriptionState": "Suspended", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "tags": { + "key6976": "oaxfhf" + } + }, + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", + "subscriptionState": "Suspended", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + }, + "201": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", + "subscriptionState": "Suspended", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + }, + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..dfbeebb4f554 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "title": "Monitors_Delete_MaximumSet_Gen", + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..4b858fb3cbab --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "Monitors_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "title": "Monitors_Delete_MinimumSet_Gen", + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricRules_MaximumSet_Gen.json new file mode 100644 index 000000000000..43c229b81ed2 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Monitors_GetMetricRules", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "title": "Monitors_GetMetricRules_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "filteringTags": [ + { + "name": "qnvixg", + "action": "Include", + "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge" + } + ], + "sendMetrics": "Enabled", + "userEmail": "test@testing.com" + } + } + } +} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricRules_MinimumSet_Gen.json similarity index 92% rename from specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json rename to specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricRules_MinimumSet_Gen.json index 731cde656d52..d8dabc8184e0 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricRules_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -1,20 +1,20 @@ { "operationId": "Monitors_GetMetricRules", - "title": "Monitors_GetMetricRules_MinimumSet_Gen", "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", + "api-version": "2025-05-01-preview", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricRules_MinimumSet_Gen", "responses": { "200": { "body": { - "sendMetrics": "Disabled", "filteringTags": [], + "sendMetrics": "Disabled", "userEmail": null } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricStatus_MaximumSet_Gen.json similarity index 95% rename from specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json rename to specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricStatus_MaximumSet_Gen.json index 3b4fcdb45653..31eebf167fa7 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_GetMetricStatus", - "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", + "api-version": "2025-05-01-preview", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,6 +12,7 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricStatus_MinimumSet_Gen.json similarity index 93% rename from specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json rename to specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricStatus_MinimumSet_Gen.json index 8505847b12ba..5fb17dcd34d5 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_GetMetricStatus", - "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", + "api-version": "2025-05-01-preview", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,6 +12,7 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..22f391fb7b14 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "operationId": "Monitors_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "cdlymktqw", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_Get_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json new file mode 100644 index 000000000000..f64a78384b9d --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "operationId": "Monitors_LatestLinkedSaaS", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_LatestLinkedSaaS_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "isHiddenSaaS": false, + "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json new file mode 100644 index 000000000000..727bea5134ee --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "operationId": "Monitors_LatestLinkedSaaS", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_LatestLinkedSaaS_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "isHiddenSaaS": false, + "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LinkSaaS.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LinkSaaS.json new file mode 100644 index 000000000000..97b0d8ec318a --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_LinkSaaS.json @@ -0,0 +1,91 @@ +{ + "operationId": "Monitors_LinkSaaS", + "parameters": { + "api-version": "2025-05-01-preview", + "body": { + "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_LinkSaaS", + "responses": { + "200": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "YEARLY", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", + "subscriptionState": "Suspended", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListAppServices_MaximumSet_Gen.json similarity index 80% rename from specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json rename to specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListAppServices_MaximumSet_Gen.json index 67a6ea17b9ec..3534b53563f2 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MaximumSet_Gen.json +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListAppServices_MaximumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_ListAppServices", - "title": "Monitors_ListAppServices_MaximumSet_Gen", "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", + "api-version": "2025-05-01-preview", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,17 +12,18 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_ListAppServices_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { - "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "agentStatus": "vclwfecbppsfaygdccfu", "agentVersion": "owxkssnbp", - "agentStatus": "vclwfecbppsfaygdccfu" + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" } - ], - "nextLink": "zhjqbjq" + ] } } } diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListAppServices_MinimumSet_Gen.json similarity index 87% rename from specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json rename to specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListAppServices_MinimumSet_Gen.json index 606d1792ce04..b7b29a8a87e2 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_ListAppServices_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListAppServices_MinimumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_ListAppServices", - "title": "Monitors_ListAppServices_MinimumSet_Gen", "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", + "api-version": "2025-05-01-preview", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,11 +12,12 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_ListAppServices_MinimumSet_Gen", "responses": { "200": { "body": { - "value": [], - "nextLink": null + "nextLink": null, + "value": [] } } } diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..923d42ee50a6 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "operationId": "Monitors_ListByResourceGroup", + "parameters": { + "api-version": "2025-05-01-preview", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..ccf3a0614009 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "operationId": "Monitors_ListBySubscription", + "parameters": { + "api-version": "2025-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_ListBySubscription_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListHosts_MaximumSet_Gen.json new file mode 100644 index 000000000000..835d4700272d --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListHosts_MaximumSet_Gen.json @@ -0,0 +1,30 @@ +{ + "operationId": "Monitors_ListHosts", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ] + } + }, + "title": "Monitors_ListHosts_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz", + "agentVersion": "tbinulnoozxnbr", + "vmId": "gwyoa" + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListHosts_MinimumSet_Gen.json new file mode 100644 index 000000000000..2eca329eb636 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListHosts_MinimumSet_Gen.json @@ -0,0 +1,24 @@ +{ + "operationId": "Monitors_ListHosts", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", + "vmIds": [ + "xzphvxvfmvjrnsgyns" + ] + } + }, + "title": "Monitors_ListHosts_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListMonitoredResources_MaximumSet_Gen.json new file mode 100644 index 000000000000..a584e837f978 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "reasonForLogsStatus": "agzxviwuxgr", + "reasonForMetricsStatus": "k", + "sendingLogs": "Enabled", + "sendingMetrics": "Enabled" + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListMonitoredResources_MinimumSet_Gen.json new file mode 100644 index 000000000000..a60e6539d316 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "operationId": "Monitors_ListMonitoredResources", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_RefreshIngestionKey.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_RefreshIngestionKey.json new file mode 100644 index 000000000000..f939944337d3 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_RefreshIngestionKey.json @@ -0,0 +1,13 @@ +{ + "operationId": "Monitors_RefreshIngestionKey", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_RefreshIngestionKey", + "responses": { + "204": {} + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Resubscribe.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Resubscribe.json new file mode 100644 index 000000000000..ce9198bea423 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Resubscribe.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "myMonitor", + "requestBody": { + "offerId": "offerId", + "organizationId": "organizationId", + "planId": "planId", + "publisherId": "publisherId", + "resourceGroup": "resourceGroup", + "subscriptionId": "subscriptionId", + "term": "term" + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "YEARLY", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", + "subscriptionState": "Suspended", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + }, + "operationId": "Monitors_Resubscribe", + "title": "Monitors_Resubscribe" +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_SwitchBilling_MaximumSet_Gen.json new file mode 100644 index 000000000000..35b237245708 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "operationId": "Monitors_SwitchBilling", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "request": { + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "organizationId": "k", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + } + }, + "title": "Monitors_SwitchBilling_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_SwitchBilling_MinimumSet_Gen.json similarity index 76% rename from specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json rename to specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_SwitchBilling_MinimumSet_Gen.json index 06bddcb3149d..e3ac89da96e1 100644 --- a/specification/newrelic/NewRelic.Management/examples/Monitors_SwitchBilling_MinimumSet_Gen.json +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -1,25 +1,41 @@ { "operationId": "Monitors_SwitchBilling", - "title": "Monitors_SwitchBilling_MinimumSet_Gen", "parameters": { - "api-version": "2022-07-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", + "api-version": "2025-05-01-preview", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_SwitchBilling_MinimumSet_Gen", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -28,55 +44,39 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", - "billingCycle": "YEARLY", + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "ilrwkvbuwu", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..7ca38b335b22 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_Update_MaximumSet_Gen.json @@ -0,0 +1,131 @@ +{ + "operationId": "Monitors_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "cdlymktqw", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "properties": { + "accountCreationSource": "LIFTR", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "ingestionKey": "wltnimmhqt", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "tags": { + "key164": "jqakdrrmmyzytqu" + } + }, + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_Update_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", + "properties": { + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, + "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", + "newRelicAccountProperties": { + "accountInfo": { + "accountId": "xhqmg", + "region": "ljcf" + }, + "organizationInfo": { + "organizationId": "k" + }, + "singleSignOnProperties": { + "enterpriseAppId": "kwiwfz", + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" + }, + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + }, + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", + "createdBy": "pcdjzdldbwsdlfi", + "createdByType": "User", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", + "lastModifiedBy": "xbsjrxmwwlmpnpvcica", + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2025-05-01-preview" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_VmHostPayload_MaximumSet_Gen.json new file mode 100644 index 000000000000..2176244df68f --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_VmHostPayload_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_VmHostPayload_MinimumSet_Gen.json new file mode 100644 index 000000000000..1be5dc939538 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Monitors_VmHostPayload", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Monitors_VmHostPayload_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "ingestionKey": "ltqewhfexphvqgttoevaywrl" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Operations_List_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..5fb87d2e0f77 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-05-01-preview" + }, + "title": "Operations_List_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "name": "zhlrjcljiysnufaerhpzg", + "actionType": "Internal", + "display": { + "description": "sekhimcuecttketh", + "operation": "ybyzweygkffbydgaowg", + "provider": "v", + "resource": "w" + }, + "isDataAction": true, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Operations_List_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..9c2bc357accb --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "operationId": "Operations_List", + "parameters": { + "api-version": "2025-05-01-preview" + }, + "title": "Operations_List_MinimumSet_Gen", + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Organizations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a8b41e5fbcaa --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Organizations_List_MaximumSet_Gen.json @@ -0,0 +1,27 @@ +{ + "operationId": "Organizations_List", + "parameters": { + "api-version": "2025-05-01-preview", + "location": "egh", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "title": "Organizations_List_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "billingSource": "AZURE", + "organizationId": "tjmcifofzirili", + "organizationName": "orgname" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Organizations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..a5b43be42074 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Organizations_List_MinimumSet_Gen.json @@ -0,0 +1,17 @@ +{ + "operationId": "Organizations_List", + "parameters": { + "api-version": "2025-05-01-preview", + "location": "egh", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + }, + "title": "Organizations_List_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Plans_List_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Plans_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..79ae80747ebd --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Plans_List_MaximumSet_Gen.json @@ -0,0 +1,32 @@ +{ + "operationId": "Plans_List", + "parameters": { + "accountId": "pwuxgvrmkk", + "api-version": "2025-05-01-preview", + "organizationId": "hilawwjz", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Plans_List_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "accountCreationSource": "LIFTR", + "orgCreationSource": "LIFTR", + "planData": { + "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", + "planDetails": "tbbiaga", + "usageType": "PAYG" + } + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Plans_List_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Plans_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..316a4e57ef1c --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/Plans_List_MinimumSet_Gen.json @@ -0,0 +1,23 @@ +{ + "operationId": "Plans_List", + "parameters": { + "api-version": "2025-05-01-preview", + "organizationId": "hilawwjz", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "Plans_List_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "orgCreationSource": "NEWRELIC" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..981766b1a57d --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,121 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resource": { + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + } + }, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ] + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User" + } + } + }, + "201": { + "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ] + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User" + } + }, + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_CreateOrUpdate_MinimumSet_Gen.json new file mode 100644 index 000000000000..1d40f6ef54a9 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -0,0 +1,31 @@ +{ + "operationId": "TagRules_CreateOrUpdate", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resource": { + "properties": {} + }, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} + }, + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6cb6549a0bca --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_Delete_MaximumSet_Gen", + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Delete_MinimumSet_Gen.json new file mode 100644 index 000000000000..d0ee217ac42d --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Delete_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Delete", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_Delete_MinimumSet_Gen", + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b181d5372d9c --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Get_MaximumSet_Gen.json @@ -0,0 +1,53 @@ +{ + "operationId": "TagRules_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_Get_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Get_MinimumSet_Gen.json new file mode 100644 index 000000000000..a60ca4d70393 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Get_MinimumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "operationId": "TagRules_Get", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_Get_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..80dadb757007 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -0,0 +1,57 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "nextLink": "http://testlink.com", + "value": [ + { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User" + } + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json new file mode 100644 index 000000000000..03f6a6556b25 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -0,0 +1,22 @@ +{ + "operationId": "TagRules_ListByNewRelicMonitorResource", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..41eb3af54a00 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Update_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "operationId": "TagRules_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "properties": { + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + } + } + }, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_Update_MaximumSet_Gen", + "responses": { + "200": { + "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": { + "logRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" + }, + "metricRules": { + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" + } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" + }, + "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", + "createdBy": "wqrkemruqrvclsoevdftfeof", + "createdByType": "User", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", + "lastModifiedBy": "usdyoriebtakpdotcfp", + "lastModifiedByType": "User" + } + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Update_MinimumSet_Gen.json new file mode 100644 index 000000000000..5c159b60df63 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/examples/2025-05-01-preview/TagRules_Update_MinimumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "operationId": "TagRules_Update", + "parameters": { + "api-version": "2025-05-01-preview", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "properties": {}, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "title": "TagRules_Update_MinimumSet_Gen", + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} + } + } + } +} diff --git a/specification/newrelic/NewRelicObservability.Management/main.tsp b/specification/newrelic/NewRelicObservability.Management/main.tsp new file mode 100644 index 000000000000..c3ebd69cad98 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/main.tsp @@ -0,0 +1,44 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Parameters used: + * isFullCompatible: true + * guessResourceKey: false + * Version: 0.11.4 + * Date: 2025-08-01T08:02:45.948Z + */ +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./models.tsp"; +import "./back-compatible.tsp"; +import "./NewRelicMonitorResource.tsp"; +import "./TagRule.tsp"; +import "./MonitoredSubscriptionProperties.tsp"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager.Foundations; +using Azure.Core; +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@armProviderNamespace +@service(#{ title: "NewRelic.Observability" }) +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v3) +namespace NewRelic.Observability; + +/** + * The available API versions. + */ +enum Versions { + /** + * The 2025-05-01-preview API version. + */ + v2025_05_01_preview: "2025-05-01-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/newrelic/NewRelicObservability.Management/models.tsp b/specification/newrelic/NewRelicObservability.Management/models.tsp new file mode 100644 index 000000000000..c9da70931359 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/models.tsp @@ -0,0 +1,1420 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; +using Azure.ResourceManager.Foundations; + +namespace NewRelic.Observability; + +/** + * The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" + */ +union Origin { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + user: "user", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + system: "system", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + `user,system`: "user,system", +} + +/** + * Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. + */ +union ActionType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Internal: "Internal", +} + +/** + * The type of identity that created the resource. + */ +union CreatedByType { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + User: "User", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Application: "Application", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + ManagedIdentity: "ManagedIdentity", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Key: "Key", +} + +/** + * Provisioning State of the Monitor resource + */ +union ProvisioningState { + string, + + /** + * Monitor resource creation request accepted + */ + Accepted: "Accepted", + + /** + * Monitor resource creation started + */ + Creating: "Creating", + + /** + * Monitor resource is being updated + */ + Updating: "Updating", + + /** + * Monitor resource deletion started + */ + Deleting: "Deleting", + + /** + * Monitor resource creation successful + */ + Succeeded: "Succeeded", + + /** + * Monitor resource creation failed + */ + Failed: "Failed", + + /** + * Monitor resource creation canceled + */ + Canceled: "Canceled", + + /** + * Monitor resource is deleted + */ + Deleted: "Deleted", + + /** + * Monitor resource state is unknown + */ + NotSpecified: "NotSpecified", +} + +/** + * Flag specifying if the resource monitoring is enabled or disabled. + */ +union MonitoringStatus { + string, + + /** + * monitoring is enabled + */ + Enabled: "Enabled", + + /** + * monitoring is disabled + */ + Disabled: "Disabled", +} + +/** + * Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. + */ +union MarketplaceSubscriptionStatus { + string, + + /** + * monitoring is enabled + */ + Active: "Active", + + /** + * monitoring is disabled + */ + Suspended: "Suspended", +} + +/** + * Various states of the SSO resource + */ +union SingleSignOnStates { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Initial: "Initial", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enable: "Enable", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disable: "Disable", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Existing: "Existing", +} + +/** + * Different usage type like PAYG/COMMITTED + */ +union UsageType { + string, + + /** + * Usage type is PAYG + */ + PAYG: "PAYG", + + /** + * Usage type is COMMITTED + */ + COMMITTED: "COMMITTED", +} + +/** + * Liftr Resource category. + */ +union LiftrResourceCategories { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Unknown: "Unknown", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + MonitorLogs: "MonitorLogs", +} + +/** + * Source of Org creation + */ +union OrgCreationSource { + string, + + /** + * Org is created from LIFTR + */ + LIFTR: "LIFTR", + + /** + * Org is created from NEWRELIC + */ + NEWRELIC: "NEWRELIC", +} + +/** + * Source of Account creation + */ +union AccountCreationSource { + string, + + /** + * Account is created from LIFTR + */ + LIFTR: "LIFTR", + + /** + * Account is created from NEWRELIC + */ + NEWRELIC: "NEWRELIC", +} + +/** + * Billing source + */ +union BillingSource { + string, + + /** + * Billing source is Azure + */ + AZURE: "AZURE", + + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + NEWRELIC: "NEWRELIC", +} + +/** + * Indicates whether metrics are being sent. + */ +union SendMetricsStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * Valid actions for a filtering tag. Exclusion takes priority over inclusion. + */ +union TagAction { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Include: "Include", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Exclude: "Exclude", +} + +/** + * Indicates whether metrics are being sent. + */ +union SendingMetricsStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * Indicates whether logs are being sent. + */ +union SendingLogsStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * Indicates whether AAD logs are being sent. + */ +union SendAadLogsStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * Indicates whether subscription logs are being sent. + */ +union SendSubscriptionLogsStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * Indicates whether activity logs are being sent. + */ +union SendActivityLogsStatus { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Enabled: "Enabled", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Disabled: "Disabled", +} + +/** + * The operation for the patch on the resource. + */ +union PatchOperation { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AddBegin: "AddBegin", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + AddComplete: "AddComplete", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + DeleteBegin: "DeleteBegin", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + DeleteComplete: "DeleteComplete", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Active: "Active", +} + +/** + * The state of monitoring. + */ +union Status { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + InProgress: "InProgress", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Active: "Active", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Failed: "Failed", + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + Deleting: "Deleting", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +union ConfigurationName { + string, + #suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + default: "default", +} + +/** + * Localized display information for this particular operation. + */ +model OperationDisplay { + /** + * The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". + */ + @visibility(Lifecycle.Read) + provider?: string; + + /** + * The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". + */ + @visibility(Lifecycle.Read) + resource?: string; + + /** + * The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". + */ + @visibility(Lifecycle.Read) + operation?: string; + + /** + * The short, localized friendly description of the operation; suitable for tool tips and detailed views. + */ + @visibility(Lifecycle.Read) + description?: string; +} + +/** + * Response of get all accounts Operation. + */ +model AccountsListResponse is Azure.Core.Page; + +/** + * The details of a account resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model AccountResource extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * The resource-specific properties for this resource. + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + properties?: AccountProperties; +} + +/** + * List of all the New relic accounts for the given user + */ +model AccountProperties { + /** + * organization id + */ + organizationId?: string; + + /** + * account id + */ + accountId?: string; + + /** + * account name + */ + accountName?: string; + + /** + * Region where New Relic account is present + */ + region?: string; +} + +/** + * Properties specific to the NewRelic Monitor resource + */ +model MonitorProperties { + /** + * Provisioning State of the resource + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * MonitoringStatus of the resource + */ + @visibility(Lifecycle.Read) + monitoringStatus?: MonitoringStatus; + + /** + * NewRelic Organization properties of the resource + */ + @visibility(Lifecycle.Read) + marketplaceSubscriptionStatus?: MarketplaceSubscriptionStatus; + + /** + * Marketplace Subscription Id + */ + @visibility(Lifecycle.Read) + marketplaceSubscriptionId?: string; + + /** + * MarketplaceSubscriptionStatus of the resource + */ + newRelicAccountProperties?: NewRelicAccountProperties; + + /** + * User Info + */ + userInfo?: UserInfo; + + /** + * Plan details + */ + planData?: PlanData; + + /** + * SaaS details + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + saaSData?: SaaSData; + + /** + * Liftr resource category + */ + @visibility(Lifecycle.Read) + liftrResourceCategory?: LiftrResourceCategories; + + /** + * Liftr resource preference. The priority of the resource. + */ + @visibility(Lifecycle.Read) + liftrResourcePreference?: int32; + + /** + * Source of org creation + */ + orgCreationSource?: OrgCreationSource; + + /** + * Source of account creation + */ + accountCreationSource?: AccountCreationSource; + + /** + * State of the Azure Subscription containing the monitor resource + */ + subscriptionState?: string; + + /** + * Status of Azure Subscription where Marketplace SaaS is located. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + saaSAzureSubscriptionStatus?: string; +} + +/** + * Properties of the NewRelic account + */ +model NewRelicAccountProperties { + /** + * User id + */ + userId?: string; + + /** + * NewRelic Account Information + */ + accountInfo?: AccountInfo; + + /** + * NewRelic Organization Information + */ + organizationInfo?: OrganizationInfo; + + /** + * date when plan was applied + */ + singleSignOnProperties?: NewRelicSingleSignOnProperties; +} + +/** + * Account Info of the NewRelic account + */ +model AccountInfo { + /** + * Account id + */ + accountId?: string; + + /** + * Credential string. + */ + @secret + ingestionKey?: string; + + /** + * Region where New Relic account is present + */ + region?: string; +} + +/** + * Organization Info of the NewRelic account + */ +model OrganizationInfo { + /** + * Organization id + */ + organizationId?: string; +} + +/** + * Single sign on Info of the NewRelic account + */ +model NewRelicSingleSignOnProperties { + /** + * Single sign-on state + */ + singleSignOnState?: SingleSignOnStates; + + /** + * The Id of the Enterprise App used for Single sign-on. + */ + enterpriseAppId?: string; + + /** + * The login URL specific to this NewRelic Organization + */ + singleSignOnUrl?: string; + + /** + * Provisioning state + */ + provisioningState?: ProvisioningState; +} + +/** + * User Info of NewRelic Monitor resource + */ +model UserInfo { + /** + * First name + */ + @maxLength(50) + firstName?: string; + + /** + * Last name + */ + @maxLength(50) + lastName?: string; + + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + emailAddress?: string; + + /** + * Contact phone number + */ + @maxLength(40) + phoneNumber?: string; + + /** + * country if user + */ + country?: string; +} + +/** + * Plan data of NewRelic Monitor resource + */ +model PlanData { + /** + * Different usage type like PAYG/COMMITTED. this could be enum + */ + usageType?: UsageType; + + /** + * Different billing cycles like Monthly/Weekly. + */ + billingCycle?: string; + + /** + * plan id as published by NewRelic + */ + planDetails?: string; + + /** + * date when plan was applied + */ + // FIXME: (utcDateTime) Please double check that this is the correct type for your scenario. + effectiveDate?: utcDateTime; +} + +/** + * SaaS details + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model SaaSData { + /** + * SaaS resource id + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + saaSResourceId?: string; +} + +/** + * Response of get all organizations Operation. + */ +model OrganizationsListResponse is Azure.Core.Page; + +/** + * The details of a Organization resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model OrganizationResource + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * The resource-specific properties for this resource. + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + properties?: OrganizationProperties; +} + +/** + * Details of Organizations + */ +model OrganizationProperties { + /** + * organization id + */ + organizationId?: string; + + /** + * organization name + */ + organizationName?: string; + + /** + * Billing source + */ + billingSource?: BillingSource; +} + +/** + * Response of get all plan data Operation. + */ +model PlanDataListResponse is Azure.Core.Page; + +/** + * The details of a PlanData resource. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model PlanDataResource extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * The resource-specific properties for this resource. + */ + @visibility(Lifecycle.Read, Lifecycle.Create) + properties?: PlanDataProperties; +} + +/** + * Plan details + */ +model PlanDataProperties { + /** + * Plan details + */ + planData?: PlanData; + + /** + * Source of org creation + */ + orgCreationSource?: OrgCreationSource; + + /** + * Source of account creation + */ + accountCreationSource?: AccountCreationSource; +} + +/** + * SaaS guid & PublishedId for Activate and Validate SaaS Resource + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model ActivateSaaSParameterRequest { + /** + * SaaS guid for Activate and Validate SaaS Resource + */ + saasGuid: string; + + /** + * Publisher Id for NewRelic resource + */ + publisherId: string; +} + +/** + * Marketplace SaaS resource details. + */ +#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model SaaSResourceDetailsResponse + extends Azure.ResourceManager.CommonTypes.ProxyResource { + /** + * Id of the Marketplace SaaS Resource + */ + saasId?: string; +} + +/** + * The type used for update operations of the NewRelicMonitorResource. + */ +model NewRelicMonitorResourceUpdate { + /** + * The managed service identities assigned to this resource. + */ + identity?: Azure.ResourceManager.CommonTypes.ManagedServiceIdentity; + + /** + * Resource tags. + */ + #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + tags?: Record; + + /** + * The updatable properties of the NewRelicMonitorResource. + */ + properties?: NewRelicMonitorResourceUpdateProperties; +} + +/** + * The updatable properties of the NewRelicMonitorResource. + */ +model NewRelicMonitorResourceUpdateProperties { + /** + * MarketplaceSubscriptionStatus of the resource + */ + newRelicAccountProperties?: NewRelicAccountProperties; + + /** + * User Info + */ + userInfo?: UserInfo; + + /** + * Plan details + */ + planData?: PlanData; + + /** + * SaaS details + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + saaSData?: SaaSData; + + /** + * Source of org creation + */ + orgCreationSource?: OrgCreationSource; + + /** + * Source of account creation + */ + accountCreationSource?: AccountCreationSource; +} + +/** + * Request of get metrics Operation. + */ +model MetricsRequest { + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + userEmail: string; +} + +/** + * Set of rules for sending metrics for the Monitor resource. + */ +model MetricRules { + /** + * Flag specifying if metrics should be sent for the Monitor resource. + */ + sendMetrics?: SendMetricsStatus; + + /** + * List of filtering tags to be used for capturing metrics. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + filteringTags?: FilteringTag[]; + + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + userEmail?: string; +} + +/** + * The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored. + */ +model FilteringTag { + /** + * The name (also known as the key) of the tag. + */ + name?: string; + + /** + * The value of the tag. + */ + value?: string; + + /** + * Valid actions for a filtering tag. Exclusion takes priority over inclusion. + */ + action?: TagAction; +} + +/** + * Request of get metrics status Operation. + */ +model MetricsStatusRequest { + /** + * Azure resource IDs + */ + azureResourceIds?: string[]; + + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + userEmail: string; +} + +/** + * Response of get metrics status Operation. + */ +model MetricsStatusResponse { + /** + * Azure resource IDs + */ + azureResourceIds?: string[]; +} + +/** + * Request of a app services get Operation. + */ +model AppServicesGetRequest { + /** + * Azure resource IDs + */ + azureResourceIds?: string[]; + + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + userEmail: string; +} + +/** + * Response of a list app services Operation. + */ +model AppServicesListResponse is Azure.Core.Page; + +/** + * Details of VM Resource having NewRelic OneAgent installed + */ +model AppServiceInfo { + /** + * Azure App service resource ID + */ + azureResourceId?: string; + + /** + * Version of the NewRelic agent installed on the App service. + */ + agentVersion?: string; + + /** + * Status of the NewRelic agent installed on the App service. + */ + agentStatus?: string; +} + +/** + * Request of a switch billing Operation. + */ +model SwitchBillingRequest { + /** + * Azure resource Id + */ + azureResourceId?: string; + + /** + * Organization id + */ + organizationId?: string; + + /** + * Plan details + */ + planData?: PlanData; + + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + userEmail: string; +} + +/** + * Request of a Hosts get Operation. + */ +model HostsGetRequest { + /** + * VM resource IDs + */ + vmIds?: string[]; + + /** + * Reusable representation of an email address + */ + @pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") + userEmail: string; +} + +/** + * Response of a list VM Host Operation. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model VMHostsListResponse is Azure.Core.Page; + +/** + * Details of VM Resource having NewRelic OneAgent installed + */ +model VMInfo { + /** + * Azure VM resource ID + */ + vmId?: string; + + /** + * Version of the NewRelic agent installed on the VM. + */ + agentVersion?: string; + + /** + * Status of the NewRelic agent installed on the VM. + */ + agentStatus?: string; +} + +/** + * List of all the resources being monitored by NewRelic monitor resource + */ +model MonitoredResourceListResponse is Azure.Core.Page; + +/** + * Details of resource being monitored by NewRelic monitor resource + */ +model MonitoredResource { + /** + * The ARM id of the resource. + */ + id?: string; + + /** + * Flag indicating if resource is sending metrics to NewRelic. + */ + sendingMetrics?: SendingMetricsStatus; + + /** + * Reason for why the resource is sending metrics (or why it is not sending). + */ + reasonForMetricsStatus?: string; + + /** + * Flag indicating if resource is sending logs to NewRelic. + */ + sendingLogs?: SendingLogsStatus; + + /** + * Reason for why the resource is sending logs (or why it is not sending). + */ + reasonForLogsStatus?: string; +} + +/** + * Marketplace Subscription and Organization details to which resource gets billed into. + */ +model BillingInfoResponse { + /** + * Marketplace Subscription details + */ + marketplaceSaasInfo?: MarketplaceSaaSInfo; + + /** + * Partner Billing Entity details: Organization Info + */ + partnerBillingEntity?: PartnerBillingEntity; +} + +/** + * Marketplace SAAS Info of the resource. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model MarketplaceSaaSInfo { + /** + * Marketplace Subscription Id. This is a GUID-formatted string. + */ + marketplaceSubscriptionId?: string; + + /** + * Marketplace Subscription Details: SAAS Name + */ + marketplaceSubscriptionName?: string; + + /** + * Marketplace Subscription Details: Resource URI + */ + marketplaceResourceId?: string; + + /** + * Marketplace Subscription Details: SaaS Subscription Status + */ + marketplaceStatus?: string; + + /** + * The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. + */ + billedAzureSubscriptionId?: string; + + /** + * Publisher Id of the Marketplace offer. + */ + publisherId?: string; + + /** + * Offer Id of the Marketplace offer, + */ + offerId?: string; +} + +/** + * Partner Billing details associated with the resource. + */ +model PartnerBillingEntity { + /** + * The New Relic Organization Id. + */ + organizationId?: string; + + /** + * The New Relic Organization Name. + */ + organizationName?: string; +} + +/** + * List of all active newrelic deployments. + */ +model ConnectedPartnerResourcesListResponse + is Azure.Core.Page; + +/** + * Connected Partner Resources List Format + */ +model ConnectedPartnerResourcesListFormat { + /** + * Connected Partner Resource Properties + */ + properties?: ConnectedPartnerResourceProperties; +} + +/** + * Connected Partner Resource Properties + */ +model ConnectedPartnerResourceProperties { + /** + * NewRelic account name + */ + accountName?: string; + + /** + * NewRelic Account Id + */ + accountId?: string; + + /** + * The azure resource Id of the deployment. + */ + azureResourceId?: string; + + /** + * The location of the deployment. + */ + location?: string; +} + +/** + * The resource-specific properties for this resource. + */ +model MonitoringTagRulesProperties { + /** + * Provisioning State of the resource + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; + + /** + * Set of rules for sending logs for the Monitor resource. + */ + logRules?: LogRules; + + /** + * Set of rules for sending metrics for the Monitor resource. + */ + metricRules?: MetricRules; +} + +/** + * Set of rules for sending logs for the Monitor resource. + */ +model LogRules { + /** + * Flag specifying if AAD logs should be sent for the Monitor resource. + */ + sendAadLogs?: SendAadLogsStatus; + + /** + * Flag specifying if subscription logs should be sent for the Monitor resource. + */ + sendSubscriptionLogs?: SendSubscriptionLogsStatus; + + /** + * Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. + */ + sendActivityLogs?: SendActivityLogsStatus; + + /** + * List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. + * If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + filteringTags?: FilteringTag[]; +} + +/** + * The type used for update operations of the TagRule. + */ +model TagRuleUpdate { + /** + * The updatable properties of the TagRule. + */ + properties?: TagRuleUpdateProperties; +} + +/** + * The updatable properties of the TagRule. + */ +model TagRuleUpdateProperties { + /** + * Set of rules for sending logs for the Monitor resource. + */ + logRules?: LogRules; + + /** + * Set of rules for sending metrics for the Monitor resource. + */ + metricRules?: MetricRules; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model MonitoredSubscriptionPropertiesList + is Azure.Core.Page; + +/** + * The request to update subscriptions needed to be monitored by the NewRelic monitor resource. + */ +model SubscriptionList { + /** + * The operation for the patch on the resource. + */ + @visibility(Lifecycle.Create, Lifecycle.Update) + patchOperation?: PatchOperation; + + /** + * List of subscriptions and the state of the monitoring. + */ + @OpenAPI.extension("x-ms-identifiers", #[]) + monitoredSubscriptionList?: MonitoredSubscription[]; + + /** + * Provisioning State of the resource + */ + @visibility(Lifecycle.Read) + provisioningState?: ProvisioningState; +} + +/** + * The list of subscriptions and it's monitoring status by current NewRelic monitor. + */ +model MonitoredSubscription { + /** + * The subscriptionId to be monitored. + */ + subscriptionId?: string; + + /** + * The state of monitoring. + */ + status?: Status; + + /** + * The reason of not monitoring the subscription. + */ + error?: string; + + /** + * The resource-specific properties for this resource. + */ + tagRules?: MonitoringTagRulesProperties; +} + +/** + * Response of a list operation. + */ +model LinkedResourceListResponse is Azure.Core.Page; + +/** + * The definition of a linked resource. + */ +model LinkedResource { + /** + * The ARM id of the linked resource. + */ + id?: string; +} + +/** + * Response of payload to be passed while installing VM agent. + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model VMExtensionPayload { + /** + * Ingestion key of the account + */ + ingestionKey?: string; +} + +/** + * Response of get latest linked SaaS resource operation + */ +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +model LatestLinkedSaaSResponse { + /** + * SaaS resource id + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + saaSResourceId?: string; + + /** + * Flag indicating if the SaaS resource is hidden + */ + isHiddenSaaS?: boolean; +} + +/** + * Resubscribe Properties + */ +model ResubscribeProperties { + /** + * Newly selected plan Id to create the new Marketplace subscription for Resubscribe + */ + planId?: string; + + /** + * Newly selected term Id to create the new Marketplace subscription for Resubscribe + */ + termId?: string; + + /** + * Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe + */ + subscriptionId?: string; + + /** + * Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe + */ + resourceGroup?: string; + + /** + * Organization Id of the NewRelic Organization that needs to be resubscribed + */ + organizationId?: string; + + /** + * Publisher Id of the NewRelic offer that needs to be resubscribed + */ + publisherId?: string; + + /** + * Offer Id of the NewRelic offer that needs to be resubscribed + */ + offerId?: string; +} + +/** + * App services Get Parameter specification. + */ +model AppServicesGetParameter { + /** + * The details of the app services get request. + */ + request: AppServicesGetRequest; +} + +/** + * Switch Billing Parameter specification. + */ +model SwitchBillingParameter { + /** + * The details of the switch billing request. + */ + request: SwitchBillingRequest; +} + +/** + * Host Get Parameter specification. + */ +model HostsGetParameter { + /** + * The details of the Hosts get request. + */ + request: HostsGetRequest; +} + +/** + * Get Metrics Status Parameter specification. + */ +model MetricsRequestParameter { + /** + * The details of the get metrics status request. + */ + request: MetricsRequest; +} + +/** + * Get Metrics Status Parameter specification. + */ +model MetricsStatusRequestParameter { + /** + * The details of the get metrics status request. + */ + request: MetricsStatusRequest; +} + +/** + * Reusable representation of an email address + */ +@pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") +@mediaTypeHint("application/json") +scalar email extends string; + +@@OpenAPI.extension(AppServicesListResponse.value, + "x-ms-identifiers", + #["azureResourceId"] +); +@@visibility(NewRelicMonitorResource.properties, + Lifecycle.Read, + Lifecycle.Create +); +@@visibility(TagRule.properties, Lifecycle.Read, Lifecycle.Create); diff --git a/specification/newrelic/NewRelicObservability.Management/routes.tsp b/specification/newrelic/NewRelicObservability.Management/routes.tsp new file mode 100644 index 000000000000..b1a97a5802b0 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/routes.tsp @@ -0,0 +1,112 @@ +// FIXME: Operations in this file are not detected as a resource operation, please confirm the conversion result manually + +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.ResourceManager; + +namespace NewRelic.Observability; + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface AccountsOperationGroup { + /** + * Lists all the New Relic accounts linked to your email address, helping you understand the existing accounts that have been created + */ + @autoRoute + @get + @list + @action("accounts") + list is ArmProviderActionSync< + Response = AccountsListResponse, + Scope = SubscriptionActionScope, + Parameters = { + /** + * User Email. + */ + @query("userEmail") + userEmail: string; + + /** + * Location for NewRelic. + */ + @query("location") + location: string; + } + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface OrganizationsOperationGroup { + /** + * Lists all the New Relic organizations linked to your email address, helping you understand the existing organizations that have been created + */ + @autoRoute + @get + @list + @action("organizations") + list is ArmProviderActionSync< + Response = OrganizationsListResponse, + Scope = SubscriptionActionScope, + Parameters = { + /** + * User Email. + */ + @query("userEmail") + userEmail: string; + + /** + * Location for NewRelic. + */ + @query("location") + location: string; + } + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface PlansOperationGroup { + /** + * Lists the plans data linked to your organization, providing an overview of the available plans + */ + @autoRoute + @get + @list + @action("plans") + list is ArmProviderActionSync< + Response = PlanDataListResponse, + Scope = SubscriptionActionScope, + Parameters = { + /** + * Account Id. + */ + @query("accountId") + accountId?: string; + + /** + * Organization Id. + */ + @query("organizationId") + organizationId?: string; + } + >; +} + +#suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +#suppress "@azure-tools/typespec-azure-core/casing-style" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" +interface SaaSOperationGroup { + /** + * Resolve the token to get the SaaS resource ID and activate the SaaS resource + */ + @autoRoute + @action("activateSaaS") + activateResource is ArmProviderActionSync< + Request = ActivateSaaSParameterRequest, + Response = SaaSResourceDetailsResponse, + Scope = SubscriptionActionScope, + Parameters = {} + >; +} diff --git a/specification/newrelic/NewRelicObservability.Management/tspconfig.yaml b/specification/newrelic/NewRelicObservability.Management/tspconfig.yaml new file mode 100644 index 000000000000..be0012a94be0 --- /dev/null +++ b/specification/newrelic/NewRelicObservability.Management/tspconfig.yaml @@ -0,0 +1,53 @@ +parameters: + "service-dir": + default: "sdk/newrelic" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/NewRelic.json" + examples-dir: "{project-root}/examples" + emit-lro-options: "all" + "@azure-typespec/http-client-csharp-mgmt": + emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" + package-name: "Azure.ResourceManager.NewRelicObservability" + namespace: "{package-name}" + "@azure-tools/typespec-python": + service-dir: "sdk/newrelicobservability" + emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-newrelicobservability" + namespace: "azure.mgmt.newrelicobservability" + generate-test: true + generate-sample: true + flavor: "azure" + "@azure-tools/typespec-java": + service-dir: "sdk/newrelicobservability" + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-newrelicobservability" + namespace: "com.azure.resourcemanager.newrelicobservability" + service-name: "NewRelic Observability" + flavor: azure + "@azure-tools/typespec-ts": + service-dir: "sdk/newrelicobservability" + emitter-output-dir: "{output-dir}/{service-dir}/arm-newrelicobservability" + is-modular-library: true + flavor: "azure" + experimental-extensible-enums: true + typespec-title-map: + ObservabilityClient: NewRelicObservability + package-details: + name: "@azure/arm-newrelicobservability" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/newrelic" + emitter-output-dir: "{output-dir}/{service-dir}/armnewrelicobservability" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/armnewrelicobservability" + fix-const-stuttering: true + flavor: "azure" + generate-samples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json index 7ff45203df36..c90faea52860 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2022-07-01-preview", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2022-07-01-preview" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-10-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-10-01-preview/NewRelic.json index fe2056a6b6e1..eb73050ef902 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-10-01-preview/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-10-01-preview/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2023-10-01-preview", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2023-10-01-preview" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json index cd20659352df..81ec62312f16 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2023-11-01-preview/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2023-11-01-preview", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2023-11-01-preview" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json index bff3dd30842a..474c16bf2542 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2024-01-01-preview/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2024-01-01-preview", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2024-01-01-preview" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/NewRelic.json index f3fff6492fee..744d131b7f52 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/NewRelic.json @@ -3,9 +3,9 @@ "info": { "title": "NewRelic.Observability", "version": "2025-05-01-preview", - "x-cadl-generated": [ + "x-typespec-generated": [ { - "emitter": "@azure-tools/cadl-autorest" + "emitter": "@azure-tools/typespec-autorest" } ] }, @@ -29,7 +29,7 @@ "securityDefinitions": { "azure_auth": { "type": "oauth2", - "description": "Microsoft Entra ID OAuth2 Flow.", + "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { @@ -42,28 +42,22 @@ "name": "Operations" }, { - "name": "Monitors" + "name": "NewRelicMonitorResources" }, { - "name": "Accounts" - }, - { - "name": "Organizations" - }, - { - "name": "Plan" + "name": "TagRules" }, { - "name": "TagRules" + "name": "MonitoredSubscriptions" } ], "paths": { "/providers/NewRelic.Observability/operations": { "get": { + "operationId": "Operations_List", "tags": [ "Operations" ], - "operationId": "Operations_List", "description": "List the operations for the provider", "parameters": [ { @@ -72,7 +66,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" } @@ -84,9 +78,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Operations_List_MaximumSet_Gen": { "$ref": "./examples/Operations_List_MaximumSet_Gen.json" @@ -94,14 +85,14 @@ "Operations_List_MinimumSet_Gen": { "$ref": "./examples/Operations_List_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/accounts": { "get": { - "tags": [ - "Accounts" - ], "operationId": "Accounts_List", "description": "Lists all the New Relic accounts linked to your email address, helping you understand the existing accounts that have been created", "parameters": [ @@ -112,15 +103,23 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/UserEmailParameter" + "name": "userEmail", + "in": "query", + "description": "User Email.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/LocationParameter" + "name": "location", + "in": "query", + "description": "Location for NewRelic.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AccountsListResponse" } @@ -132,9 +131,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Accounts_List_MaximumSet_Gen": { "$ref": "./examples/Accounts_List_MaximumSet_Gen.json" @@ -142,15 +138,60 @@ "Accounts_List_MinimumSet_Gen": { "$ref": "./examples/Accounts_List_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/activateSaaS": { + "post": { + "operationId": "SaaS_ActivateResource", + "description": "Resolve the token to get the SaaS resource ID and activate the SaaS resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "request", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ActivateSaaSParameterRequest" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/SaaSResourceDetailsResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ActivateSaaS": { + "$ref": "./examples/ActivateSaaS.json" + } } } }, "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/monitors": { "get": { + "operationId": "Monitors_ListBySubscription", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_ListBySubscription", "description": "Lists all New Relic monitor resources either within a specific subscription", "parameters": [ { @@ -162,7 +203,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NewRelicMonitorResourceListResult" } @@ -174,21 +215,18 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Monitors_ListBySubscription_MaximumSet_Gen": { "$ref": "./examples/Monitors_ListBySubscription_MaximumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/organizations": { "get": { - "tags": [ - "Organizations" - ], "operationId": "Organizations_List", "description": "Lists all the New Relic organizations linked to your email address, helping you understand the existing organizations that have been created", "parameters": [ @@ -199,15 +237,23 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/UserEmailParameter" + "name": "userEmail", + "in": "query", + "description": "User Email.", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/LocationParameter" + "name": "location", + "in": "query", + "description": "Location for NewRelic.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/OrganizationsListResponse" } @@ -219,9 +265,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Organizations_List_MaximumSet_Gen": { "$ref": "./examples/Organizations_List_MaximumSet_Gen.json" @@ -229,14 +272,14 @@ "Organizations_List_MinimumSet_Gen": { "$ref": "./examples/Organizations_List_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/plans": { "get": { - "tags": [ - "Plan" - ], "operationId": "Plans_List", "description": "Lists the plans data linked to your organization, providing an overview of the available plans", "parameters": [ @@ -247,15 +290,23 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/AccountIdParameter" + "name": "accountId", + "in": "query", + "description": "Account Id.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/OrganizationIdParameter" + "name": "organizationId", + "in": "query", + "description": "Organization Id.", + "required": false, + "type": "string" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PlanDataListResponse" } @@ -267,9 +318,6 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Plans_List_MaximumSet_Gen": { "$ref": "./examples/Plans_List_MaximumSet_Gen.json" @@ -277,54 +325,18 @@ "Plans_List_MinimumSet_Gen": { "$ref": "./examples/Plans_List_MinimumSet_Gen.json" } - } - } - }, - "/subscriptions/{subscriptionId}/providers/NewRelic.Observability/activateSaaS": { - "post": { - "tags": [ - "SaaS" - ], - "operationId": "SaaS_ActivateResource", - "description": "Resolve the token to get the SaaS resource ID and activate the SaaS resource", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/ActivateSaaSParameter" - } - ], - "responses": { - "200": { - "description": "Activate SaaS completed successfully.", - "schema": { - "$ref": "#/definitions/SaaSResourceDetailsResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" - } - } }, - "x-ms-examples": { - "ActivateSaaS": { - "$ref": "./examples/ActivateSaaS.json" - } + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors": { "get": { + "operationId": "Monitors_ListByResourceGroup", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_ListByResourceGroup", "description": "Retrieves a list of all New Relic monitor resources either a specific resource group", "parameters": [ { @@ -339,7 +351,7 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NewRelicMonitorResourceListResult" } @@ -351,22 +363,22 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { "Monitors_ListByResourceGroup_MaximumSet_Gen": { "$ref": "./examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}": { "get": { + "operationId": "Monitors_Get", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_Get", "description": "Retrieves the properties and configuration details of a specific New Relic monitor resource, providing insight into its setup and status", "parameters": [ { @@ -381,14 +393,15 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NewRelicMonitorResource" } @@ -407,10 +420,10 @@ } }, "put": { + "operationId": "Monitors_CreateOrUpdate", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_CreateOrUpdate", "description": "Creates a new or updates an existing New Relic monitor resource in your Azure subscription. This sets up the integration between Azure and your New Relic account, enabling observability and monitoring of your Azure resources through New Relic", "parameters": [ { @@ -425,15 +438,16 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { "name": "resource", "in": "body", - "required": true, "description": "Resource create parameters.", + "required": true, "schema": { "$ref": "#/definitions/NewRelicMonitorResource" } @@ -441,22 +455,26 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'NewRelicMonitorResource' update operation succeeded", "schema": { "$ref": "#/definitions/NewRelicMonitorResource" } }, "201": { - "description": "ARM create operation completed successfully.", + "description": "Resource 'NewRelicMonitorResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/NewRelicMonitorResource" + }, "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "schema": { - "$ref": "#/definitions/NewRelicMonitorResource" } }, "default": { @@ -472,15 +490,16 @@ } }, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/NewRelicMonitorResource" }, "x-ms-long-running-operation": true }, "patch": { + "operationId": "Monitors_Update", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_Update", "description": "Updates an existing New Relic monitor resource from your Azure subscription", "parameters": [ { @@ -495,15 +514,16 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { "name": "properties", "in": "body", - "required": true, "description": "The resource properties to be updated.", + "required": true, "schema": { "$ref": "#/definitions/NewRelicMonitorResourceUpdate" } @@ -511,16 +531,22 @@ ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/NewRelicMonitorResource" } }, "202": { - "description": "ARM operation accepted.", + "description": "Resource update request accepted.", "headers": { "Location": { - "type": "string" + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, @@ -531,18 +557,22 @@ } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { "Monitors_Update_MaximumSet_Gen": { "$ref": "./examples/Monitors_Update_MaximumSet_Gen.json" } - } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/NewRelicMonitorResource" + }, + "x-ms-long-running-operation": true }, "delete": { + "operationId": "Monitors_Delete", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_Delete", "description": "Deletes an existing New Relic monitor resource from your Azure subscription, removing the integration and stopping the observability of your Azure resources through New Relic", "parameters": [ { @@ -554,14 +584,19 @@ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, - { - "$ref": "#/parameters/UserEmailParameter" - }, { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", + "required": true, + "type": "string", + "pattern": "^.*$" + }, + { + "name": "userEmail", + "in": "query", + "description": "User Email.", + "required": true, "type": "string" } ], @@ -572,15 +607,19 @@ "202": { "description": "Resource deletion accepted.", "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { - "description": "Resource deleted successfully." + "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", @@ -603,13 +642,14 @@ "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricRules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getBillingInfo": { "post": { + "operationId": "BillingInfo_Get", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_GetMetricRules", - "description": "Retrieves the metric rules that are configured in the New Relic monitor resource", + "summary": "Retrieves marketplace and organization information mapped to the given New Relic monitor resource", + "description": "A synchronous resource action.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -623,19 +663,17 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" - }, - { - "$ref": "#/parameters/MetricsRequestParameter" + "required": true, + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/MetricRules" + "$ref": "#/definitions/BillingInfoResponse" } }, "default": { @@ -646,22 +684,19 @@ } }, "x-ms-examples": { - "Monitors_GetMetricRules_MaximumSet_Gen": { - "$ref": "./examples/Monitors_GetMetricRules_MaximumSet_Gen.json" - }, - "Monitors_GetMetricRules_MinimumSet_Gen": { - "$ref": "./examples/Monitors_GetMetricRules_MinimumSet_Gen.json" + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricStatus": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricRules": { "post": { + "operationId": "Monitors_GetMetricRules", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_GetMetricStatus", - "description": "Retrieves the metric status that are configured in the New Relic monitor resource", + "description": "Retrieves the metric rules that are configured in the New Relic monitor resource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -675,19 +710,26 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "$ref": "#/parameters/MetricsStatusRequestParameter" + "name": "request", + "in": "body", + "description": "The details of the get metrics status request.", + "required": true, + "schema": { + "$ref": "#/definitions/MetricsRequest" + } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/MetricsStatusResponse" + "$ref": "#/definitions/MetricRules" } }, "default": { @@ -698,22 +740,22 @@ } }, "x-ms-examples": { - "Monitors_GetMetricStatus_MaximumSet_Gen": { - "$ref": "./examples/Monitors_GetMetricStatus_MaximumSet_Gen.json" + "Monitors_GetMetricRules_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MaximumSet_Gen.json" }, - "Monitors_GetMetricStatus_MinimumSet_Gen": { - "$ref": "./examples/Monitors_GetMetricStatus_MinimumSet_Gen.json" + "Monitors_GetMetricRules_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricRules_MinimumSet_Gen.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listAppServices": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getMetricStatus": { "post": { + "operationId": "Monitors_GetMetricStatus", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_ListAppServices", - "description": "Lists the app service resources currently being monitored by the New Relic resource, helping you understand which app services are under monitoring", + "description": "Retrieves the metric status that are configured in the New Relic monitor resource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -727,19 +769,26 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "$ref": "#/parameters/AppServicesGetParameter" + "name": "request", + "in": "body", + "description": "The details of the get metrics status request.", + "required": true, + "schema": { + "$ref": "#/definitions/MetricsStatusRequest" + } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/AppServicesListResponse" + "$ref": "#/definitions/MetricsStatusResponse" } }, "default": { @@ -749,26 +798,23 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Monitors_ListAppServices_MaximumSet_Gen": { - "$ref": "./examples/Monitors_ListAppServices_MaximumSet_Gen.json" + "Monitors_GetMetricStatus_MaximumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MaximumSet_Gen.json" }, - "Monitors_ListAppServices_MinimumSet_Gen": { - "$ref": "./examples/Monitors_ListAppServices_MinimumSet_Gen.json" + "Monitors_GetMetricStatus_MinimumSet_Gen": { + "$ref": "./examples/Monitors_GetMetricStatus_MinimumSet_Gen.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/switchBilling": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/latestLinkedSaaS": { "post": { + "operationId": "Monitors_LatestLinkedSaaS", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_SwitchBilling", - "description": "Switches the billing for the New Relic Monitor resource to be billed by Azure Marketplace", + "description": "Returns the latest SaaS linked to the newrelic organization of the underlying monitor.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -782,34 +828,19 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" - }, - { - "$ref": "#/parameters/SwitchBillingParameter" + "required": true, + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/NewRelicMonitorResource" - } - }, - "202": { - "description": "Resource operation accepted.", - "headers": { - "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", - "type": "integer", - "format": "int32" - } + "$ref": "#/definitions/LatestLinkedSaaSResponse" } }, - "204": { - "description": "There is no content to send for this request, but the headers may be useful. " - }, "default": { "description": "An unexpected error response.", "schema": { @@ -818,22 +849,23 @@ } }, "x-ms-examples": { - "Monitors_SwitchBilling_MaximumSet_Gen": { - "$ref": "./examples/Monitors_SwitchBilling_MaximumSet_Gen.json" + "Monitors_LatestLinkedSaaS_MaximumSet_Gen": { + "$ref": "./examples/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json" }, - "Monitors_SwitchBilling_MinimumSet_Gen": { - "$ref": "./examples/Monitors_SwitchBilling_MinimumSet_Gen.json" + "Monitors_LatestLinkedSaaS_MinimumSet_Gen": { + "$ref": "./examples/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listHosts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/linkSaaS": { "post": { + "operationId": "Monitors_LinkSaaS", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_ListHosts", - "description": "Lists all VM resources currently being monitored by the New Relic monitor resource, helping you manage observability", + "summary": "Links a new SaaS to the newrelic organization of the underlying monitor.", + "description": "Links a new SaaS to the newrelic organization of the underlying monitor.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -847,19 +879,45 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "$ref": "#/parameters/HostsGetParameter" + "name": "body", + "in": "body", + "description": "Link SaaS body parameter", + "required": true, + "schema": { + "$ref": "#/definitions/SaaSData" + } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/VMHostsListResponse" + "$ref": "#/definitions/NewRelicMonitorResource" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { @@ -869,26 +927,25 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Monitors_ListHosts_MaximumSet_Gen": { - "$ref": "./examples/Monitors_ListHosts_MaximumSet_Gen.json" - }, - "Monitors_ListHosts_MinimumSet_Gen": { - "$ref": "./examples/Monitors_ListHosts_MinimumSet_Gen.json" + "Monitors_LinkSaaS": { + "$ref": "./examples/Monitors_LinkSaaS.json" } - } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/NewRelicMonitorResource" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/refreshIngestionKey": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listAppServices": { "post": { + "operationId": "Monitors_ListAppServices", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_RefreshIngestionKey", - "description": "Refreshes the ingestion key for all monitors linked to the same account associated to the underlying monitor.", + "description": "Lists the app service resources currently being monitored by the New Relic resource, helping you understand which app services are under monitoring", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -902,14 +959,27 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" + }, + { + "name": "request", + "in": "body", + "description": "The details of the app services get request.", + "required": true, + "schema": { + "$ref": "#/definitions/AppServicesGetRequest" + } } ], "responses": { - "204": { - "description": "Successfully refreshed the ingestion key." + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppServicesListResponse" + } }, "default": { "description": "An unexpected error response.", @@ -919,19 +989,26 @@ } }, "x-ms-examples": { - "Monitors_RefreshIngestionKey": { - "$ref": "./examples/Monitors_RefreshIngestionKey.json" + "Monitors_ListAppServices_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MaximumSet_Gen.json" + }, + "Monitors_ListAppServices_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListAppServices_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredResources": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listConnectedPartnerResources": { "post": { + "operationId": "ConnectedPartnerResources_List", "tags": [ - "Monitors" + "NewRelicMonitorResources" ], - "operationId": "Monitors_ListMonitoredResources", - "description": "Lists all Azure resources that are currently being monitored by the specified New Relic monitor resource, providing insight into the coverage of your observability setup", + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "description": "A synchronous resource action.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -945,16 +1022,26 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" + }, + { + "name": "body", + "in": "body", + "description": "Email Id of the user", + "required": false, + "schema": { + "$ref": "#/definitions/email" + } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/MonitoredResourceListResponse" + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" } }, "default": { @@ -964,29 +1051,23 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Monitors_ListMonitoredResources_MaximumSet_Gen": { - "$ref": "./examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json" - }, - "Monitors_ListMonitoredResources_MinimumSet_Gen": { - "$ref": "./examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json" + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/getBillingInfo": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listHosts": { "post": { + "operationId": "Monitors_ListHosts", "tags": [ - "ConnectedResources" - ], - "summary": "Retrieves marketplace and organization information mapped to the given New Relic monitor resource", - "operationId": "BillingInfo_Get", - "produces": [ - "application/json" + "NewRelicMonitorResources" ], + "description": "Lists all VM resources currently being monitored by the New Relic monitor resource, helping you manage observability", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1000,17 +1081,26 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "pattern": "^.*$", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" + }, + { + "name": "request", + "in": "body", + "description": "The details of the Hosts get request.", + "required": true, + "schema": { + "$ref": "#/definitions/HostsGetRequest" + } } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/BillingInfoResponse" + "$ref": "#/definitions/VMHostsListResponse" } }, "default": { @@ -1021,22 +1111,26 @@ } }, "x-ms-examples": { - "BillingInfo_Get": { - "$ref": "./examples/BillingInfo_Get.json" + "Monitors_ListHosts_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MaximumSet_Gen.json" + }, + "Monitors_ListHosts_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListHosts_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listConnectedPartnerResources": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listLinkedResources": { "post": { + "operationId": "Monitors_ListLinkedResources", "tags": [ - "ConnectedResources" - ], - "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", - "operationId": "ConnectedPartnerResources_List", - "produces": [ - "application/json" + "NewRelicMonitorResources" ], + "summary": "Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration", + "description": "Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1050,25 +1144,17 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "pattern": "^.*$", - "type": "string" - }, - { - "in": "body", - "name": "body", - "description": "Email Id of the user", - "schema": { - "$ref": "#/definitions/email" - } + "required": true, + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + "$ref": "#/definitions/LinkedResourceListResponse" } }, "default": { @@ -1078,23 +1164,23 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "ConnectedPartnerResources_List": { - "$ref": "./examples/ConnectedPartnerResources_List.json" + "Monitors_ListLinkedResources": { + "$ref": "./examples/LinkedResources_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredResources": { + "post": { + "operationId": "Monitors_ListMonitoredResources", "tags": [ - "TagRules" + "NewRelicMonitorResources" ], - "operationId": "TagRules_ListByNewRelicMonitorResource", - "description": "Lists all tag rules associated with a specific New Relic monitor resource, helping you manage and audit the rules that control resource monitoring", + "description": "Lists all Azure resources that are currently being monitored by the specified New Relic monitor resource, providing insight into the coverage of your observability setup", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1108,16 +1194,17 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/TagRuleListResult" + "$ref": "#/definitions/MonitoredResourceListResponse" } }, "default": { @@ -1127,26 +1214,27 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen": { - "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json" + "Monitors_ListMonitoredResources_MaximumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json" }, - "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen": { - "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json" + "Monitors_ListMonitoredResources_MinimumSet_Gen": { + "$ref": "./examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules/{ruleSetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions": { "get": { + "operationId": "MonitoredSubscriptions_List", "tags": [ - "TagRules" + "MonitoredSubscriptions" ], - "operationId": "TagRules_Get", - "description": "Retrieves the details of the tag rules for a specific New Relic monitor resource, providing insight into its setup and status", + "summary": "Lists all the subscriptions currently being monitored by the NewRelic monitor resource.", + "description": "List MonitoredSubscriptionProperties resources by NewRelicMonitorResource", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1160,23 +1248,17 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" - }, - { - "name": "ruleSetName", - "in": "path", "required": true, - "description": "Name of the TagRule", - "type": "string" + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/TagRule" + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" } }, "default": { @@ -1187,20 +1269,23 @@ } }, "x-ms-examples": { - "TagRules_Get_MaximumSet_Gen": { - "$ref": "./examples/TagRules_Get_MaximumSet_Gen.json" - }, - "TagRules_Get_MinimumSet_Gen": { - "$ref": "./examples/TagRules_Get_MinimumSet_Gen.json" + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "operationId": "MonitoredSubscriptions_Get", "tags": [ - "TagRules" + "MonitoredSubscriptions" ], - "operationId": "TagRules_CreateOrUpdate", - "description": "Creates a new set of tag rules for a specific New Relic monitor resource, determining which Azure resources are monitored based on their tags", + "summary": "Lists all the subscriptions currently being monitored by the NewRelic monitor resource.", + "description": "Get a MonitoredSubscriptionProperties", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1214,45 +1299,37 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" - }, - { - "name": "ruleSetName", - "in": "path", "required": true, - "description": "Name of the TagRule", - "type": "string" + "type": "string", + "pattern": "^.*$" }, { - "name": "resource", - "in": "body", + "name": "configurationName", + "in": "path", + "description": "The configuration name. Only 'default' value is supported.", "required": true, - "description": "Resource create parameters.", - "schema": { - "$ref": "#/definitions/TagRule" + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ConfigurationName", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default" + } + ] } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", - "schema": { - "$ref": "#/definitions/TagRule" - } - }, - "201": { - "description": "ARM create operation completed successfully.", - "headers": { - "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", - "type": "integer", - "format": "int32" - } - }, + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/TagRule" + "$ref": "#/definitions/MonitoredSubscriptionProperties" } }, "default": { @@ -1263,24 +1340,18 @@ } }, "x-ms-examples": { - "TagRules_CreateOrUpdate_MaximumSet_Gen": { - "$ref": "./examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json" - }, - "TagRules_CreateOrUpdate_MinimumSet_Gen": { - "$ref": "./examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json" + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" } - }, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-long-running-operation": true + } }, - "delete": { + "put": { + "operationId": "MonitoredSubscriptions_CreateOrUpdate", "tags": [ - "TagRules" + "MonitoredSubscriptions" ], - "operationId": "TagRules_Delete", - "description": "Deletes a tag rule set for a given New Relic monitor resource, removing fine-grained control over observability based on resource tags", + "summary": "Add subscriptions to be monitored by the New Relic monitor resource, enabling observability and monitoring.", + "description": "Create a MonitoredSubscriptionProperties", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1294,35 +1365,65 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "name": "ruleSetName", + "name": "configurationName", "in": "path", + "description": "The configuration name. Only 'default' value is supported.", "required": true, - "description": "Name of the TagRule", - "type": "string" + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ConfigurationName", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default" + } + ] + } + }, + { + "name": "body", + "in": "body", + "description": "", + "required": false, + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } } ], "responses": { "200": { - "description": "Resource deleted successfully." + "description": "Resource 'MonitoredSubscriptionProperties' update operation succeeded", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } }, - "202": { - "description": "Resource deletion accepted.", + "201": { + "description": "Resource 'MonitoredSubscriptionProperties' create operation succeeded", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + }, "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, "Retry-After": { - "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", "type": "integer", - "format": "int32" + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, - "204": { - "description": "Resource deleted successfully." - }, "default": { "description": "An unexpected error response.", "schema": { @@ -1331,24 +1432,23 @@ } }, "x-ms-examples": { - "TagRules_Delete_MaximumSet_Gen": { - "$ref": "./examples/TagRules_Delete_MaximumSet_Gen.json" - }, - "TagRules_Delete_MinimumSet_Gen": { - "$ref": "./examples/TagRules_Delete_MinimumSet_Gen.json" + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "final-state-via": "location", + "final-state-schema": "#/definitions/MonitoredSubscriptionProperties" }, "x-ms-long-running-operation": true }, "patch": { + "operationId": "MonitoredSubscriptions_Update", "tags": [ - "TagRules" + "MonitoredSubscriptions" ], - "operationId": "TagRules_Update", - "description": "Updates the tag rules for a specific New Relic monitor resource, allowing you to modify the rules that control which Azure resources are monitored", + "summary": "Update subscriptions to be monitored by the New Relic monitor resource, ensuring optimal observability and performance", + "description": "Update a MonitoredSubscriptionProperties", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1362,32 +1462,60 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "name": "ruleSetName", + "name": "configurationName", "in": "path", + "description": "The configuration name. Only 'default' value is supported.", "required": true, - "description": "Name of the TagRule", - "type": "string" + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ConfigurationName", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default" + } + ] + } }, { - "name": "properties", + "name": "body", "in": "body", - "required": true, - "description": "The resource properties to be updated.", + "description": "", + "required": false, "schema": { - "$ref": "#/definitions/TagRuleUpdate" + "$ref": "#/definitions/MonitoredSubscriptionProperties" } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/TagRule" + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { @@ -1398,26 +1526,27 @@ } }, "x-ms-examples": { - "TagRules_Update_MaximumSet_Gen": { - "$ref": "./examples/TagRules_Update_MaximumSet_Gen.json" - }, - "TagRules_Update_MinimumSet_Gen": { - "$ref": "./examples/TagRules_Update_MinimumSet_Gen.json" + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions": { - "get": { + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/MonitoredSubscriptionProperties" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MonitoredSubscriptions_Delete", "tags": [ - "monitoredSubscriptions" - ], - "summary": "Lists all the subscriptions currently being monitored by the NewRelic monitor resource.", - "operationId": "MonitoredSubscriptions_List", - "produces": [ - "application/json" + "MonitoredSubscriptions" ], + "summary": "Delete subscriptions being monitored by the New Relic monitor resource, removing their observability and monitoring capabilities", + "description": "Delete a MonitoredSubscriptionProperties", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1427,50 +1556,79 @@ { "name": "monitorName", "in": "path", - "required": true, - "pattern": "^.*$", "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "name": "configurationName", + "in": "path", + "description": "The configuration name. Only 'default' value is supported.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ConfigurationName", + "modelAsString": true, + "values": [ + { + "name": "default", + "value": "default" + } + ] + } } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, + "204": { + "description": "Resource does not exist." + }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Monitors_GetMonitoredSubscriptions": { - "$ref": "./examples/MonitoredSubscriptions_List.json" + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" } - } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/refreshIngestionKey": { + "post": { + "operationId": "Monitors_RefreshIngestionKey", "tags": [ - "monitoredSubscriptions" - ], - "summary": "Lists all the subscriptions currently being monitored by the NewRelic monitor resource.", - "operationId": "MonitoredSubscriptions_Get", - "produces": [ - "application/json" + "NewRelicMonitorResources" ], + "description": "Refreshes the ingestion key for all monitors linked to the same account associated to the underlying monitor.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1480,63 +1638,42 @@ { "name": "monitorName", "in": "path", - "required": true, - "pattern": "^.*$", "description": "Name of the Monitors resource", - "type": "string" - }, - { - "description": "The configuration name. Only 'default' value is supported.", - "in": "path", - "name": "configurationName", - "pattern": "^.*$", "required": true, "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "configurationName", - "modelAsString": true - } - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "pattern": "^.*$" } ], "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" - } + "204": { + "description": "There is no content to send for this request, but the headers may be useful." }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Monitors_GetMonitoredSubscriptions": { - "$ref": "./examples/MonitoredSubscriptions_Get.json" + "Monitors_RefreshIngestionKey": { + "$ref": "./examples/Monitors_RefreshIngestionKey.json" } } - }, - "put": { - "tags": [ - "monitoredSubscriptions" - ], - "summary": "Add subscriptions to be monitored by the New Relic monitor resource, enabling observability and monitoring.", - "operationId": "MonitoredSubscriptions_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/resubscribe": { + "post": { + "operationId": "Monitors_Resubscribe", + "tags": [ + "NewRelicMonitorResources" ], + "summary": "Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace", + "description": "A long-running resource action.", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1546,74 +1683,77 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "pattern": "^.*$", - "type": "string" - }, - { - "description": "The configuration name. Only 'default' value is supported.", - "in": "path", - "name": "configurationName", - "pattern": "^.*$", "required": true, "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "configurationName", - "modelAsString": true - } + "pattern": "^.*$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", "name": "body", + "in": "body", + "description": "Resubscribe Properties", + "required": false, "schema": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" + "$ref": "#/definitions/ResubscribeProperties" } } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" + "$ref": "#/definitions/NewRelicMonitorResource" } }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "format": "uri", + "description": "A link to the status monitor" + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Monitors_AddMonitoredSubscriptions": { - "$ref": "./examples/MonitoredSubscriptions_CreateOrUpdate.json" + "Monitors_Resubscribe": { + "$ref": "./examples/Monitors_Resubscribe.json" } - } - }, - "patch": { + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/NewRelicMonitorResource" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/switchBilling": { + "post": { + "operationId": "Monitors_SwitchBilling", "tags": [ - "MonitoredSubscriptions" - ], - "summary": "Update subscriptions to be monitored by the New Relic monitor resource, ensuring optimal observability and performance", - "operationId": "MonitoredSubscriptions_Update", - "produces": [ - "application/json" + "NewRelicMonitorResources" ], + "description": "Switches the billing for the New Relic Monitor resource to be billed by Azure Marketplace", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1623,76 +1763,62 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "pattern": "^.*$", - "type": "string" - }, - { - "description": "The configuration name. Only 'default' value is supported.", - "in": "path", - "name": "configurationName", - "pattern": "^.*$", "required": true, "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "configurationName", - "modelAsString": true - } - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "pattern": "^.*$" }, { + "name": "request", "in": "body", - "name": "body", + "description": "The details of the switch billing request.", + "required": true, "schema": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" + "$ref": "#/definitions/SwitchBillingRequest" } } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" + "$ref": "#/definitions/NewRelicMonitorResource" } }, "202": { - "headers": { - "Location": { - "type": "string" - } - }, - "description": "Success" + "description": "The request has been accepted for processing, but processing has not yet completed." + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful." }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Monitors_UpdateMonitoredSubscriptions": { - "$ref": "./examples/MonitoredSubscriptions_Update.json" + "Monitors_SwitchBilling_MaximumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MaximumSet_Gen.json" + }, + "Monitors_SwitchBilling_MinimumSet_Gen": { + "$ref": "./examples/Monitors_SwitchBilling_MinimumSet_Gen.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules": { + "get": { + "operationId": "TagRules_ListByNewRelicMonitorResource", "tags": [ - "MonitoredSubscriptions" - ], - "summary": "Delete subscriptions being monitored by the New Relic monitor resource, removing their observability and monitoring capabilities", - "operationId": "MonitoredSubscriptions_Delete", - "produces": [ - "application/json" + "TagRules" ], + "description": "Lists all tag rules associated with a specific New Relic monitor resource, helping you manage and audit the rules that control resource monitoring", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1702,68 +1828,50 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", - "pattern": "^.*$", - "type": "string" - }, - { - "description": "The configuration name. Only 'default' value is supported.", - "in": "path", - "name": "configurationName", - "pattern": "^.*$", "required": true, "type": "string", - "enum": [ - "default" - ], - "x-ms-enum": { - "name": "configurationName", - "modelAsString": true - } - }, - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "pattern": "^.*$" } ], "responses": { - "202": { - "headers": { - "Location": { - "type": "string" - } - }, - "description": "Success" - }, - "204": { - "description": "Success" + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/TagRuleListResult" + } }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Monitors_DeleteMonitoredSubscriptions": { - "$ref": "./examples/MonitoredSubscriptions_Delete.json" + "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json" + }, + "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen": { + "$ref": "./examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/listLinkedResources": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/tagRules/{ruleSetName}": { + "get": { + "operationId": "TagRules_Get", "tags": [ - "LinkedResources" - ], - "summary": "Lists all Azure resources that are linked to the same New Relic organization as the specified monitor resource, helping you understand the scope of integration", - "operationId": "Monitors_ListLinkedResources", - "produces": [ - "application/json" + "TagRules" ], + "description": "Retrieves the details of the tag rules for a specific New Relic monitor resource, providing insight into its setup and status", "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, @@ -1773,46 +1881,48 @@ { "name": "monitorName", "in": "path", - "required": true, - "pattern": "^.*$", "description": "Name of the Monitors resource", - "type": "string" + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + "name": "ruleSetName", + "in": "path", + "description": "Name of the TagRule", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/LinkedResourceListResponse" + "$ref": "#/definitions/TagRule" } }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Monitors_ListLinkedResources": { - "$ref": "./examples/LinkedResources_List.json" + "TagRules_Get_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Get_MaximumSet_Gen.json" + }, + "TagRules_Get_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Get_MinimumSet_Gen.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/vmHostPayloads": { - "post": { + }, + "put": { + "operationId": "TagRules_CreateOrUpdate", "tags": [ - "Monitors" + "TagRules" ], - "operationId": "Monitors_VmHostPayload", - "description": "Returns the payload that needs to be passed in the request body for installing the New Relic agent on a VM, providing the necessary configuration details", + "description": "Creates a new set of tag rules for a specific New Relic monitor resource, determining which Azure resources are monitored based on their tags", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1826,16 +1936,50 @@ { "name": "monitorName", "in": "path", - "required": true, "description": "Name of the Monitors resource", + "required": true, + "type": "string", + "pattern": "^.*$" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the TagRule", + "required": true, "type": "string" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TagRule" + } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Resource 'TagRule' update operation succeeded", "schema": { - "$ref": "#/definitions/VMExtensionPayload" + "$ref": "#/definitions/TagRule" + } + }, + "201": { + "description": "Resource 'TagRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/TagRule" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } } }, "default": { @@ -1846,41 +1990,65 @@ } }, "x-ms-examples": { - "Monitors_VmHostPayload_MaximumSet_Gen": { - "$ref": "./examples/Monitors_VmHostPayload_MaximumSet_Gen.json" + "TagRules_CreateOrUpdate_MaximumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json" }, - "Monitors_VmHostPayload_MinimumSet_Gen": { - "$ref": "./examples/Monitors_VmHostPayload_MinimumSet_Gen.json" + "TagRules_CreateOrUpdate_MinimumSet_Gen": { + "$ref": "./examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json" } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/latestLinkedSaaS": { - "post": { + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation", + "final-state-schema": "#/definitions/TagRule" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "TagRules_Update", "tags": [ - "LatestLinkedSaaS" + "TagRules" ], - "operationId": "Monitors_LatestLinkedSaaS", - "description": "Returns the latest SaaS linked to the newrelic organization of the underlying monitor.", + "description": "Updates the tag rules for a specific New Relic monitor resource, allowing you to modify the rules that control which Azure resources are monitored", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "monitorName", + "in": "path", + "description": "Name of the Monitors resource", + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + "name": "ruleSetName", + "in": "path", + "description": "Name of the TagRule", + "required": true, + "type": "string" }, { - "$ref": "#/parameters/MonitorNameParameter" + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/TagRuleUpdate" + } } ], "responses": { "200": { - "description": "ARM operation completed successfully.", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/LatestLinkedSaaSResponse" + "$ref": "#/definitions/TagRule" } }, "default": { @@ -1891,28 +2059,20 @@ } }, "x-ms-examples": { - "Monitors_LatestLinkedSaaS_MaximumSet_Gen": { - "$ref": "./examples/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json" + "TagRules_Update_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Update_MaximumSet_Gen.json" }, - "Monitors_LatestLinkedSaaS_MinimumSet_Gen": { - "$ref": "./examples/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json" + "TagRules_Update_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Update_MinimumSet_Gen.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/linkSaaS": { - "post": { + }, + "delete": { + "operationId": "TagRules_Delete", "tags": [ - "LinkSaaS" - ], - "summary": "Links a new SaaS to the newrelic organization of the underlying monitor.", - "operationId": "Monitors_LinkSaaS", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "TagRules" ], + "description": "Deletes a tag rule set for a given New Relic monitor resource, removing fine-grained control over observability based on resource tags", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1924,64 +2084,70 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/MonitorNameParameter" + "name": "monitorName", + "in": "path", + "description": "Name of the Monitors resource", + "required": true, + "type": "string", + "pattern": "^.*$" }, { - "in": "body", - "name": "body", - "description": "Link SaaS body parameter", + "name": "ruleSetName", + "in": "path", + "description": "Name of the TagRule", "required": true, - "schema": { - "$ref": "#/definitions/SaaSData" - } + "type": "string" } ], "responses": { "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/NewRelicMonitorResource" - } + "description": "Resource deleted successfully." }, "202": { + "description": "Resource deletion accepted.", "headers": { - "Location": { - "type": "string" + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } - }, - "description": "Accepted" + } + }, + "204": { + "description": "Resource does not exist." }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, + "x-ms-examples": { + "TagRules_Delete_MaximumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MaximumSet_Gen.json" + }, + "TagRules_Delete_MinimumSet_Gen": { + "$ref": "./examples/TagRules_Delete_MinimumSet_Gen.json" + } + }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, - "x-ms-examples": { - "Monitors_LinkSaaS": { - "$ref": "./examples/Monitors_LinkSaaS.json" - } - } + "x-ms-long-running-operation": true } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/resubscribe": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/vmHostPayloads": { "post": { + "operationId": "Monitors_VmHostPayload", "tags": [ - "Resubscribe" - ], - "summary": "Resubscribes the New Relic Organization of the underline Monitor Resource to be billed by Azure Marketplace", - "operationId": "Monitors_Resubscribe", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" + "NewRelicMonitorResources" ], + "description": "Returns the payload that needs to be passed in the request body for installing the New Relic agent on a VM, providing the necessary configuration details", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" @@ -1993,46 +2159,34 @@ "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/MonitorNameParameter" - }, - { - "in": "body", - "name": "body", - "description": "Resubscribe Properties", - "schema": { - "$ref": "#/definitions/ResubscribeProperties" - } + "name": "monitorName", + "in": "path", + "description": "Name of the Monitors resource", + "required": true, + "type": "string", + "pattern": "^.*$" } ], "responses": { "200": { - "description": "Success", + "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/NewRelicMonitorResource" + "$ref": "#/definitions/VMExtensionPayload" } }, - "202": { - "headers": { - "Location": { - "type": "string" - } - }, - "description": "Accepted" - }, "default": { - "description": "Default error response.", + "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, "x-ms-examples": { - "Monitors_Resubscribe": { - "$ref": "./examples/Monitors_Resubscribe.json" + "Monitors_VmHostPayload_MaximumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MaximumSet_Gen.json" + }, + "Monitors_VmHostPayload_MinimumSet_Gen": { + "$ref": "./examples/Monitors_VmHostPayload_MinimumSet_Gen.json" } } } @@ -2063,31 +2217,29 @@ ] } }, - "AccountIdParameter": { - "type": "object", - "properties": {}, - "description": "Account Id parameter" - }, "AccountInfo": { "type": "object", + "description": "Account Info of the NewRelic account", "properties": { "accountId": { "type": "string", "description": "Account id" }, "ingestionKey": { - "$ref": "#/definitions/SecureString", - "description": "ingestion key of account" + "type": "string", + "format": "password", + "description": "Credential string.", + "x-ms-secret": true }, "region": { "type": "string", "description": "Region where New Relic account is present" } - }, - "description": "Account Info of the NewRelic account" + } }, "AccountProperties": { "type": "object", + "description": "List of all the New relic accounts for the given user", "properties": { "organizationId": { "type": "string", @@ -2105,145 +2257,11 @@ "type": "string", "description": "Region where New Relic account is present" } - }, - "description": "List of all the New relic accounts for the given user" - }, - "AccountsListResponse": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AccountResource" - }, - "x-cadl-name": "AccountResource[]", - "description": "The AccountResource items on this page" - }, - "nextLink": { - "type": "string", - "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" - } - }, - "description": "Response of get all accounts Operation.", - "required": [ - "value" - ] - }, - "BillingInfoResponse": { - "description": "Marketplace Subscription and Organization details to which resource gets billed into.", - "type": "object", - "properties": { - "marketplaceSaasInfo": { - "description": "Marketplace Subscription details", - "$ref": "#/definitions/MarketplaceSaaSInfo" - }, - "partnerBillingEntity": { - "description": "Partner Billing Entity details: Organization Info", - "$ref": "#/definitions/PartnerBillingEntity" - } - } - }, - "MarketplaceSaaSInfo": { - "description": "Marketplace SAAS Info of the resource.", - "type": "object", - "properties": { - "marketplaceSubscriptionId": { - "description": "Marketplace Subscription Id. This is a GUID-formatted string.", - "type": "string" - }, - "marketplaceSubscriptionName": { - "description": "Marketplace Subscription Details: SAAS Name", - "type": "string" - }, - "marketplaceResourceId": { - "description": "Marketplace Subscription Details: Resource URI", - "type": "string" - }, - "marketplaceStatus": { - "description": "Marketplace Subscription Details: SaaS Subscription Status", - "type": "string" - }, - "billedAzureSubscriptionId": { - "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", - "type": "string" - }, - "publisherId": { - "description": "Publisher Id of the Marketplace offer.", - "type": "string" - }, - "offerId": { - "description": "Offer Id of the Marketplace offer,", - "type": "string" - } - } - }, - "PartnerBillingEntity": { - "description": "Partner Billing details associated with the resource.", - "type": "object", - "properties": { - "organizationId": { - "description": "The New Relic Organization Id.", - "type": "string" - }, - "organizationName": { - "description": "The New Relic Organization Name.", - "type": "string" - } - } - }, - "ConnectedPartnerResourceProperties": { - "description": "Connected Partner Resource Properties", - "type": "object", - "properties": { - "accountName": { - "description": "NewRelic account name", - "type": "string" - }, - "accountId": { - "description": "NewRelic Account Id", - "type": "string" - }, - "azureResourceId": { - "description": "The azure resource Id of the deployment.", - "type": "string" - }, - "location": { - "description": "The location of the deployment.", - "type": "string" - } - } - }, - "ConnectedPartnerResourcesListFormat": { - "description": "Connected Partner Resources List Format", - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/ConnectedPartnerResourceProperties" - } - } - }, - "ConnectedPartnerResourcesListResponse": { - "description": " List of all active newrelic deployments.", - "type": "object", - "properties": { - "value": { - "description": "Results of a list operation.", - "type": "array", - "items": { - "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" - }, - "x-ms-identifiers": [] - }, - "nextLink": { - "description": "Link to the next set of results, if any.", - "type": "string" - } } }, "AccountResource": { "type": "object", + "description": "The details of a account resource.", "properties": { "properties": { "$ref": "#/definitions/AccountProperties", @@ -2255,129 +2273,128 @@ ] } }, - "description": "The details of a account resource.", "allOf": [ { "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, - "AppServiceInfo": { + "AccountsListResponse": { "type": "object", + "description": "Response of get all accounts Operation.", "properties": { - "azureResourceId": { - "type": "string", - "description": "Azure App service resource ID" - }, - "agentVersion": { - "type": "string", - "description": "Version of the NewRelic agent installed on the App service." + "value": { + "type": "array", + "description": "The AccountResource items on this page", + "items": { + "$ref": "#/definitions/AccountResource" + } }, - "agentStatus": { + "nextLink": { "type": "string", - "description": "Status of the NewRelic agent installed on the App service." - } - }, - "description": "Details of VM Resource having NewRelic OneAgent installed" - }, - "AppServicesGetParameter": { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/AppServicesGetRequest", - "description": "The details of the app services get request." + "format": "uri", + "description": "The link to the next page of items" } }, - "description": "App services Get Parameter specification.", "required": [ - "request" + "value" ] }, - "SwitchBillingParameter": { + "ActivateSaaSParameterRequest": { "type": "object", + "description": "SaaS guid & PublishedId for Activate and Validate SaaS Resource", "properties": { - "request": { - "$ref": "#/definitions/SwitchBillingRequest", - "description": "The details of the switch billing request." + "saasGuid": { + "type": "string", + "description": "SaaS guid for Activate and Validate SaaS Resource" + }, + "publisherId": { + "type": "string", + "description": "Publisher Id for NewRelic resource" } }, - "description": "Switch Billing Parameter specification.", "required": [ - "request" + "saasGuid", + "publisherId" ] }, - "SwitchBillingRequest": { + "AppServiceInfo": { "type": "object", + "description": "Details of VM Resource having NewRelic OneAgent installed", "properties": { "azureResourceId": { "type": "string", - "description": "Azure resource Id" + "description": "Azure App service resource ID" }, - "organizationId": { + "agentVersion": { "type": "string", - "description": "Organization id" - }, - "planData": { - "$ref": "#/definitions/PlanData", - "description": "Plan details" + "description": "Version of the NewRelic agent installed on the App service." }, - "userEmail": { - "$ref": "#/definitions/email", - "description": "User Email" + "agentStatus": { + "type": "string", + "description": "Status of the NewRelic agent installed on the App service." } - }, - "description": "Request of a switch billing Operation.", - "required": [ - "userEmail" - ] + } }, "AppServicesGetRequest": { "type": "object", + "description": "Request of a app services get Operation.", "properties": { "azureResourceIds": { "type": "array", + "description": "Azure resource IDs", "items": { "type": "string" - }, - "x-cadl-name": "string[]", - "description": "Azure resource IDs" + } }, "userEmail": { - "$ref": "#/definitions/email", - "description": "User Email" + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" } }, - "description": "Request of a app services get Operation.", "required": [ "userEmail" ] }, "AppServicesListResponse": { "type": "object", + "description": "Response of a list app services Operation.", "properties": { "value": { "type": "array", + "description": "The AppServiceInfo items on this page", "items": { "$ref": "#/definitions/AppServiceInfo" }, "x-ms-identifiers": [ "azureResourceId" - ], - "x-cadl-name": "AppServiceInfo[]", - "description": "The AppServiceInfo items on this page" + ] }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Response of a list app services Operation.", "required": [ "value" ] }, + "BillingInfoResponse": { + "type": "object", + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "properties": { + "marketplaceSaasInfo": { + "$ref": "#/definitions/MarketplaceSaaSInfo", + "description": "Marketplace Subscription details" + }, + "partnerBillingEntity": { + "$ref": "#/definitions/PartnerBillingEntity", + "description": "Partner Billing Entity details: Organization Info" + } + } + }, "BillingSource": { "type": "string", "description": "Billing source", @@ -2401,8 +2418,62 @@ ] } }, + "ConnectedPartnerResourceProperties": { + "type": "object", + "description": "Connected Partner Resource Properties", + "properties": { + "accountName": { + "type": "string", + "description": "NewRelic account name" + }, + "accountId": { + "type": "string", + "description": "NewRelic Account Id" + }, + "azureResourceId": { + "type": "string", + "description": "The azure resource Id of the deployment." + }, + "location": { + "type": "string", + "description": "The location of the deployment." + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "type": "object", + "description": "Connected Partner Resources List Format", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties", + "description": "Connected Partner Resource Properties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "type": "object", + "description": "List of all active newrelic deployments.", + "properties": { + "value": { + "type": "array", + "description": "The ConnectedPartnerResourcesListFormat items on this page", + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, "FilteringTag": { "type": "object", + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", "properties": { "name": { "type": "string", @@ -2416,43 +2487,43 @@ "$ref": "#/definitions/TagAction", "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion." } - }, - "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored." - }, - "HostsGetParameter": { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/HostsGetRequest", - "description": "The details of the Hosts get request." - } - }, - "description": "Host Get Parameter specification.", - "required": [ - "request" - ] + } }, "HostsGetRequest": { "type": "object", + "description": "Request of a Hosts get Operation.", "properties": { "vmIds": { "type": "array", + "description": "VM resource IDs", "items": { "type": "string" - }, - "x-cadl-name": "string[]", - "description": "VM resource IDs" + } }, "userEmail": { - "$ref": "#/definitions/email", - "description": "User Email" + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" } }, - "description": "Request of a Hosts get Operation.", "required": [ "userEmail" ] }, + "LatestLinkedSaaSResponse": { + "type": "object", + "description": "Response of get latest linked SaaS resource operation", + "properties": { + "saaSResourceId": { + "type": "string", + "description": "SaaS resource id" + }, + "isHiddenSaaS": { + "type": "boolean", + "description": "Flag indicating if the SaaS resource is hidden" + } + } + }, "LiftrResourceCategories": { "type": "string", "description": "Liftr Resource category.", @@ -2462,34 +2533,53 @@ ], "x-ms-enum": { "name": "LiftrResourceCategories", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "MonitorLogs", + "value": "MonitorLogs" + } + ] } }, - "LocationParameter": { + "LinkedResource": { "type": "object", - "properties": {}, - "description": "Location for NewRelic resource" + "description": "The definition of a linked resource.", + "properties": { + "id": { + "type": "string", + "description": "The ARM id of the linked resource." + } + } }, - "ActivateSaaSParameterRequest": { + "LinkedResourceListResponse": { "type": "object", - "description": "SaaS guid & PublishedId for Activate and Validate SaaS Resource", + "description": "Response of a list operation.", "properties": { - "saasGuid": { - "type": "string", - "description": "SaaS guid for Activate and Validate SaaS Resource" + "value": { + "type": "array", + "description": "The LinkedResource items on this page", + "items": { + "$ref": "#/definitions/LinkedResource" + } }, - "publisherId": { + "nextLink": { "type": "string", - "description": "Publisher Id for NewRelic resource" + "format": "uri", + "description": "The link to the next page of items" } }, "required": [ - "saasGuid", - "publisherId" + "value" ] }, "LogRules": { "type": "object", + "description": "Set of rules for sending logs for the Monitor resource.", "properties": { "sendAadLogs": { "$ref": "#/definitions/SendAadLogsStatus", @@ -2505,15 +2595,47 @@ }, "filteringTags": { "type": "array", + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.\nIf only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", "items": { "$ref": "#/definitions/FilteringTag" }, - "x-ms-identifiers": [], - "x-cadl-name": "FilteringTag[]", - "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.\nIf only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags." + "x-ms-identifiers": [] } - }, - "description": "Set of rules for sending logs for the Monitor resource." + } + }, + "MarketplaceSaaSInfo": { + "type": "object", + "description": "Marketplace SAAS Info of the resource.", + "properties": { + "marketplaceSubscriptionId": { + "type": "string", + "description": "Marketplace Subscription Id. This is a GUID-formatted string." + }, + "marketplaceSubscriptionName": { + "type": "string", + "description": "Marketplace Subscription Details: SAAS Name" + }, + "marketplaceResourceId": { + "type": "string", + "description": "Marketplace Subscription Details: Resource URI" + }, + "marketplaceStatus": { + "type": "string", + "description": "Marketplace Subscription Details: SaaS Subscription Status" + }, + "billedAzureSubscriptionId": { + "type": "string", + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into." + }, + "publisherId": { + "type": "string", + "description": "Publisher Id of the Marketplace offer." + }, + "offerId": { + "type": "string", + "description": "Offer Id of the Marketplace offer," + } + } }, "MarketplaceSubscriptionStatus": { "type": "string", @@ -2541,6 +2663,7 @@ }, "MetricRules": { "type": "object", + "description": "Set of rules for sending metrics for the Monitor resource.", "properties": { "sendMetrics": { "$ref": "#/definitions/SendMetricsStatus", @@ -2548,96 +2671,70 @@ }, "filteringTags": { "type": "array", + "description": "List of filtering tags to be used for capturing metrics.", "items": { "$ref": "#/definitions/FilteringTag" }, - "x-ms-identifiers": [], - "x-cadl-name": "FilteringTag[]", - "description": "List of filtering tags to be used for capturing metrics." + "x-ms-identifiers": [] }, "userEmail": { - "$ref": "#/definitions/email", - "description": "User Email" + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" } - }, - "description": "Set of rules for sending metrics for the Monitor resource." + } }, "MetricsRequest": { "type": "object", + "description": "Request of get metrics Operation.", "properties": { "userEmail": { - "$ref": "#/definitions/email", - "description": "User Email" + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" } }, - "description": "Request of get metrics Operation.", "required": [ "userEmail" ] }, - "MetricsRequestParameter": { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/MetricsRequest", - "description": "The details of the get metrics status request." - } - }, - "description": "Get Metrics Status Parameter specification.", - "required": [ - "request" - ] - }, "MetricsStatusRequest": { "type": "object", + "description": "Request of get metrics status Operation.", "properties": { "azureResourceIds": { "type": "array", + "description": "Azure resource IDs", "items": { "type": "string" - }, - "x-cadl-name": "string[]", - "description": "Azure resource IDs" + } }, "userEmail": { - "$ref": "#/definitions/email", - "description": "User Email" + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" } }, - "description": "Request of get metrics status Operation.", "required": [ "userEmail" ] }, - "MetricsStatusRequestParameter": { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/MetricsStatusRequest", - "description": "The details of the get metrics status request." - } - }, - "description": "Get Metrics Status Parameter specification.", - "required": [ - "request" - ] - }, "MetricsStatusResponse": { "type": "object", + "description": "Response of get metrics status Operation.", "properties": { "azureResourceIds": { "type": "array", + "description": "Azure resource IDs", "items": { "type": "string" - }, - "x-cadl-name": "string[]", - "description": "Azure resource IDs" + } } - }, - "description": "Response of get metrics status Operation." + } }, "MonitorProperties": { "type": "object", + "description": "Properties specific to the NewRelic Monitor resource", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", @@ -2695,18 +2792,18 @@ "description": "Source of account creation" }, "subscriptionState": { - "description": "State of the Azure Subscription containing the monitor resource", - "type": "string" + "type": "string", + "description": "State of the Azure Subscription containing the monitor resource" }, "saaSAzureSubscriptionStatus": { - "description": "Status of Azure Subscription where Marketplace SaaS is located.", - "type": "string" + "type": "string", + "description": "Status of Azure Subscription where Marketplace SaaS is located." } - }, - "description": "Properties specific to the NewRelic Monitor resource" + } }, "MonitoredResource": { "type": "object", + "description": "Details of resource being monitored by NewRelic monitor resource", "properties": { "id": { "type": "string", @@ -2720,36 +2817,91 @@ "type": "string", "description": "Reason for why the resource is sending metrics (or why it is not sending)." }, - "sendingLogs": { - "$ref": "#/definitions/SendingLogsStatus", - "description": "Flag indicating if resource is sending logs to NewRelic." + "sendingLogs": { + "$ref": "#/definitions/SendingLogsStatus", + "description": "Flag indicating if resource is sending logs to NewRelic." + }, + "reasonForLogsStatus": { + "type": "string", + "description": "Reason for why the resource is sending logs (or why it is not sending)." + } + } + }, + "MonitoredResourceListResponse": { + "type": "object", + "description": "List of all the resources being monitored by NewRelic monitor resource", + "properties": { + "value": { + "type": "array", + "description": "The MonitoredResource items on this page", + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MonitoredSubscription": { + "type": "object", + "description": "The list of subscriptions and it's monitoring status by current NewRelic monitor.", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscriptionId to be monitored." + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The state of monitoring." }, - "reasonForLogsStatus": { + "error": { "type": "string", - "description": "Reason for why the resource is sending logs (or why it is not sending)." + "description": "The reason of not monitoring the subscription." + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties", + "description": "The resource-specific properties for this resource." + } + } + }, + "MonitoredSubscriptionProperties": { + "type": "object", + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SubscriptionList", + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource." } }, - "description": "Details of resource being monitored by NewRelic monitor resource" + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] }, - "MonitoredResourceListResponse": { + "MonitoredSubscriptionPropertiesList": { "type": "object", + "description": "Paged collection of MonitoredSubscriptionProperties items", "properties": { "value": { "type": "array", + "description": "The MonitoredSubscriptionProperties items on this page", "items": { - "$ref": "#/definitions/MonitoredResource" - }, - "x-cadl-name": "MonitoredResource[]", - "description": "The MonitoredResource items on this page" + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "List of all the resources being monitored by NewRelic monitor resource", "required": [ "value" ] @@ -2780,6 +2932,7 @@ }, "MonitoringTagRulesProperties": { "type": "object", + "description": "The resource-specific properties for this resource.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", @@ -2794,11 +2947,11 @@ "$ref": "#/definitions/MetricRules", "description": "Set of rules for sending metrics for the Monitor resource." } - }, - "description": "The resource-specific properties for this resource." + } }, "NewRelicAccountProperties": { "type": "object", + "description": "Properties of the NewRelic account", "properties": { "userId": { "type": "string", @@ -2816,11 +2969,11 @@ "$ref": "#/definitions/NewRelicSingleSignOnProperties", "description": "date when plan was applied" } - }, - "description": "Properties of the NewRelic account" + } }, "NewRelicMonitorResource": { "type": "object", + "description": "A Monitor Resource by NewRelic", "properties": { "properties": { "$ref": "#/definitions/MonitorProperties", @@ -2832,11 +2985,10 @@ ] }, "identity": { - "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." } }, - "description": "A Monitor Resource by NewRelic", "required": [ "properties" ], @@ -2848,51 +3000,50 @@ }, "NewRelicMonitorResourceListResult": { "type": "object", + "description": "The response of a NewRelicMonitorResource list operation.", "properties": { "value": { "type": "array", + "description": "The NewRelicMonitorResource items on this page", "items": { "$ref": "#/definitions/NewRelicMonitorResource" - }, - "x-cadl-name": "NewRelicMonitorResource[]", - "description": "The NewRelicMonitorResource items on this page" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a NewRelicMonitorResource list operation.", "required": [ "value" ] }, "NewRelicMonitorResourceUpdate": { "type": "object", + "description": "The type used for update operations of the NewRelicMonitorResource.", "properties": { "identity": { - "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "tags": { "type": "object", + "description": "Resource tags.", "additionalProperties": { "type": "string" - }, - "x-cadl-name": "Record", - "description": "Resource tags." + } }, "properties": { "$ref": "#/definitions/NewRelicMonitorResourceUpdateProperties", + "description": "The updatable properties of the NewRelicMonitorResource.", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the NewRelicMonitorResource." + } }, "NewRelicMonitorResourceUpdateProperties": { "type": "object", + "description": "The updatable properties of the NewRelicMonitorResource.", "properties": { "newRelicAccountProperties": { "$ref": "#/definitions/NewRelicAccountProperties", @@ -2918,11 +3069,11 @@ "$ref": "#/definitions/AccountCreationSource", "description": "Source of account creation" } - }, - "description": "The updatable properties of the NewRelicMonitorResource." + } }, "NewRelicSingleSignOnProperties": { "type": "object", + "description": "Single sign on Info of the NewRelic account", "properties": { "singleSignOnState": { "$ref": "#/definitions/SingleSignOnStates", @@ -2940,8 +3091,7 @@ "$ref": "#/definitions/ProvisioningState", "description": "Provisioning state" } - }, - "description": "Single sign on Info of the NewRelic account" + } }, "OrgCreationSource": { "type": "string", @@ -2967,23 +3117,19 @@ ] } }, - "OrganizationIdParameter": { - "type": "object", - "properties": {}, - "description": "Organization Id parameter" - }, "OrganizationInfo": { "type": "object", + "description": "Organization Info of the NewRelic account", "properties": { "organizationId": { "type": "string", "description": "Organization id" } - }, - "description": "Organization Info of the NewRelic account" + } }, "OrganizationProperties": { "type": "object", + "description": "Details of Organizations", "properties": { "organizationId": { "type": "string", @@ -2997,54 +3143,103 @@ "$ref": "#/definitions/BillingSource", "description": "Billing source" } + } + }, + "OrganizationResource": { + "type": "object", + "description": "The details of a Organization resource.", + "properties": { + "properties": { + "$ref": "#/definitions/OrganizationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } }, - "description": "Details of Organizations" + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] }, "OrganizationsListResponse": { "type": "object", + "description": "Response of get all organizations Operation.", "properties": { "value": { "type": "array", + "description": "The OrganizationResource items on this page", "items": { "$ref": "#/definitions/OrganizationResource" - }, - "x-cadl-name": "OrganizationResource[]", - "description": "The OrganizationResource items on this page" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Response of get all organizations Operation.", "required": [ "value" ] }, - "OrganizationResource": { + "PartnerBillingEntity": { "type": "object", + "description": "Partner Billing details associated with the resource.", "properties": { - "properties": { - "$ref": "#/definitions/OrganizationProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "description": "The details of a Organization resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + "organizationId": { + "type": "string", + "description": "The New Relic Organization Id." + }, + "organizationName": { + "type": "string", + "description": "The New Relic Organization Name." } - ] + } + }, + "PatchOperation": { + "type": "string", + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "x-ms-enum": { + "name": "PatchOperation", + "modelAsString": true, + "values": [ + { + "name": "AddBegin", + "value": "AddBegin" + }, + { + "name": "AddComplete", + "value": "AddComplete" + }, + { + "name": "DeleteBegin", + "value": "DeleteBegin" + }, + { + "name": "DeleteComplete", + "value": "DeleteComplete" + }, + { + "name": "Active", + "value": "Active" + } + ] + } }, "PlanData": { "type": "object", + "description": "Plan data of NewRelic Monitor resource", "properties": { "usageType": { "$ref": "#/definitions/UsageType", @@ -3063,79 +3258,32 @@ "format": "date-time", "description": "date when plan was applied" } - }, - "description": "Plan data of NewRelic Monitor resource" - }, - "SaaSData": { - "type": "object", - "properties": { - "saaSResourceId": { - "type": "string", - "description": "SaaS resource id" - } - }, - "description": "SaaS details" - }, - "SaaSResourceDetailsResponse": { - "type": "object", - "properties": { - "saasId": { - "type": "string", - "description": "Id of the Marketplace SaaS Resource" - } - }, - "description": "Marketplace SaaS resource details.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] - }, - "PlanDataResource": { - "type": "object", - "properties": { - "properties": { - "$ref": "#/definitions/PlanDataProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true, - "x-ms-mutability": [ - "read", - "create" - ] - } - }, - "description": "The details of a PlanData resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ] + } }, "PlanDataListResponse": { "type": "object", + "description": "Response of get all plan data Operation.", "properties": { "value": { "type": "array", + "description": "The PlanDataResource items on this page", "items": { "$ref": "#/definitions/PlanDataResource" - }, - "x-cadl-name": "PlanDataResource[]", - "description": "The PlanDataResource items on this page" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Response of get all plan data Operation.", "required": [ "value" ] }, "PlanDataProperties": { "type": "object", + "description": "Plan details", "properties": { "planData": { "$ref": "#/definitions/PlanData", @@ -3147,149 +3295,29 @@ }, "accountCreationSource": { "$ref": "#/definitions/AccountCreationSource", - "description": "Source of account creation" - } - }, - "description": "Plan details" - }, - "MonitoredSubscription": { - "description": "The list of subscriptions and it's monitoring status by current NewRelic monitor.", - "type": "object", - "properties": { - "subscriptionId": { - "description": "The subscriptionId to be monitored.", - "required": [ - "subscriptionId" - ], - "type": "string" - }, - "status": { - "description": "The state of monitoring.", - "enum": [ - "InProgress", - "Active", - "Failed", - "Deleting" - ], - "x-ms-enum": { - "modelAsString": true, - "name": "Status" - }, - "type": "string" - }, - "error": { - "description": "The reason of not monitoring the subscription.", - "type": "string" - }, - "tagRules": { - "$ref": "#/definitions/MonitoringTagRulesProperties" - } - } - }, - "SubscriptionList": { - "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", - "type": "object", - "properties": { - "patchOperation": { - "description": "The operation for the patch on the resource.", - "enum": [ - "AddBegin", - "AddComplete", - "DeleteBegin", - "DeleteComplete", - "Active" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "PatchOperation" - }, - "x-ms-mutability": [ - "create", - "update" - ] - }, - "monitoredSubscriptionList": { - "description": "List of subscriptions and the state of the monitoring.", - "type": "array", - "items": { - "$ref": "#/definitions/MonitoredSubscription" - }, - "x-ms-identifiers": [] - }, - "provisioningState": { - "$ref": "#/definitions/ProvisioningState", - "description": "Provisioning State of the resource", - "readOnly": true - } - } - }, - "MonitoredSubscriptionProperties": { - "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "name": { - "description": "Name of the monitored subscription resource.", - "type": "string", - "readOnly": true - }, - "id": { - "description": "The id of the monitored subscription resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the monitored subscription resource.", - "type": "string", - "readOnly": true - }, - "properties": { - "$ref": "#/definitions/SubscriptionList" - } - } - }, - "MonitoredSubscriptionPropertiesList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/MonitoredSubscriptionProperties" - } - }, - "nextLink": { - "type": "string", - "description": "The link to the next page of items" - } - } - }, - "LinkedResource": { - "description": "The definition of a linked resource.", - "type": "object", - "properties": { - "id": { - "description": "The ARM id of the linked resource.", - "type": "string" + "description": "Source of account creation" } } }, - "LinkedResourceListResponse": { - "description": "Response of a list operation.", + "PlanDataResource": { "type": "object", + "description": "The details of a PlanData resource.", "properties": { - "value": { - "description": "Results of a list operation.", - "type": "array", - "items": { - "$ref": "#/definitions/LinkedResource" - } - }, - "nextLink": { - "description": "Link to the next set of results, if any.", - "type": "string" + "properties": { + "$ref": "#/definitions/PlanDataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] } - } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] }, "ProvisioningState": { "type": "string", @@ -3358,44 +3386,63 @@ } }, "ResubscribeProperties": { - "description": "Resubscribe Properties", "type": "object", + "description": "Resubscribe Properties", "properties": { "planId": { - "description": "Newly selected plan Id to create the new Marketplace subscription for Resubscribe", - "type": "string" + "type": "string", + "description": "Newly selected plan Id to create the new Marketplace subscription for Resubscribe" }, "termId": { - "description": "Newly selected term Id to create the new Marketplace subscription for Resubscribe", - "type": "string" + "type": "string", + "description": "Newly selected term Id to create the new Marketplace subscription for Resubscribe" }, "subscriptionId": { - "description": "Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe", - "type": "string" + "type": "string", + "description": "Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe" }, "resourceGroup": { - "description": "Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe", - "type": "string" + "type": "string", + "description": "Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe" }, "organizationId": { - "description": "Organization Id of the NewRelic Organization that needs to be resubscribed", - "type": "string" + "type": "string", + "description": "Organization Id of the NewRelic Organization that needs to be resubscribed" }, "publisherId": { - "description": "Publisher Id of the NewRelic offer that needs to be resubscribed", - "type": "string" + "type": "string", + "description": "Publisher Id of the NewRelic offer that needs to be resubscribed" }, "offerId": { - "description": "Offer Id of the NewRelic offer that needs to be resubscribed", - "type": "string" + "type": "string", + "description": "Offer Id of the NewRelic offer that needs to be resubscribed" } } }, - "SecureString": { - "type": "string", - "description": "Credential string.", - "format": "password", - "x-ms-secret": true + "SaaSData": { + "type": "object", + "description": "SaaS details", + "properties": { + "saaSResourceId": { + "type": "string", + "description": "SaaS resource id" + } + } + }, + "SaaSResourceDetailsResponse": { + "type": "object", + "description": "Marketplace SaaS resource details.", + "properties": { + "saasId": { + "type": "string", + "description": "Id of the Marketplace SaaS Resource" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] }, "SendAadLogsStatus": { "type": "string", @@ -3406,7 +3453,17 @@ ], "x-ms-enum": { "name": "SendAadLogsStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] } }, "SendActivityLogsStatus": { @@ -3418,7 +3475,17 @@ ], "x-ms-enum": { "name": "SendActivityLogsStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] } }, "SendMetricsStatus": { @@ -3430,7 +3497,17 @@ ], "x-ms-enum": { "name": "SendMetricsStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] } }, "SendSubscriptionLogsStatus": { @@ -3442,7 +3519,17 @@ ], "x-ms-enum": { "name": "SendSubscriptionLogsStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] } }, "SendingLogsStatus": { @@ -3454,7 +3541,17 @@ ], "x-ms-enum": { "name": "SendingLogsStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] } }, "SendingMetricsStatus": { @@ -3466,7 +3563,17 @@ ], "x-ms-enum": { "name": "SendingMetricsStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled" + }, + { + "name": "Disabled", + "value": "Disabled" + } + ] } }, "SingleSignOnStates": { @@ -3480,9 +3587,112 @@ ], "x-ms-enum": { "name": "SingleSignOnStates", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Initial", + "value": "Initial" + }, + { + "name": "Enable", + "value": "Enable" + }, + { + "name": "Disable", + "value": "Disable" + }, + { + "name": "Existing", + "value": "Existing" + } + ] + } + }, + "Status": { + "type": "string", + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "InProgress", + "value": "InProgress" + }, + { + "name": "Active", + "value": "Active" + }, + { + "name": "Failed", + "value": "Failed" + }, + { + "name": "Deleting", + "value": "Deleting" + } + ] + } + }, + "SubscriptionList": { + "type": "object", + "description": "The request to update subscriptions needed to be monitored by the NewRelic monitor resource.", + "properties": { + "patchOperation": { + "$ref": "#/definitions/PatchOperation", + "description": "The operation for the patch on the resource.", + "x-ms-mutability": [ + "update", + "create" + ] + }, + "monitoredSubscriptionList": { + "type": "array", + "description": "List of subscriptions and the state of the monitoring.", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + } } }, + "SwitchBillingRequest": { + "type": "object", + "description": "Request of a switch billing Operation.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "Azure resource Id" + }, + "organizationId": { + "type": "string", + "description": "Organization id" + }, + "planData": { + "$ref": "#/definitions/PlanData", + "description": "Plan details" + }, + "userEmail": { + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + } + }, + "required": [ + "userEmail" + ] + }, "TagAction": { "type": "string", "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", @@ -3492,11 +3702,22 @@ ], "x-ms-enum": { "name": "TagAction", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "name": "Include", + "value": "Include" + }, + { + "name": "Exclude", + "value": "Exclude" + } + ] } }, "TagRule": { "type": "object", + "description": "A tag rule belonging to NewRelic account", "properties": { "properties": { "$ref": "#/definitions/MonitoringTagRulesProperties", @@ -3508,7 +3729,6 @@ ] } }, - "description": "A tag rule belonging to NewRelic account", "required": [ "properties" ], @@ -3520,39 +3740,39 @@ }, "TagRuleListResult": { "type": "object", + "description": "The response of a TagRule list operation.", "properties": { "value": { "type": "array", + "description": "The TagRule items on this page", "items": { "$ref": "#/definitions/TagRule" - }, - "x-cadl-name": "TagRule[]", - "description": "The TagRule items on this page" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "The response of a TagRule list operation.", "required": [ "value" ] }, "TagRuleUpdate": { "type": "object", + "description": "The type used for update operations of the TagRule.", "properties": { "properties": { "$ref": "#/definitions/TagRuleUpdateProperties", + "description": "The updatable properties of the TagRule.", "x-ms-client-flatten": true } - }, - "description": "The type used for update operations of the TagRule." + } }, "TagRuleUpdateProperties": { "type": "object", + "description": "The updatable properties of the TagRule.", "properties": { "logRules": { "$ref": "#/definitions/LogRules", @@ -3562,8 +3782,7 @@ "$ref": "#/definitions/MetricRules", "description": "Set of rules for sending metrics for the Monitor resource." } - }, - "description": "The updatable properties of the TagRule." + } }, "UsageType": { "type": "string", @@ -3589,13 +3808,9 @@ ] } }, - "UserEmailParameter": { - "type": "object", - "properties": {}, - "description": "User email specification." - }, "UserInfo": { "type": "object", + "description": "User Info of NewRelic Monitor resource", "properties": { "firstName": { "type": "string", @@ -3608,8 +3823,9 @@ "maxLength": 50 }, "emailAddress": { - "$ref": "#/definitions/email", - "description": "User Email" + "type": "string", + "description": "Reusable representation of an email address", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" }, "phoneNumber": { "type": "string", @@ -3620,59 +3836,42 @@ "type": "string", "description": "country if user" } - }, - "description": "User Info of NewRelic Monitor resource" - }, - "LatestLinkedSaaSResponse": { - "type": "object", - "properties": { - "saaSResourceId": { - "type": "string", - "description": "SaaS resource id" - }, - "isHiddenSaaS": { - "type": "boolean", - "description": "Flag indicating if the SaaS resource is hidden" - } - }, - "description": "Response of get latest linked SaaS resource operation" + } }, "VMExtensionPayload": { "type": "object", + "description": "Response of payload to be passed while installing VM agent.", "properties": { "ingestionKey": { "type": "string", "description": "Ingestion key of the account" } - }, - "description": "Response of payload to be passed while installing VM agent." + } }, "VMHostsListResponse": { "type": "object", + "description": "Response of a list VM Host Operation.", "properties": { "value": { "type": "array", + "description": "The VMInfo items on this page", "items": { "$ref": "#/definitions/VMInfo" - }, - "x-ms-identifiers": [], - "x-cadl-name": "VMInfo[]", - "description": "The VMInfo items on this page" + } }, "nextLink": { "type": "string", "format": "uri", - "description": "The link to the next page of items", - "x-cadl-name": "Rest.ResourceLocation" + "description": "The link to the next page of items" } }, - "description": "Response of a list VM Host Operation.", "required": [ "value" ] }, "VMInfo": { "type": "object", + "description": "Details of VM Resource having NewRelic OneAgent installed", "properties": { "vmId": { "type": "string", @@ -3686,8 +3885,7 @@ "type": "string", "description": "Status of the NewRelic agent installed on the VM." } - }, - "description": "Details of VM Resource having NewRelic OneAgent installed" + } }, "email": { "type": "string", @@ -3695,107 +3893,5 @@ "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" } }, - "parameters": { - "MonitorNameParameter": { - "in": "path", - "name": "monitorName", - "description": "Monitor resource name", - "required": true, - "type": "string", - "pattern": "^.*$", - "x-ms-parameter-location": "method" - }, - "AccountIdParameter": { - "name": "accountId", - "in": "query", - "required": false, - "description": "Account Id.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "AppServicesGetParameter": { - "name": "request", - "in": "body", - "required": true, - "description": "The details of the app services get request.", - "schema": { - "$ref": "#/definitions/AppServicesGetRequest" - }, - "x-ms-parameter-location": "method" - }, - "SwitchBillingParameter": { - "name": "request", - "in": "body", - "required": true, - "description": "The details of the switch billing request.", - "schema": { - "$ref": "#/definitions/SwitchBillingRequest" - }, - "x-ms-parameter-location": "method" - }, - "HostsGetParameter": { - "name": "request", - "in": "body", - "required": true, - "description": "The details of the Hosts get request.", - "schema": { - "$ref": "#/definitions/HostsGetRequest" - }, - "x-ms-parameter-location": "method" - }, - "LocationParameter": { - "name": "location", - "in": "query", - "required": true, - "description": "Location for NewRelic.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "ActivateSaaSParameter": { - "name": "request", - "in": "body", - "required": true, - "description": "The details for ActivateSaaSParameter request.", - "schema": { - "$ref": "#/definitions/ActivateSaaSParameterRequest" - }, - "x-ms-parameter-location": "method" - }, - "MetricsRequestParameter": { - "name": "request", - "in": "body", - "required": true, - "description": "The details of the get metrics status request.", - "schema": { - "$ref": "#/definitions/MetricsRequest" - }, - "x-ms-parameter-location": "method" - }, - "MetricsStatusRequestParameter": { - "name": "request", - "in": "body", - "required": true, - "description": "The details of the get metrics status request.", - "schema": { - "$ref": "#/definitions/MetricsStatusRequest" - }, - "x-ms-parameter-location": "method" - }, - "OrganizationIdParameter": { - "name": "organizationId", - "in": "query", - "required": false, - "description": "Organization Id.", - "type": "string", - "x-ms-parameter-location": "method" - }, - "UserEmailParameter": { - "name": "userEmail", - "in": "query", - "required": true, - "description": "User Email.", - "type": "string", - "x-ms-parameter-location": "method" - } - } + "parameters": {} } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MaximumSet_Gen.json index 596a5e0d5be0..488a7ef0cc79 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MaximumSet_Gen.json @@ -1,27 +1,27 @@ { "operationId": "Accounts_List", - "title": "Accounts_List_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", + "location": "egh", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" }, + "title": "Accounts_List_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { - "organizationId": "wvdclwi", "accountId": "igmdjq", "accountName": "accname", + "organizationId": "wvdclwi", "region": "xnsylopqwcggudcln" } } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MinimumSet_Gen.json index fea1aa017eb7..e1eab7df2472 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Accounts_List_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { "operationId": "Accounts_List", - "title": "Accounts_List_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", + "location": "egh", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" }, + "title": "Accounts_List_MinimumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ActivateSaaS.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ActivateSaaS.json index 444cada840ea..9c96c9974fae 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ActivateSaaS.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ActivateSaaS.json @@ -1,6 +1,5 @@ { "operationId": "SaaS_ActivateResource", - "title": "ValidateAndActivateSaaS", "parameters": { "api-version": "2025-05-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", @@ -9,6 +8,7 @@ "saasGuid": "00000000-0000-0000-0000-000005430000" } }, + "title": "ActivateSaaS", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/BillingInfo_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/BillingInfo_Get.json index 497f69c98886..6768e20c05ae 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/BillingInfo_Get.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/BillingInfo_Get.json @@ -1,21 +1,21 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "myMonitor", "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "marketplaceSaasInfo": { - "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", - "marketplaceSubscriptionName": "AzNewRelic_b1190c8f", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzNewRelic_b1190c8f", "marketplaceStatus": "Active", - "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", - "publisherId": "publisherId", - "offerId": "offerId" + "marketplaceSubscriptionId": "12345678-1234-1234-1234-123456789012", + "marketplaceSubscriptionName": "AzNewRelic_b1190c8f", + "offerId": "offerId", + "publisherId": "publisherId" }, "partnerBillingEntity": { "organizationId": "1234567890", @@ -23,5 +23,7 @@ } } } - } + }, + "operationId": "BillingInfo_Get", + "title": "BillingInfo_Get" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ConnectedPartnerResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ConnectedPartnerResources_List.json index b0f2630eacfc..43bb335984fc 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ConnectedPartnerResources_List.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/ConnectedPartnerResources_List.json @@ -1,9 +1,9 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "myMonitor", "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -11,8 +11,8 @@ "value": [ { "properties": { - "accountName": "accountName", "accountId": "1156243", + "accountName": "accountName", "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "location": "West US 2" } @@ -20,5 +20,7 @@ ] } } - } + }, + "operationId": "ConnectedPartnerResources_List", + "title": "ConnectedPartnerResources_List" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/LinkedResources_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/LinkedResources_List.json index 3f35631f187a..92b9d4f87cdd 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/LinkedResources_List.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/LinkedResources_List.json @@ -1,9 +1,9 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "myMonitor", "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { @@ -15,5 +15,7 @@ ] } } - } + }, + "operationId": "Monitors_ListLinkedResources", + "title": "Monitors_ListLinkedResources" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_CreateOrUpdate.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_CreateOrUpdate.json index 4250da7959a9..5c8efd7a7959 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_CreateOrUpdate.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_CreateOrUpdate.json @@ -1,140 +1,140 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor", "configurationName": "default", + "monitorName": "myMonitor", "requestBody": { "properties": { - "operation": "AddBegin", "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } - ] + ], + "operation": "AddBegin" } - } + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "name": "default", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "properties": { "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } ] @@ -144,71 +144,73 @@ "201": { "body": { "name": "default", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "properties": { "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } ] } } } - } + }, + "operationId": "MonitoredSubscriptions_CreateOrUpdate", + "title": "Monitors_AddMonitoredSubscriptions" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Delete.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Delete.json index 64e4f84168e1..ff2249051634 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Delete.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Delete.json @@ -1,10 +1,10 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", + "configurationName": "default", "monitorName": "myMonitor", - "configurationName": "default" + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "202": { @@ -13,5 +13,7 @@ } }, "204": {} - } + }, + "operationId": "MonitoredSubscriptions_Delete", + "title": "Monitors_DeleteMonitoredSubscriptions" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Get.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Get.json index 80e3d5ebfb9e..a16d2771d25a 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Get.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Get.json @@ -1,80 +1,82 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", + "configurationName": "default", "monitorName": "myMonitor", - "configurationName": "default" + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "name": "default", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "properties": { "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } ] } } } - } + }, + "operationId": "MonitoredSubscriptions_Get", + "title": "Monitors_GetMonitoredSubscriptions" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_List.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_List.json index db3d320c8300..e62de84186d7 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_List.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_List.json @@ -1,84 +1,86 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "myMonitor", "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "nextLink": null, "value": [ { "name": "default", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "properties": { "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } ] } } - ], - "nextLink": null + ] } } - } + }, + "operationId": "MonitoredSubscriptions_List", + "title": "Monitors_GetMonitoredSubscriptions" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Update.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Update.json index 5f271126d4c2..b65145e934e6 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Update.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/MonitoredSubscriptions_Update.json @@ -1,140 +1,140 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor", "configurationName": "default", + "monitorName": "myMonitor", "requestBody": { "properties": { - "operation": "AddComplete", "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } - ] + ], + "operation": "AddComplete" } - } + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { "name": "default", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "type": "NewRelic.Observability/monitors/monitoredSubscriptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor/monitoredSubscriptions/default", "properties": { "monitoredSubscriptionList": [ { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "status": "Active", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } }, { - "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "status": "Failed", + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", "tagRules": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } } ] @@ -146,5 +146,7 @@ "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/NewRelic.Observability/monitors/test?api-version=2025-05-01-preview" } } - } + }, + "operationId": "MonitoredSubscriptions_Update", + "title": "Monitors_UpdateMonitoredSubscriptions" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json index d2fbeafe14d8..866f60599f93 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -1,18 +1,22 @@ { "operationId": "Monitors_CreateOrUpdate", - "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "resource": { + "identity": { + "type": "None", + "userAssignedIdentities": { + "key8903": {} + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "ingestionKey": "wltnimmhqt", @@ -22,56 +26,68 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", "saaSData": { "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" }, - "liftrResourceCategory": "Unknown", - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR", "subscriptionState": "Suspended", - "saaSAzureSubscriptionStatus": "Subscribed" - }, - "identity": { - "type": "None", - "userAssignedIdentities": { - "key8903": {} + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, "tags": { "key6976": "oaxfhf" - }, - "location": "k" - } + } + }, + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_CreateOrUpdate_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -80,72 +96,69 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR", + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", "subscriptionState": "Suspended", - "saaSAzureSubscriptionStatus": "Subscribed" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -154,58 +167,45 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR", + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", "subscriptionState": "Suspended", - "saaSAzureSubscriptionStatus": "Subscribed" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } + }, + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json index ab5218c03fdb..dfbeebb4f554 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MaximumSet_Gen.json @@ -1,13 +1,13 @@ { "operationId": "Monitors_Delete", - "title": "Monitors_Delete_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" }, + "title": "Monitors_Delete_MaximumSet_Gen", "responses": { "200": {}, "202": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json index 8cb8eac41627..4b858fb3cbab 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Delete_MinimumSet_Gen.json @@ -1,13 +1,13 @@ { "operationId": "Monitors_Delete", - "title": "Monitors_Delete_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" }, + "title": "Monitors_Delete_MinimumSet_Gen", "responses": { "200": {}, "202": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json index aa0db50e68b0..43c229b81ed2 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MaximumSet_Gen.json @@ -1,27 +1,27 @@ { "operationId": "Monitors_GetMetricRules", - "title": "Monitors_GetMetricRules_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricRules_MaximumSet_Gen", "responses": { "200": { "body": { - "sendMetrics": "Enabled", - "userEmail": "test@testing.com", "filteringTags": [ { "name": "qnvixg", - "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge", - "action": "Include" + "action": "Include", + "value": "ihyabcsjvhkfzckfjvgvtlhdyvmwge" } - ] + ], + "sendMetrics": "Enabled", + "userEmail": "test@testing.com" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json index f2e634a86253..d8dabc8184e0 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricRules_MinimumSet_Gen.json @@ -1,20 +1,20 @@ { "operationId": "Monitors_GetMetricRules", - "title": "Monitors_GetMetricRules_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricRules_MinimumSet_Gen", "responses": { "200": { "body": { - "sendMetrics": "Disabled", "filteringTags": [], + "sendMetrics": "Disabled", "userEmail": null } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json index 12e76782bd6b..31eebf167fa7 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MaximumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_GetMetricStatus", - "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,6 +12,7 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricStatus_MaximumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json index e662623f11fe..5fb17dcd34d5 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_GetMetricStatus_MinimumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_GetMetricStatus", - "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,6 +12,7 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_GetMetricStatus_MinimumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Get_MaximumSet_Gen.json index 09085fb7ad9f..22f391fb7b14 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Get_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Get_MaximumSet_Gen.json @@ -1,22 +1,38 @@ { "operationId": "Monitors_Get", - "title": "Monitors_Get_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "cdlymktqw", "resourceGroupName": "rgNewRelic", - "monitorName": "cdlymktqw" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_Get_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -25,55 +41,39 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json index 9dfe07ff95a3..f64a78384b9d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MaximumSet_Gen.json @@ -1,17 +1,17 @@ { "operationId": "Monitors_LatestLinkedSaaS", - "title": "Monitors_LatestLinkedSaaS_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_LatestLinkedSaaS_MaximumSet_Gen", "responses": { "200": { "body": { - "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd", - "isHiddenSaaS": false + "isHiddenSaaS": false, + "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json index 2c98761b1206..727bea5134ee 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LatestLinkedSaaS_MinimumSet_Gen.json @@ -1,17 +1,17 @@ { "operationId": "Monitors_LatestLinkedSaaS", - "title": "Monitors_LatestLinkedSaaS_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_LatestLinkedSaaS_MinimumSet_Gen", "responses": { "200": { "body": { - "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd", - "isHiddenSaaS": false + "isHiddenSaaS": false, + "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LinkSaaS.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LinkSaaS.json index c954c90044b9..97b0d8ec318a 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LinkSaaS.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_LinkSaaS.json @@ -1,25 +1,41 @@ { "operationId": "Monitors_LinkSaaS", - "title": "Monitors_LinkSaaS", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor", "body": { "saaSResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/Microsoft.SaaS/resources/abcd" - } + }, + "monitorName": "myMonitor", + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_LinkSaaS", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -28,57 +44,41 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "YEARLY", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR", + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", "subscriptionState": "Suspended", - "saaSAzureSubscriptionStatus": "Subscribed" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json index d8b96c5d780a..3534b53563f2 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MaximumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_ListAppServices", - "title": "Monitors_ListAppServices_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,17 +12,18 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_ListAppServices_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { - "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", + "agentStatus": "vclwfecbppsfaygdccfu", "agentVersion": "owxkssnbp", - "agentStatus": "vclwfecbppsfaygdccfu" + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json index 5744a9f91f91..b7b29a8a87e2 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListAppServices_MinimumSet_Gen.json @@ -1,11 +1,10 @@ { "operationId": "Monitors_ListAppServices", - "title": "Monitors_ListAppServices_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "azureResourceIds": [ "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz" @@ -13,11 +12,12 @@ "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_ListAppServices_MinimumSet_Gen", "responses": { "200": { "body": { - "value": [], - "nextLink": null + "nextLink": null, + "value": [] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json index 08223afecf33..923d42ee50a6 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListByResourceGroup_MaximumSet_Gen.json @@ -1,23 +1,40 @@ { "operationId": "Monitors_ListByResourceGroup", - "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic" + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_ListByResourceGroup_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -26,59 +43,42 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json index f31ac0db858c..ccf3a0614009 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListBySubscription_MaximumSet_Gen.json @@ -1,22 +1,39 @@ { "operationId": "Monitors_ListBySubscription", - "title": "Monitors_ListBySubscription_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_ListBySubscription_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -25,59 +42,42 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json index ffb5ed36251e..835d4700272d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MaximumSet_Gen.json @@ -1,29 +1,29 @@ { "operationId": "Monitors_ListHosts", - "title": "Monitors_ListHosts_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "vmIds": [ "xzphvxvfmvjrnsgyns" - ], - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + ] } }, + "title": "Monitors_ListHosts_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { - "vmId": "gwyoa", + "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz", "agentVersion": "tbinulnoozxnbr", - "agentStatus": "psnjslxwuwtviwzzgqhyzynuxvz" + "vmId": "gwyoa" } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json index 155d835c6096..2eca329eb636 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListHosts_MinimumSet_Gen.json @@ -1,23 +1,23 @@ { "operationId": "Monitors_ListHosts", - "title": "Monitors_ListHosts_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "resourceGroupName": "rgopenapi", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "vmIds": [ "xzphvxvfmvjrnsgyns" - ], - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" + ] } }, + "title": "Monitors_ListHosts_MinimumSet_Gen", "responses": { "200": { "body": { - "value": [], - "nextLink": null + "nextLink": null, + "value": [] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json index e14778e6423f..a584e837f978 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MaximumSet_Gen.json @@ -1,25 +1,25 @@ { "operationId": "Monitors_ListMonitoredResources", - "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_ListMonitoredResources_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "sendingMetrics": "Enabled", + "reasonForLogsStatus": "agzxviwuxgr", "reasonForMetricsStatus": "k", "sendingLogs": "Enabled", - "reasonForLogsStatus": "agzxviwuxgr" + "sendingMetrics": "Enabled" } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json index 4c1b33b09e1f..a60e6539d316 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_ListMonitoredResources_MinimumSet_Gen.json @@ -1,17 +1,17 @@ { "operationId": "Monitors_ListMonitoredResources", - "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_ListMonitoredResources_MinimumSet_Gen", "responses": { "200": { "body": { - "value": [], - "nextLink": null + "nextLink": null, + "value": [] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_RefreshIngestionKey.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_RefreshIngestionKey.json index 603771398aee..f939944337d3 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_RefreshIngestionKey.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_RefreshIngestionKey.json @@ -1,12 +1,12 @@ { "operationId": "Monitors_RefreshIngestionKey", - "title": "Monitors_RefreshIngestionKey", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "myMonitor", "resourceGroupName": "myResourceGroup", - "monitorName": "myMonitor" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_RefreshIngestionKey", "responses": { "204": {} } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Resubscribe.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Resubscribe.json index 67a8ea3009af..ce9198bea423 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Resubscribe.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Resubscribe.json @@ -1,29 +1,45 @@ { "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", "monitorName": "myMonitor", "requestBody": { - "planId": "planId", - "term": "term", - "subscriptionId": "subscriptionId", - "resourceGroup": "resourceGroup", + "offerId": "offerId", "organizationId": "organizationId", + "planId": "planId", "publisherId": "publisherId", - "offerId": "offerId" - } + "resourceGroup": "resourceGroup", + "subscriptionId": "subscriptionId", + "term": "term" + }, + "resourceGroupName": "myResourceGroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -32,57 +48,41 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "YEARLY", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR", + "provisioningState": "Accepted", + "saaSAzureSubscriptionStatus": "Subscribed", "subscriptionState": "Suspended", - "saaSAzureSubscriptionStatus": "Subscribed" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, @@ -91,5 +91,7 @@ "Azure-AsyncOperation": "https://contoso.com/operationstatus" } } - } + }, + "operationId": "Monitors_Resubscribe", + "title": "Monitors_Resubscribe" } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json index 49bd8137d4dc..35b237245708 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MaximumSet_Gen.json @@ -1,33 +1,49 @@ { "operationId": "Monitors_SwitchBilling", - "title": "Monitors_SwitchBilling_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgNewRelic/providers/NewRelic.Observability/monitors/fhcjxnxumkdlgpwanewtkdnyuz", "organizationId": "k", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - } + "usageType": "PAYG" + }, + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_SwitchBilling_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -36,55 +52,39 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json index f57292448494..e3ac89da96e1 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_SwitchBilling_MinimumSet_Gen.json @@ -1,25 +1,41 @@ { "operationId": "Monitors_SwitchBilling", - "title": "Monitors_SwitchBilling_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "fhcjxnxumkdlgpwanewtkdnyuz", + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000", "request": { "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" } }, + "title": "Monitors_SwitchBilling_MinimumSet_Gen", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -28,55 +44,39 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Update_MaximumSet_Gen.json index 15f26f2c52d3..7ca38b335b22 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Update_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_Update_MaximumSet_Gen.json @@ -1,10 +1,7 @@ { "operationId": "Monitors_Update", - "title": "Monitors_Update_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgNewRelic", "monitorName": "cdlymktqw", "properties": { "identity": { @@ -13,12 +10,9 @@ "key8903": {} } }, - "tags": { - "key164": "jqakdrrmmyzytqu" - }, "properties": { + "accountCreationSource": "LIFTR", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "ingestionKey": "wltnimmhqt", @@ -28,40 +22,62 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" + } + }, + "tags": { + "key164": "jqakdrrmmyzytqu" } - } + }, + "resourceGroupName": "rgNewRelic", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_Update_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "fteaqmtwspcfgyopqzrepiqu", + "type": "hdj", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "identity": { + "type": "None", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002", + "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", + "userAssignedIdentities": { + "key8903": { + "clientId": "cac47a92-2856-11ed-a261-0242ac120002", + "principalId": "cac47a92-2856-11ed-a261-0242ac120002" + } + } + }, + "location": "k", "properties": { - "provisioningState": "Accepted", - "monitoringStatus": "Enabled", - "marketplaceSubscriptionStatus": "Active", + "accountCreationSource": "LIFTR", + "liftrResourceCategory": "Unknown", + "liftrResourcePreference": 12, "marketplaceSubscriptionId": "jizcsbgrdjhrfqqvvruhgftqhra", + "marketplaceSubscriptionStatus": "Active", + "monitoringStatus": "Enabled", "newRelicAccountProperties": { - "userId": "vcscxlncofcuduadesd", "accountInfo": { "accountId": "xhqmg", "region": "ljcf" @@ -70,55 +86,39 @@ "organizationId": "k" }, "singleSignOnProperties": { - "singleSignOnState": "Initial", "enterpriseAppId": "kwiwfz", - "singleSignOnUrl": "kvseueuljsxmfwpqctz", - "provisioningState": "Accepted" - } - }, - "userInfo": { - "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", - "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", - "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", - "phoneNumber": "krf", - "country": "hslqnwdanrconqyekwbnttaetv" + "provisioningState": "Accepted", + "singleSignOnState": "Initial", + "singleSignOnUrl": "kvseueuljsxmfwpqctz" + }, + "userId": "vcscxlncofcuduadesd" }, + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" + "usageType": "PAYG" }, - "liftrResourceCategory": "Unknown", - "liftrResourcePreference": 12, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" - }, - "identity": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "tenantId": "cac47a92-2856-11ed-a261-0242ac120002", - "type": "None", - "userAssignedIdentities": { - "key8903": { - "principalId": "cac47a92-2856-11ed-a261-0242ac120002", - "clientId": "cac47a92-2856-11ed-a261-0242ac120002" - } + "provisioningState": "Accepted", + "userInfo": { + "country": "hslqnwdanrconqyekwbnttaetv", + "emailAddress": "%6%@4-g.N1.3F-kI1.Ue-.lJso", + "firstName": "vdftzcggirefejajwahhwhyibutramdaotvnuf", + "lastName": "bcsztgqovdlmzfkjdrngidwzqsevagexzzilnlc", + "phoneNumber": "krf" } }, - "tags": { - "key6976": "oaxfhf" - }, - "location": "k", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "fteaqmtwspcfgyopqzrepiqu", - "type": "hdj", "systemData": { + "createdAt": "2022-12-05T14:11:37.787Z", "createdBy": "pcdjzdldbwsdlfi", "createdByType": "User", - "createdAt": "2022-12-05T14:11:37.787Z", + "lastModifiedAt": "2022-12-05T14:11:37.787Z", "lastModifiedBy": "xbsjrxmwwlmpnpvcica", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-12-05T14:11:37.787Z" + "lastModifiedByType": "User" + }, + "tags": { + "key6976": "oaxfhf" } } }, diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json index 71cb389a7433..2176244df68f 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MaximumSet_Gen.json @@ -1,12 +1,12 @@ { "operationId": "Monitors_VmHostPayload", - "title": "Monitors_VmHostPayload_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_VmHostPayload_MaximumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json index cf5019295d02..1be5dc939538 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Monitors_VmHostPayload_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { "operationId": "Monitors_VmHostPayload", - "title": "Monitors_VmHostPayload_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Monitors_VmHostPayload_MinimumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MaximumSet_Gen.json index c2a09220776b..5fb87d2e0f77 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -1,27 +1,27 @@ { "operationId": "Operations_List", - "title": "Operations_List_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview" }, + "title": "Operations_List_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { "name": "zhlrjcljiysnufaerhpzg", - "isDataAction": true, + "actionType": "Internal", "display": { - "provider": "v", - "resource": "w", + "description": "sekhimcuecttketh", "operation": "ybyzweygkffbydgaowg", - "description": "sekhimcuecttketh" + "provider": "v", + "resource": "w" }, - "origin": "user", - "actionType": "Internal" + "isDataAction": true, + "origin": "user" } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MinimumSet_Gen.json index 17271e5f0e24..9c2bc357accb 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Operations_List_MinimumSet_Gen.json @@ -1,9 +1,9 @@ { "operationId": "Operations_List", - "title": "Operations_List_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview" }, + "title": "Operations_List_MinimumSet_Gen", "responses": { "200": { "body": {} diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MaximumSet_Gen.json index 7c2ed393d031..a8b41e5fbcaa 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MaximumSet_Gen.json @@ -1,26 +1,26 @@ { "operationId": "Organizations_List", - "title": "Organizations_List_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", + "location": "egh", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" }, + "title": "Organizations_List_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { + "billingSource": "AZURE", "organizationId": "tjmcifofzirili", - "organizationName": "orgname", - "billingSource": "AZURE" + "organizationName": "orgname" } } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MinimumSet_Gen.json index 0cb89356fc3c..a5b43be42074 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Organizations_List_MinimumSet_Gen.json @@ -1,12 +1,12 @@ { "operationId": "Organizations_List", - "title": "Organizations_List_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", + "location": "egh", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm", - "location": "egh" + "userEmail": "ruxvg@xqkmdhrnoo.hlmbpm" }, + "title": "Organizations_List_MinimumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MaximumSet_Gen.json index 1284269faa63..79ae80747ebd 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MaximumSet_Gen.json @@ -1,31 +1,31 @@ { "operationId": "Plans_List", - "title": "Plans_List_MaximumSet_Gen", "parameters": { - "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", "accountId": "pwuxgvrmkk", - "organizationId": "hilawwjz" + "api-version": "2025-05-01-preview", + "organizationId": "hilawwjz", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Plans_List_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { + "accountCreationSource": "LIFTR", + "orgCreationSource": "LIFTR", "planData": { - "usageType": "PAYG", "billingCycle": "Yearly", + "effectiveDate": "2022-12-05T14:11:37.786Z", "planDetails": "tbbiaga", - "effectiveDate": "2022-12-05T14:11:37.786Z" - }, - "orgCreationSource": "LIFTR", - "accountCreationSource": "LIFTR" + "usageType": "PAYG" + } } } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MinimumSet_Gen.json index c3570f0910ca..316a4e57ef1c 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/Plans_List_MinimumSet_Gen.json @@ -1,11 +1,11 @@ { "operationId": "Plans_List", - "title": "Plans_List_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "organizationId": "hilawwjz" + "organizationId": "hilawwjz", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "Plans_List_MinimumSet_Gen", "responses": { "200": { "body": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json index e92c0016b636..981766b1a57d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MaximumSet_Gen.json @@ -1,120 +1,120 @@ { "operationId": "TagRules_CreateOrUpdate", - "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", "resource": { "properties": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" } - } + }, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_CreateOrUpdate_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } ] - } + }, + "provisioningState": "Accepted" }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", "createdBy": "wqrkemruqrvclsoevdftfeof", "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" + "lastModifiedByType": "User" } } }, "201": { - "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } ] - } + }, + "provisioningState": "Accepted" }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", "createdBy": "wqrkemruqrvclsoevdftfeof", "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" + "lastModifiedByType": "User" } + }, + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json index d765bd7be732..1d40f6ef54a9 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_CreateOrUpdate_MinimumSet_Gen.json @@ -1,30 +1,30 @@ { "operationId": "TagRules_CreateOrUpdate", - "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", "resource": { "properties": {} - } + }, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_CreateOrUpdate_MinimumSet_Gen", "responses": { "200": { "body": { - "properties": {}, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} } }, "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} + }, "headers": { "Azure-AsyncOperation": "https://contoso.com/operationstatus" - }, - "body": { - "properties": {}, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json index 648d4c91c434..6cb6549a0bca 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MaximumSet_Gen.json @@ -1,13 +1,13 @@ { "operationId": "TagRules_Delete", - "title": "TagRules_Delete_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_Delete_MaximumSet_Gen", "responses": { "200": {}, "202": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json index 2004644a67ad..d0ee217ac42d 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Delete_MinimumSet_Gen.json @@ -1,13 +1,13 @@ { "operationId": "TagRules_Delete", - "title": "TagRules_Delete_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_Delete_MinimumSet_Gen", "responses": { "200": {}, "202": { diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MaximumSet_Gen.json index 31e37a234d63..b181d5372d9c 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MaximumSet_Gen.json @@ -1,51 +1,51 @@ { "operationId": "TagRules_Get", - "title": "TagRules_Get_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_Get_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", "createdBy": "wqrkemruqrvclsoevdftfeof", "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" + "lastModifiedByType": "User" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MinimumSet_Gen.json index 3950e173ed48..a60ca4d70393 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Get_MinimumSet_Gen.json @@ -1,18 +1,18 @@ { "operationId": "TagRules_Get", - "title": "TagRules_Get_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb" + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_Get_MinimumSet_Gen", "responses": { "200": { "body": { - "properties": {}, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json index 14d66fa5ef26..80dadb757007 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen.json @@ -1,56 +1,56 @@ { "operationId": "TagRules_ListByNewRelicMonitorResource", - "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_ListByNewRelicMonitorResource_MaximumSet_Gen", "responses": { "200": { "body": { + "nextLink": "http://testlink.com", "value": [ { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", "createdBy": "wqrkemruqrvclsoevdftfeof", "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" + "lastModifiedByType": "User" } } - ], - "nextLink": "http://testlink.com" + ] } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json index fe4b9ed90525..03f6a6556b25 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { "operationId": "TagRules_ListByNewRelicMonitorResource", - "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", + "monitorName": "ipxmlcbonyxtolzejcjshkmlron", "resourceGroupName": "rgopenapi", - "monitorName": "ipxmlcbonyxtolzejcjshkmlron" + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_ListByNewRelicMonitorResource_MinimumSet_Gen", "responses": { "200": { "body": { "value": [ { - "properties": {}, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} } ] } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MaximumSet_Gen.json index 22faf3fff941..41eb3af54a00 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MaximumSet_Gen.json @@ -1,77 +1,77 @@ { "operationId": "TagRules_Update", - "title": "TagRules_Update_MaximumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", - "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", "properties": { "properties": { "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "userEmail": "test@testing.com" } } - } + }, + "resourceGroupName": "rgopenapi", + "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_Update_MaximumSet_Gen", "responses": { "200": { "body": { + "name": "ddoieozflu", + "type": "roafonrkfwwuv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", "properties": { - "provisioningState": "Accepted", "logRules": { - "sendAadLogs": "Enabled", - "sendSubscriptionLogs": "Enabled", - "sendActivityLogs": "Enabled", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] + ], + "sendAadLogs": "Enabled", + "sendActivityLogs": "Enabled", + "sendSubscriptionLogs": "Enabled" }, "metricRules": { - "userEmail": "test@testing.com", "filteringTags": [ { "name": "saokgpjvdlorciqbjmjxazpee", - "value": "sarxrqsxouhdjwsrqqicbeirdb", - "action": "Include" + "action": "Include", + "value": "sarxrqsxouhdjwsrqqicbeirdb" } - ] - } + ], + "userEmail": "test@testing.com" + }, + "provisioningState": "Accepted" }, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", - "name": "ddoieozflu", - "type": "roafonrkfwwuv", "systemData": { + "createdAt": "2022-09-02T00:39:52.964Z", "createdBy": "wqrkemruqrvclsoevdftfeof", "createdByType": "User", - "createdAt": "2022-09-02T00:39:52.964Z", + "lastModifiedAt": "2022-09-02T00:39:52.964Z", "lastModifiedBy": "usdyoriebtakpdotcfp", - "lastModifiedByType": "User", - "lastModifiedAt": "2022-09-02T00:39:52.964Z" + "lastModifiedByType": "User" } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MinimumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MinimumSet_Gen.json index 2ab30070dd8e..5c159b60df63 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MinimumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/preview/2025-05-01-preview/examples/TagRules_Update_MinimumSet_Gen.json @@ -1,19 +1,19 @@ { "operationId": "TagRules_Update", - "title": "TagRules_Update_MinimumSet_Gen", "parameters": { "api-version": "2025-05-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "rgopenapi", "monitorName": "ipxmlcbonyxtolzejcjshkmlron", + "properties": {}, + "resourceGroupName": "rgopenapi", "ruleSetName": "bxcantgzggsepbhqmedjqyrqeezmfb", - "properties": {} + "subscriptionId": "00000000-0000-0000-0000-000000000000" }, + "title": "TagRules_Update_MinimumSet_Gen", "responses": { "200": { "body": { - "properties": {}, - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor" + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/NewRelic.Observability/monitors/myMonitor", + "properties": {} } } } diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/NewRelic.json index c2978e58eb4e..c27027f035fd 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2022-07-01", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2022-07-01" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json index f207dd1e814f..d0a432d75830 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-01-01/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2024-01-01", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2024-01-01" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-03-01/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-03-01/NewRelic.json index 64f98e6a2152..daba31c2a135 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-03-01/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-03-01/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2024-03-01", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2024-03-01" }, "schemes": [ "https" diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-10-01/NewRelic.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-10-01/NewRelic.json index beee881ec01a..e1ade109db07 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-10-01/NewRelic.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2024-10-01/NewRelic.json @@ -2,12 +2,7 @@ "swagger": "2.0", "info": { "title": "NewRelic.Observability", - "version": "2024-10-01", - "x-cadl-generated": [ - { - "emitter": "@azure-tools/cadl-autorest" - } - ] + "version": "2024-10-01" }, "schemes": [ "https" diff --git a/specification/nginx/Nginx.Management/models.tsp b/specification/nginx/Nginx.Management/models.tsp index 846e1c73c0b5..61efd765a8f1 100644 --- a/specification/nginx/Nginx.Management/models.tsp +++ b/specification/nginx/Nginx.Management/models.tsp @@ -747,8 +747,8 @@ model NginxDeploymentScalingProperties { /** * The settings for enabling automatic scaling of the deployment. If this field is specified, 'scale.capacity' must be empty. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty autoScaleSettings?: NginxDeploymentScalingPropertiesAutoScaleSettings; } @@ -978,8 +978,8 @@ model NginxDeploymentUpdateProperties { /** * Update settings for NGINX App Protect (NAP) */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty nginxAppProtect?: NginxDeploymentUpdatePropertiesNginxAppProtect; } diff --git a/specification/oracle/Oracle.Database.Management/back-compatible.tsp b/specification/oracle/Oracle.Database.Management/back-compatible.tsp new file mode 100644 index 000000000000..b3cf62828c34 --- /dev/null +++ b/specification/oracle/Oracle.Database.Management/back-compatible.tsp @@ -0,0 +1,96 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./operations/autonomousdatabase/autonomousDatabaseOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseBackupOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseCharacterSetOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseNationalCharacterSetOperations.tsp"; +import "./operations/autonomousdatabase/autonomousDatabaseVersionOperations.tsp"; +import "./operations/exadata/exadatainfrastructureOperations.tsp"; +import "./operations/exadata/dbServersOperations.tsp"; +import "./operations/exadata/vmclusterOperations.tsp"; +import "./operations/exadata/virtualNetworkAddressOperations.tsp"; +import "./operations/exadata/systemVersionOperations.tsp"; +import "./operations/oraclesubscription/oracleSubscriptionOperations.tsp"; +import "./operations/exadata/dbNodesOperations.tsp"; +import "./operations/exadata/dbSystemShapeOperations.tsp"; +import "./operations/exadata/dnsPrivateViewsOperations.tsp"; +import "./operations/exadata/dnsPrivateZonesOperations.tsp"; +import "./operations/exadata/giVersionOperations.tsp"; + +using Oracle.Database; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AutonomousDatabaseBackup.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AutonomousDatabaseCharacterSet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AutonomousDatabaseNationalCharacterSet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AutonomousDbVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CloudExadataInfrastructure.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CloudVmCluster.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DbNode.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DbServer.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DbSystemShape.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DnsPrivateView.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DnsPrivateZone.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GiVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OracleSubscription.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SystemVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualNetworkAddress.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DbSystem.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DbVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExascaleDbNode.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExadbVmCluster.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ResourceAnchor.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExascaleDbStorageVault.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(FlexComponent.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GiMinorVersion.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(NetworkAnchor.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/oracle/Oracle.Database.Management/main.tsp b/specification/oracle/Oracle.Database.Management/main.tsp index 879091daee1f..d7ec586d02fc 100644 --- a/specification/oracle/Oracle.Database.Management/main.tsp +++ b/specification/oracle/Oracle.Database.Management/main.tsp @@ -1,4 +1,5 @@ import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-client-generator-core"; import "./operations/exadata/exadatainfrastructureOperations.tsp"; import "./operations/exadata/dbServersOperations.tsp"; import "./operations/exadata/vmclusterOperations.tsp"; @@ -25,6 +26,7 @@ import "./operations/anchors/resourceAnchorOperations.tsp"; import "./operations/basedb/dbSystemOperations.tsp"; import "./operations/basedb/dbVersionOperations.tsp"; import "./versions.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/oracle/Oracle.Database.Management/models/autonomousdatabase/autonomousDatabase.tsp b/specification/oracle/Oracle.Database.Management/models/autonomousdatabase/autonomousDatabase.tsp index 4339b046231f..c6b655e6586c 100644 --- a/specification/oracle/Oracle.Database.Management/models/autonomousdatabase/autonomousDatabase.tsp +++ b/specification/oracle/Oracle.Database.Management/models/autonomousdatabase/autonomousDatabase.tsp @@ -612,9 +612,9 @@ model AutonomousDatabaseUpdate AutonomousDatabase, "Name" | "name" | "properties" >>> { - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "backward compatibility" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "backward compatibility" @doc("The resource-specific properties for this resource.") - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AutonomousDatabaseUpdateProperties; } diff --git a/specification/oracle/Oracle.Database.Management/tspconfig.yaml b/specification/oracle/Oracle.Database.Management/tspconfig.yaml index b8f6a4bd650c..c6877921ba4e 100644 --- a/specification/oracle/Oracle.Database.Management/tspconfig.yaml +++ b/specification/oracle/Oracle.Database.Management/tspconfig.yaml @@ -13,8 +13,6 @@ options: use-read-only-status-schema: true azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" "@azure-tools/typespec-ts": diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json index d0d14e6af26d..08d415c967c8 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json @@ -4004,8 +4004,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-08-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-08-01-preview/openapi.json index 584bf40c79b9..a60b3bbd4058 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2024-08-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-08-01-preview/openapi.json @@ -4004,8 +4004,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-10-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-10-01-preview/openapi.json index c181b2da1be1..8628b9afeb50 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2024-10-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-10-01-preview/openapi.json @@ -4086,8 +4086,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-12-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-12-01-preview/openapi.json index 32e12ba09f2f..bfbab1e2224b 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2024-12-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-12-01-preview/openapi.json @@ -5158,8 +5158,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2025-01-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2025-01-01-preview/openapi.json index 0db88aae582b..6f1be73ebab3 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2025-01-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2025-01-01-preview/openapi.json @@ -5253,8 +5253,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2025-04-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2025-04-01-preview/openapi.json index a3d4154e7617..46c36386562b 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2025-04-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2025-04-01-preview/openapi.json @@ -6286,8 +6286,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2025-06-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2025-06-01-preview/openapi.json index 1b362de10909..7e223e8f16b7 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2025-06-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2025-06-01-preview/openapi.json @@ -6380,8 +6380,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2025-07-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2025-07-01-preview/openapi.json index 2d5fa5c0003a..f21eb1732ca7 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2025-07-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2025-07-01-preview/openapi.json @@ -6870,8 +6870,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-01-preview/openapi.json index 28d0236b8615..8e0f3b867aa6 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-01-preview/openapi.json @@ -6959,8 +6959,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-15-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-15-preview/openapi.json index b6f519411fd1..dd632ece9ed1 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-15-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2025-08-15-preview/openapi.json @@ -6959,8 +6959,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json index 85fb6761fae6..bc485f3cbb1e 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json @@ -3916,8 +3916,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json index c786f7c1496e..ed8222ba0407 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json @@ -4004,8 +4004,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2025-03-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2025-03-01/openapi.json index 74dcbbb823a1..23289fb8a891 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2025-03-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2025-03-01/openapi.json @@ -5253,8 +5253,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2025-09-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2025-09-01/openapi.json index 34a7ce782dbf..8bcb023dfde0 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2025-09-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2025-09-01/openapi.json @@ -6959,8 +6959,7 @@ "properties": { "properties": { "$ref": "#/definitions/AutonomousDatabaseBaseProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/back-compatible.tsp b/specification/playwrighttesting/PlaywrightTesting.Management/back-compatible.tsp new file mode 100644 index 000000000000..72ae6e2640a3 --- /dev/null +++ b/specification/playwrighttesting/PlaywrightTesting.Management/back-compatible.tsp @@ -0,0 +1,17 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.AzurePlaywrightService; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Account.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AccountQuota.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Quota.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp index 82967fa0b34b..a56137c530f4 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp +++ b/specification/playwrighttesting/PlaywrightTesting.Management/main.tsp @@ -3,6 +3,7 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "./back-compatible.tsp"; using TypeSpec.Http; using TypeSpec.Rest; diff --git a/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml b/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml index f631b5792081..6e037e50f1a5 100644 --- a/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml +++ b/specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml @@ -15,8 +15,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/playwrighttesting.json" omit-unreachable-types: true diff --git a/specification/portalservices/CopilotSettings.Management/back-compatible.tsp b/specification/portalservices/CopilotSettings.Management/back-compatible.tsp new file mode 100644 index 000000000000..2543e0e11417 --- /dev/null +++ b/specification/portalservices/CopilotSettings.Management/back-compatible.tsp @@ -0,0 +1,11 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.PortalServices; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CopilotSettingsResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/portalservices/CopilotSettings.Management/main.tsp b/specification/portalservices/CopilotSettings.Management/main.tsp index 82744303eafb..f24086c74387 100644 --- a/specification/portalservices/CopilotSettings.Management/main.tsp +++ b/specification/portalservices/CopilotSettings.Management/main.tsp @@ -5,6 +5,7 @@ import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; import "./models.tsp"; import "./CopilotSettings.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Rest; using TypeSpec.Versioning; diff --git a/specification/portalservices/CopilotSettings.Management/tspconfig.yaml b/specification/portalservices/CopilotSettings.Management/tspconfig.yaml index ae477e7cdd11..791531ada995 100644 --- a/specification/portalservices/CopilotSettings.Management/tspconfig.yaml +++ b/specification/portalservices/CopilotSettings.Management/tspconfig.yaml @@ -7,8 +7,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." omit-unreachable-types: true output-file: "{azure-resource-provider-folder}/{service-name}/copilotSettings/{version-status}/{version}/copilotSettings.json" diff --git a/specification/portalservices/Extension.Management/tspconfig.yaml b/specification/portalservices/Extension.Management/tspconfig.yaml index b2fb1da05f76..57f494645900 100644 --- a/specification/portalservices/Extension.Management/tspconfig.yaml +++ b/specification/portalservices/Extension.Management/tspconfig.yaml @@ -6,8 +6,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/extensions/{version-status}/{version}/extensions.json" omit-unreachable-types: true linter: diff --git a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/PostgresqlHsc/tspconfig.yaml b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/PostgresqlHsc/tspconfig.yaml index 40ea60bce773..70d8fe670b11 100644 --- a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/PostgresqlHsc/tspconfig.yaml +++ b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/PostgresqlHsc/tspconfig.yaml @@ -10,7 +10,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{version-status}/{version}/postgresqlhsc.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + arm-types-dir: "{project-root}/../../../../common-types/resource-management" "@azure-tools/typespec-python": service-dir: "sdk/cosmosdbforpostgresql" diff --git a/specification/programmableconnectivity/ProgrammableConnectivity.Management/back-compatible.tsp b/specification/programmableconnectivity/ProgrammableConnectivity.Management/back-compatible.tsp new file mode 100644 index 000000000000..ce881aaaef38 --- /dev/null +++ b/specification/programmableconnectivity/ProgrammableConnectivity.Management/back-compatible.tsp @@ -0,0 +1,17 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.ProgrammableConnectivity; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Gateway.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OperatorApiConnection.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(OperatorApiPlan.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/programmableconnectivity/ProgrammableConnectivity.Management/main.tsp b/specification/programmableconnectivity/ProgrammableConnectivity.Management/main.tsp index f444c98dcce5..b21012fce4b2 100644 --- a/specification/programmableconnectivity/ProgrammableConnectivity.Management/main.tsp +++ b/specification/programmableconnectivity/ProgrammableConnectivity.Management/main.tsp @@ -6,6 +6,7 @@ import "./models.tsp"; import "./Gateway.tsp"; import "./OperatorApiConnection.tsp"; import "./OperatorApiPlan.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/programmableconnectivity/ProgrammableConnectivity.Management/tspconfig.yaml b/specification/programmableconnectivity/ProgrammableConnectivity.Management/tspconfig.yaml index 611d9427c91f..d1f9c577230f 100644 --- a/specification/programmableconnectivity/ProgrammableConnectivity.Management/tspconfig.yaml +++ b/specification/programmableconnectivity/ProgrammableConnectivity.Management/tspconfig.yaml @@ -10,7 +10,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" emit-common-types-schema: never - arm-resource-flattening: true + "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-programmableconnectivity" namespace: "azure.mgmt.programmableconnectivity" diff --git a/specification/purestorage/PureStorage.Block.Management/back-compatible.tsp b/specification/purestorage/PureStorage.Block.Management/back-compatible.tsp new file mode 100644 index 000000000000..68dfe0b8673f --- /dev/null +++ b/specification/purestorage/PureStorage.Block.Management/back-compatible.tsp @@ -0,0 +1,27 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./LiftrBase.Storage/main.tsp"; + +using PureStorage.Block; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AvsStorageContainer.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AvsStorageContainerVolume.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AvsVm.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(LiftrBase.Storage.Reservation.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AvsVmVolume.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StoragePool.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/purestorage/PureStorage.Block.Management/main.tsp b/specification/purestorage/PureStorage.Block.Management/main.tsp index 862252bb7616..98ac447deb20 100644 --- a/specification/purestorage/PureStorage.Block.Management/main.tsp +++ b/specification/purestorage/PureStorage.Block.Management/main.tsp @@ -1,4 +1,5 @@ import "./LiftrBase.Storage/main.tsp"; +import "./back-compatible.tsp"; import "@typespec/openapi"; @armProviderNamespace diff --git a/specification/purestorage/PureStorage.Block.Management/tspconfig.yaml b/specification/purestorage/PureStorage.Block.Management/tspconfig.yaml index 9c44a9015af3..f73b6bcc1020 100644 --- a/specification/purestorage/PureStorage.Block.Management/tspconfig.yaml +++ b/specification/purestorage/PureStorage.Block.Management/tspconfig.yaml @@ -13,7 +13,7 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/purestorage.json" - arm-resource-flattening: true + emit-common-types-schema: "never" "@azure-tools/typespec-csharp": emitter-output-dir: "{output-dir}/{service-dir}/{namespace}" diff --git a/specification/purviewpolicy/resource-manager/Microsoft.Purview/PurviewPolicy/tspconfig.yaml b/specification/purviewpolicy/resource-manager/Microsoft.Purview/PurviewPolicy/tspconfig.yaml index 7be74fc74eb3..cbc214bf9b6d 100644 --- a/specification/purviewpolicy/resource-manager/Microsoft.Purview/PurviewPolicy/tspconfig.yaml +++ b/specification/purviewpolicy/resource-manager/Microsoft.Purview/PurviewPolicy/tspconfig.yaml @@ -5,8 +5,6 @@ options: emitter-output-dir: "{project-root}" azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{version-status}/{version}/policy.json" arm-types-dir: "{project-root}/../../../../common-types/resource-management" omit-unreachable-types: true diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json index 080fbdbaa44f..dde31f9c14cb 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseAccessPolicyAssignmentCreateUpdate.json @@ -18,7 +18,7 @@ "responses": { "200": { "body": { - "id": "subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/accessPolicyAssignments/default-TestEntraApp1", + "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/databases/default/accessPolicyAssignments/default-TestEntraApp1", "name": "defaultTestEntraApp1", "type": "Microsoft.Cache/redisEnterprise/accessPolicyAssignments", "properties": { diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseCreate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseCreate.json index 9377419f1d59..4869c1a9a32e 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseCreate.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseCreate.json @@ -32,7 +32,35 @@ "keyEncryptionKeyUrl": "https://your-kv.vault.azure.net/keys/your-key/your-key-version" } }, - "publicNetworkAccess": "Disabled" + "publicNetworkAccess": "Disabled", + "maintenanceConfiguration": { + "maintenanceWindows": [ + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Monday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Tuesday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Wednesday" + } + } + ] + } }, "tags": { "tag1": "value1" @@ -72,6 +100,34 @@ "redisVersion": "5", "minimumTlsVersion": "1.2", "publicNetworkAccess": "Disabled", + "maintenanceConfiguration": { + "maintenanceWindows": [ + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Monday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Tuesday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Wednesday" + } + } + ] + }, "encryption": { "customerManagedKeyEncryption": { "keyEncryptionKeyIdentity": { @@ -118,7 +174,35 @@ "hostName": "cache1.westus.something.azure.net", "redisVersion": "5", "minimumTlsVersion": "1.2", - "publicNetworkAccess": "Disabled" + "publicNetworkAccess": "Disabled", + "maintenanceConfiguration": { + "maintenanceWindows": [ + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Monday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Tuesday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Wednesday" + } + } + ] + } }, "tags": { "tag1": "value1" diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseGet.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseGet.json index a01946648a2f..56d771332b67 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseGet.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseGet.json @@ -30,6 +30,34 @@ "redisVersion": "6", "minimumTlsVersion": "1.2", "publicNetworkAccess": "Disabled", + "maintenanceConfiguration": { + "maintenanceWindows": [ + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Monday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Tuesday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Wednesday" + } + } + ] + }, "privateEndpointConnections": [ { "id": "/subscriptions/e7b5a9d2-6b6a-4d2f-9143-20d9a10f5b8f/resourceGroups/rg1/providers/Microsoft.Cache/redisEnterprise/cache1/privateEndpointConnections/cachePec", diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseUpdate.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseUpdate.json index 2ac9e42e09f6..ed7ba916e8d7 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseUpdate.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/examples/RedisEnterpriseUpdate.json @@ -11,7 +11,35 @@ }, "properties": { "minimumTlsVersion": "1.2", - "publicNetworkAccess": "Enabled" + "publicNetworkAccess": "Enabled", + "maintenanceConfiguration": { + "maintenanceWindows": [ + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Monday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Tuesday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Wednesday" + } + } + ] + } }, "tags": { "tag1": "value1" @@ -47,7 +75,35 @@ "resourceState": "Updating", "redisVersion": "5", "minimumTlsVersion": "1.2", - "publicNetworkAccess": "Enabled" + "publicNetworkAccess": "Enabled", + "maintenanceConfiguration": { + "maintenanceWindows": [ + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Monday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Tuesday" + } + }, + { + "type": "Weekly", + "duration": "PT6H", + "startHourUtc": 3, + "schedule": { + "dayOfWeek": "Wednesday" + } + } + ] + } } } }, diff --git a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/redisenterprise.json b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/redisenterprise.json index 909dc90ab746..9709e95169d1 100644 --- a/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/redisenterprise.json +++ b/specification/redisenterprise/resource-manager/Microsoft.Cache/RedisEnterprise/preview/2025-08-01-preview/redisenterprise.json @@ -2261,6 +2261,15 @@ } } }, + "maintenanceConfiguration": { + "$ref": "#/definitions/MaintenanceConfiguration", + "description": "Cluster-level maintenance configuration.", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, "hostName": { "type": "string", "readOnly": true, @@ -2827,6 +2836,84 @@ } } }, + "MaintenanceConfiguration": { + "title": "Cluster maintenance configuration", + "description": "Cluster-level maintenance configuration.", + "type": "object", + "properties": { + "maintenanceWindows": { + "type": "array", + "description": "Custom maintenance windows that apply to the cluster.", + "items": { + "$ref": "#/definitions/MaintenanceWindow" + }, + "x-ms-identifiers": [] + } + } + }, + "MaintenanceWindow": { + "title": "Maintenance window", + "description": "A single custom maintenance window.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Maintenance window type.", + "enum": [ + "Weekly" + ], + "x-ms-enum": { + "name": "MaintenanceWindowType", + "modelAsString": true + } + }, + "duration": { + "type": "string", + "description": "Duration in ISO-8601 format, for example 'PT5H'." + }, + "startHourUtc": { + "type": "integer", + "format": "int32", + "description": "Start hour (0-23) in UTC when the maintenance window begins.", + "minimum": 0, + "maximum": 23 + }, + "schedule": { + "$ref": "#/definitions/MaintenanceWindowSchedule", + "description": "Recurring schedule for the maintenance window." + } + }, + "required": [ + "type", + "duration", + "startHourUtc", + "schedule" + ] + }, + "MaintenanceWindowSchedule": { + "title": "Maintenance window schedule", + "description": "Schedule details for a maintenance window.", + "type": "object", + "properties": { + "dayOfWeek": { + "type": "string", + "description": "Day of week. Required when the maintenance window type is 'Weekly'.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "MaintenanceDayOfWeek", + "modelAsString": true + } + } + } + }, "AccessKeys": { "title": "Access keys", "description": "The secret access keys used for authenticating connections to redis", diff --git a/specification/relay/resource-manager/Microsoft.Relay/Relay/models.tsp b/specification/relay/resource-manager/Microsoft.Relay/Relay/models.tsp index 0bed03ce9203..e00a3f8b9a20 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/Relay/models.tsp +++ b/specification/relay/resource-manager/Microsoft.Relay/Relay/models.tsp @@ -440,8 +440,8 @@ model RelayUpdateParameters extends ResourceNamespacePatch { /** * Description of Relay namespace. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: RelayNamespaceProperties; } @@ -552,9 +552,9 @@ model Operation { /** * Properties of the operation */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "FIXME: Update justification, follow aka.ms/tsp/conversion-fix for details" - @Azure.ResourceManager.Private.conditionalClientFlatten + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: Record; } diff --git a/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml b/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml index b56bb886fa77..0c90039f6424 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml +++ b/specification/relay/resource-manager/Microsoft.Relay/Relay/tspconfig.yaml @@ -11,7 +11,7 @@ options: output-file: "{version-status}/{version}/relay.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + emit-lro-options: "all" "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-relay" diff --git a/specification/scvmm/ScVmm.Management/BackCompat.tsp b/specification/scvmm/ScVmm.Management/BackCompat.tsp index c3c19443400b..9e14c9616337 100644 --- a/specification/scvmm/ScVmm.Management/BackCompat.tsp +++ b/specification/scvmm/ScVmm.Management/BackCompat.tsp @@ -1,3 +1,35 @@ import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; @@visibility(Azure.Core.Page.nextLink, Lifecycle.Read); + +using Microsoft.ScVmm; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AvailabilitySet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Cloud.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GuestAgent.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualMachineInstance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualMachineTemplate.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualNetwork.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VmInstanceHybridIdentityMetadata.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VmmServer.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/scvmm/ScVmm.Management/tspconfig.yaml b/specification/scvmm/ScVmm.Management/tspconfig.yaml index b85fd25bd1f1..50207dad2969 100644 --- a/specification/scvmm/ScVmm.Management/tspconfig.yaml +++ b/specification/scvmm/ScVmm.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/scvmm.json" "@azure-tools/typespec-ts": experimental-extensible-enums: true diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json index a47208794c03..470b8c38bcd1 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json @@ -3806,8 +3806,7 @@ "properties": { "properties": { "$ref": "#/definitions/InventoryItemProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." }, "kind": { "type": "string", diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json index 0f5d03c0273c..064c81bd7939 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json @@ -3818,8 +3818,7 @@ "properties": { "properties": { "$ref": "#/definitions/InventoryItemProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." }, "kind": { "type": "string", diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2025-03-13/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2025-03-13/scvmm.json index 466c25630699..85c12a7eaec1 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2025-03-13/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2025-03-13/scvmm.json @@ -3824,8 +3824,7 @@ "properties": { "properties": { "$ref": "#/definitions/InventoryItemProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." }, "kind": { "type": "string", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/DeleteResourcePricingByNameContainers_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/DeleteResourcePricingByNameContainers_example.json new file mode 100644 index 000000000000..c1640b7e9412 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/DeleteResourcePricingByNameContainers_example.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "scopeId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/demo-containers-rg/providers/Microsoft.ContainerService/managedClusters/demo-aks-cluster", + "pricingName": "Containers" + }, + "responses": { + "200": { + "message": "OK" + }, + "204": { + "message": "Pricing does not exist" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/GetResourcePricingByNameContainers_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/GetResourcePricingByNameContainers_example.json new file mode 100644 index 000000000000..3a14c3816b62 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/GetResourcePricingByNameContainers_example.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "scopeId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/demo-containers-rg/providers/Microsoft.ContainerService/managedClusters/demo-aks-cluster", + "pricingName": "Containers" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/demo-containers-rg/providers/Microsoft.ContainerService/managedClusters/demo-aks-cluster/providers/Microsoft.Security/pricings/Containers", + "name": "Containers", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard", + "freeTrialRemainingTime": "P26DT17H24M", + "enablementTime": "2025-01-13T10:30:45.1234567Z", + "inherited": "False", + "inheritedFrom": null, + "extensions": [ + { + "name": "ContainerRegistriesVulnerabilityAssessments", + "isEnabled": "True" + }, + { + "name": "AgentlessDiscoveryForKubernetes", + "isEnabled": "True" + }, + { + "name": "AgentlessVmScanning", + "isEnabled": "True", + "additionalExtensionProperties": { + "ExclusionTags": "[]" + } + }, + { + "name": "ContainerSensor", + "isEnabled": "True" + }, + { + "name": "ContainerIntegrityContribution", + "isEnabled": "True" + } + ] + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/PutResourcePricingByNameContainers_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/PutResourcePricingByNameContainers_example.json new file mode 100644 index 000000000000..38226bff9420 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/examples/Pricings/PutResourcePricingByNameContainers_example.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2024-01-01", + "scopeId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/demo-containers-rg/providers/Microsoft.ContainerService/managedClusters/demo-aks-cluster", + "pricingName": "Containers", + "pricing": { + "properties": { + "pricingTier": "Standard", + "extensions": [ + { + "name": "ContainerRegistriesVulnerabilityAssessments", + "isEnabled": "True" + }, + { + "name": "ContainerSensor", + "isEnabled": "True" + }, + { + "name": "AgentlessDiscoveryForKubernetes", + "isEnabled": "True" + }, + { + "name": "AgentlessVmScanning", + "isEnabled": "True", + "additionalExtensionProperties": { + "ExclusionTags": "[]" + } + }, + { + "name": "ContainerIntegrityContribution", + "isEnabled": "True" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/demo-containers-rg/providers/Microsoft.ContainerService/managedClusters/demo-aks-cluster/providers/Microsoft.Security/pricings/Containers", + "name": "Containers", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard", + "freeTrialRemainingTime": "P29DT23H55M", + "enablementTime": "2025-01-14T16:35:12.4567890Z", + "inherited": "False", + "inheritedFrom": null, + "extensions": [ + { + "name": "ContainerRegistriesVulnerabilityAssessments", + "isEnabled": "True" + }, + { + "name": "ContainerSensor", + "isEnabled": "True" + }, + { + "name": "AgentlessDiscoveryForKubernetes", + "isEnabled": "True" + }, + { + "name": "AgentlessVmScanning", + "isEnabled": "True", + "additionalExtensionProperties": { + "ExclusionTags": "[]" + } + }, + { + "name": "ContainerIntegrityContribution", + "isEnabled": "True" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/demo-containers-rg/providers/Microsoft.ContainerService/managedClusters/demo-aks-cluster/providers/Microsoft.Security/pricings/Containers", + "name": "Containers", + "type": "Microsoft.Security/pricings", + "properties": { + "pricingTier": "Standard", + "freeTrialRemainingTime": "P30DT0H0M", + "enablementTime": "2025-01-14T16:35:12.4567890Z", + "inherited": "False", + "inheritedFrom": null, + "extensions": [ + { + "name": "ContainerRegistriesVulnerabilityAssessments", + "isEnabled": "True" + }, + { + "name": "ContainerSensor", + "isEnabled": "True" + }, + { + "name": "AgentlessDiscoveryForKubernetes", + "isEnabled": "True" + }, + { + "name": "AgentlessVmScanning", + "isEnabled": "True", + "additionalExtensionProperties": { + "ExclusionTags": "[]" + } + }, + { + "name": "ContainerIntegrityContribution", + "isEnabled": "True" + } + ] + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json index 3b9328ffbd2d..77ad8784ef79 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json @@ -43,6 +43,9 @@ "Get pricings on resource - VirtualMachines plan": { "$ref": "./examples/Pricings/GetResourcePricingByNameVirtualMachines_example.json" }, + "Get pricings on resource - Containers plan": { + "$ref": "./examples/Pricings/GetResourcePricingByNameContainers_example.json" + }, "Get pricings on subscription - Dns plan": { "$ref": "./examples/Pricings/GetPricingByNameDns_example.json" }, @@ -98,6 +101,9 @@ "Update pricing on resource (example for VirtualMachines plan)": { "$ref": "./examples/Pricings/PutResourcePricingByNameVirtualMachines_example.json" }, + "Update pricing on resource (example for Containers plan)": { + "$ref": "./examples/Pricings/PutResourcePricingByNameContainers_example.json" + }, "Update pricing on subscription (example for CloudPosture plan) - partial success": { "$ref": "./examples/Pricings/PutPricingByNamePartialSuccess_example.json" } @@ -146,12 +152,15 @@ "x-ms-examples": { "Delete a pricing on resource": { "$ref": "./examples/Pricings/DeleteResourcePricing_example.json" + }, + "Delete a pricing on resource (example for Containers plan)": { + "$ref": "./examples/Pricings/DeleteResourcePricingByNameContainers_example.json" } }, "tags": [ "Pricings" ], - "description": "Deletes a provided Microsoft Defender for Cloud pricing configuration in a specific resource. Valid only for resource scope (Supported resources are: 'VirtualMachines, VMSS and ARC MachinesS').", + "description": "Deletes a provided Microsoft Defender for Cloud pricing configuration in a specific resource. Valid only for resource scope (Supported resources are: 'VirtualMachines, VMSS, ARC Machines, and Containers').", "operationId": "Pricings_Delete", "parameters": [ { diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/ServiceBus/tspconfig.yaml b/specification/servicebus/resource-manager/Microsoft.ServiceBus/ServiceBus/tspconfig.yaml index 09e569a3b59b..8b1435548a05 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/ServiceBus/tspconfig.yaml +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/ServiceBus/tspconfig.yaml @@ -19,14 +19,16 @@ options: generate-sample: true flavor: "azure" "@azure-tools/typespec-java": - emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-servicebus-generated" - namespace: "com.azure.resourcemanager.servicebus.generated" - service-name: "Service Bus" # human-readable service name, whitespace allowed - premium: false + emitter-output-dir: "{output-dir}/{service-dir}/azure-resourcemanager-servicebus" + namespace: "com.azure.resourcemanager.servicebus" + service-name: "Service Bus" + premium: true enable-sync-stack: false rename-model: EncryptionKeySource: KeySource use-object-for-unknown: true + client-side-validations: true + customization-class: customization/src/main/java/ServiceBusCustomization.java flavor: azure "@azure-tools/typespec-ts": emitter-output-dir: "{output-dir}/{service-dir}/arm-servicebus" diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/ServiceFabricManagedClusters/NodeType.tsp b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/ServiceFabricManagedClusters/NodeType.tsp index 0a15dd6ac2f2..6bf817a56fbb 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/ServiceFabricManagedClusters/NodeType.tsp +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/ServiceFabricManagedClusters/NodeType.tsp @@ -880,8 +880,8 @@ model VMSSExtension { /** * Describes the properties of a Virtual Machine Scale Set Extension. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "Backwards compatibility with existing flatten" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backwards compatibility with existing flatten" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties: VMSSExtensionProperties; } /** diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/back-compatible.tsp b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/back-compatible.tsp new file mode 100644 index 000000000000..ad6fc60995ed --- /dev/null +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/back-compatible.tsp @@ -0,0 +1,23 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; + +using Microsoft.ServiceNetworking; + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Association.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Frontend.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SecurityPolicy.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(TrafficController.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/main.tsp b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/main.tsp index 2c0bc40e28b5..669237bc82ff 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/main.tsp +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/main.tsp @@ -3,6 +3,8 @@ import "@typespec/rest"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "./back-compatible.tsp"; /** Traffic Controller Provider management API. */ @armProviderNamespace @@ -79,8 +81,8 @@ model AssociationUpdate { tags?: TrackedResource.tags; /** The resource-specific properties for this resource. */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: AssociationUpdateProperties; } diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/tspconfig.yaml b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/tspconfig.yaml index 47c2134e5c10..4814760e19d5 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/tspconfig.yaml +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/ServiceNetworking/tspconfig.yaml @@ -12,8 +12,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}" output-file: "{version-status}/{version}/TrafficController.json" arm-types-dir: "{project-root}/../../../../common-types/resource-management" diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/models.tsp b/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/models.tsp index d7e423c426f5..02b96bc24da3 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/models.tsp +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/models.tsp @@ -1334,8 +1334,8 @@ model PrivateLinkResource /** * Private link resource properties */ - #suppress "@azure-tools/typespec-azure-core/no-private-usage" "For backward compatibility" - @Azure.ResourceManager.Private.conditionalClientFlatten + #suppress "@azure-tools/typespec-azure-core/no-legacy-usage" "Backward compatibility" + @Azure.ClientGenerator.Core.Legacy.flattenProperty properties?: PrivateLinkResourceProperties; } diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml b/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml index 6d35cce3113e..577984631586 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/SignalRService/tspconfig.yaml @@ -10,7 +10,7 @@ options: azure-resource-provider-folder: "resource-manager" output-file: "{version-status}/{version}/signalr.json" examples-dir: "{project-root}/examples" - arm-resource-flattening: true + emit-lro-options: "all" arm-types-dir: "{project-root}/../../../../common-types/resource-management" "@azure-tools/typespec-csharp": diff --git a/specification/sphere/Sphere.Management/back-compatible.tsp b/specification/sphere/Sphere.Management/back-compatible.tsp new file mode 100644 index 000000000000..362d359783e6 --- /dev/null +++ b/specification/sphere/Sphere.Management/back-compatible.tsp @@ -0,0 +1,29 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.AzureSphere; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Catalog.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Certificate.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Deployment.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Device.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(DeviceGroup.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Image.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Product.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/sphere/Sphere.Management/main.tsp b/specification/sphere/Sphere.Management/main.tsp index 5f8f65c5f696..1ba8c9c7645a 100644 --- a/specification/sphere/Sphere.Management/main.tsp +++ b/specification/sphere/Sphere.Management/main.tsp @@ -10,6 +10,7 @@ import "./product.tsp"; import "./deviceGroup.tsp"; import "./deployment.tsp"; import "./device.tsp"; +import "./back-compatible.tsp"; using TypeSpec.Rest; using TypeSpec.Http; diff --git a/specification/sphere/Sphere.Management/tspconfig.yaml b/specification/sphere/Sphere.Management/tspconfig.yaml index fc17f1ba4e55..9cc8b5e5a985 100644 --- a/specification/sphere/Sphere.Management/tspconfig.yaml +++ b/specification/sphere/Sphere.Management/tspconfig.yaml @@ -9,8 +9,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/azuresphere.json" "@azure-tools/cadl-python": "basic-setup-py": true diff --git a/specification/splitio/SplitIO.Experimentation.Management/back-compatible.tsp b/specification/splitio/SplitIO.Experimentation.Management/back-compatible.tsp new file mode 100644 index 000000000000..dfbcd106ef81 --- /dev/null +++ b/specification/splitio/SplitIO.Experimentation.Management/back-compatible.tsp @@ -0,0 +1,9 @@ +// Contains overrides to make the Autorest Swagger2.0 back compatible +using SplitIO.Experimentation; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExperimentationWorkspace.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/splitio/SplitIO.Experimentation.Management/main.tsp b/specification/splitio/SplitIO.Experimentation.Management/main.tsp index f7621caa0964..836ef22594b6 100644 --- a/specification/splitio/SplitIO.Experimentation.Management/main.tsp +++ b/specification/splitio/SplitIO.Experimentation.Management/main.tsp @@ -3,6 +3,9 @@ import "@typespec/versioning"; import "@azure-tools/typespec-autorest"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; + +import "./back-compatible.tsp"; using Azure.ResourceManager; using TypeSpec.Http; diff --git a/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml b/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml index b76951bb1fea..2799f686dc2a 100644 --- a/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml +++ b/specification/splitio/SplitIO.Experimentation.Management/tspconfig.yaml @@ -5,8 +5,6 @@ options: "@azure-tools/typespec-autorest": emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/splitio.json" linter: extends: diff --git a/specification/standbypool/StandbyPool.Management/back-compatible.tsp b/specification/standbypool/StandbyPool.Management/back-compatible.tsp new file mode 100644 index 000000000000..f0f6e8bef6f5 --- /dev/null +++ b/specification/standbypool/StandbyPool.Management/back-compatible.tsp @@ -0,0 +1,28 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "./standbyVMPool.tsp"; +import "./standbyVM.tsp"; +import "./standbyVirtualMachinePoolRuntimeView.tsp"; +import "./standbyContainerGroupPool.tsp"; +import "./standbyContainerGroupPoolRuntimeView.tsp"; + +using Microsoft.StandbyPool; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StandbyContainerGroupPoolResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StandbyContainerGroupPoolRuntimeViewResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StandbyVirtualMachinePoolResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StandbyVirtualMachinePoolRuntimeViewResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(StandbyVirtualMachineResource.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Azure.ResourceManager.Foundations.ResourceUpdateModel.properties, + "autorest" +); diff --git a/specification/standbypool/StandbyPool.Management/main.tsp b/specification/standbypool/StandbyPool.Management/main.tsp index 2093761eea67..22c76eb13228 100644 --- a/specification/standbypool/StandbyPool.Management/main.tsp +++ b/specification/standbypool/StandbyPool.Management/main.tsp @@ -10,3 +10,4 @@ import "./standbyVM.tsp"; import "./standbyVirtualMachinePoolRuntimeView.tsp"; import "./standbyContainerGroupPool.tsp"; import "./standbyContainerGroupPoolRuntimeView.tsp"; +import "./back-compatible.tsp"; diff --git a/specification/standbypool/StandbyPool.Management/tspconfig.yaml b/specification/standbypool/StandbyPool.Management/tspconfig.yaml index cc6400d55f72..11b877626c02 100644 --- a/specification/standbypool/StandbyPool.Management/tspconfig.yaml +++ b/specification/standbypool/StandbyPool.Management/tspconfig.yaml @@ -11,8 +11,6 @@ options: use-read-only-status-schema: true azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/standbypool.json" diff --git a/specification/storage/Microsoft.BlobStorage/routes.tsp b/specification/storage/Microsoft.BlobStorage/routes.tsp index da080db30133..5affc81bf5de 100644 --- a/specification/storage/Microsoft.BlobStorage/routes.tsp +++ b/specification/storage/Microsoft.BlobStorage/routes.tsp @@ -31,8 +31,8 @@ namespace Storage.Blob { contentType: RequestMediaType, ...ApiVersionHeader, - ...TParams, ...ClientRequestIdHeader, + ...TParams, ): (TResponse & { /** Content-Type header */ #suppress "@typespec/http/content-type-ignored" "Template for existing API" @@ -50,7 +50,7 @@ namespace Storage.Blob { TParams extends TypeSpec.Reflection.Model | void, TResponse extends TypeSpec.Reflection.Model | void, TError = StorageError - >(...ApiVersionHeader, ...TParams, ...ClientRequestIdHeader): (TResponse & { + >(...ApiVersionHeader, ...ClientRequestIdHeader, ...TParams): (TResponse & { ...ApiVersionHeader; ...RequestIdResponseHeader; ...ClientRequestIdHeader; diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-11-05/generated_blob.json b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-11-05/generated_blob.json index cf6856a6f394..c3d70b76268e 100644 --- a/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-11-05/generated_blob.json +++ b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2025-11-05/generated_blob.json @@ -981,6 +981,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -1326,15 +1335,6 @@ true ], "x-ms-client-name": "requiresSync" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -1450,6 +1450,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -1590,15 +1599,6 @@ ] }, "x-ms-client-name": "blobDeleteType" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -1661,6 +1661,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -1789,15 +1798,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2260,6 +2260,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2327,15 +2336,6 @@ "required": false, "type": "boolean", "x-ms-client-name": "PreventEncryptionScopeOverride" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2409,6 +2409,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2432,15 +2441,6 @@ "required": false, "type": "string", "x-ms-client-name": "leaseId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2652,6 +2652,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2693,15 +2702,6 @@ "type": "string", "format": "date-time-rfc7231", "x-ms-client-name": "ifUnmodifiedSince" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2761,6 +2761,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2801,15 +2810,6 @@ "type": "string", "format": "date-time-rfc7231", "x-ms-client-name": "ifModifiedSince" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2883,6 +2883,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2906,15 +2915,6 @@ "required": false, "type": "string", "x-ms-client-name": "leaseId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3015,6 +3015,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3085,15 +3094,6 @@ "format": "date-time-rfc7231", "x-ms-client-name": "ifUnmodifiedSince" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "containerAcl", "in": "body", @@ -3175,6 +3175,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3206,15 +3215,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3279,6 +3279,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3310,15 +3319,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3492,6 +3492,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3561,15 +3570,6 @@ } }, "collectionFormat": "csv" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3637,6 +3637,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3701,15 +3710,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3787,6 +3787,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3842,15 +3851,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3925,10 +3925,19 @@ "x-ms-client-name": "version" }, { - "name": "containerName", - "in": "path", - "description": "The name of the container.", - "required": true, + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container.", + "required": true, "type": "string" }, { @@ -3979,15 +3988,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4065,6 +4065,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4121,15 +4130,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4208,6 +4208,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4271,15 +4280,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4357,6 +4357,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4474,15 +4483,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4550,6 +4550,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4674,15 +4683,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4750,6 +4750,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4765,15 +4774,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4926,6 +4926,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4951,15 +4960,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5024,6 +5024,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5098,15 +5107,6 @@ "type": "string", "format": "date-time-rfc7231", "x-ms-client-name": "ExpiresOn" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5180,6 +5180,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5304,15 +5313,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5391,6 +5391,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5477,15 +5486,6 @@ "required": false, "type": "string", "x-ms-client-name": "versionId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5585,6 +5585,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5625,15 +5634,6 @@ "required": false, "type": "string", "x-ms-client-name": "versionId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5698,6 +5698,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5746,15 +5755,6 @@ "required": false, "type": "string", "x-ms-client-name": "versionId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5823,6 +5823,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5952,15 +5961,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6050,6 +6050,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6148,15 +6157,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6234,6 +6234,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6323,15 +6332,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6405,6 +6405,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6494,15 +6503,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6580,6 +6580,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6677,15 +6686,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6763,6 +6763,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6853,15 +6862,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6940,6 +6940,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7069,15 +7078,6 @@ "required": false, "type": "string", "x-ms-client-name": "leaseId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -7163,6 +7163,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7542,15 +7551,6 @@ "modelAsString": false }, "x-ms-client-name": "requiresSync" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -7656,6 +7656,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7711,15 +7720,6 @@ "modelAsString": false }, "x-ms-client-name": "copyActionAbortConstant" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -7784,6 +7784,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7980,15 +7989,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8067,6 +8067,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -8092,15 +8101,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8253,6 +8253,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -8309,15 +8318,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8385,6 +8385,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -8453,15 +8462,6 @@ "type": "string", "x-ms-client-name": "leaseId" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "tags", "in": "body", @@ -8534,6 +8534,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "x-ms-meta", "in": "header", @@ -8790,15 +8799,6 @@ "modelAsString": false }, "x-ms-client-name": "blobType" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8896,6 +8896,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -9111,15 +9120,6 @@ }, "x-ms-client-name": "pageWrite" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -9233,6 +9233,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -9414,15 +9423,6 @@ "modelAsString": false }, "x-ms-client-name": "pageWrite" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -9511,6 +9511,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -9788,15 +9797,6 @@ "modelAsString": false }, "x-ms-client-name": "pageWrite" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -9897,6 +9897,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10003,15 +10012,6 @@ "type": "integer", "format": "int32", "minimum": 1 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10093,6 +10093,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10214,15 +10223,6 @@ "type": "integer", "format": "int32", "minimum": 1 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10304,6 +10304,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10434,15 +10443,6 @@ "type": "integer", "format": "int64", "x-ms-client-name": "blobContentLength" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10521,6 +10521,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10640,15 +10649,6 @@ "format": "int64", "default": 0, "x-ms-client-name": "blobSequenceNumber" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10727,6 +10727,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10802,15 +10811,6 @@ "required": true, "type": "string", "x-ms-client-name": "copySource" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10927,6 +10927,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -11111,15 +11120,6 @@ "format": "int64", "x-ms-client-name": "structuredContentLength" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -11237,6 +11237,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -11492,15 +11501,6 @@ ] }, "x-ms-client-name": "fileRequestIntent" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -11605,6 +11605,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -11677,19 +11686,10 @@ "name": "x-ms-blob-condition-appendpos", "in": "header", "description": "Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).", - "required": false, - "type": "integer", - "format": "int64", - "x-ms-client-name": "appendPosition" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "appendPosition" } ], "responses": { @@ -11770,6 +11770,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "x-ms-meta", "in": "header", @@ -12172,15 +12181,6 @@ }, "x-ms-client-name": "blobType" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -12288,6 +12288,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "x-ms-meta", "in": "header", @@ -12743,15 +12752,6 @@ ] }, "x-ms-client-name": "fileRequestIntent" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -12849,6 +12849,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -12982,15 +12991,6 @@ "format": "int64", "x-ms-client-name": "structuredContentLength" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -13090,6 +13090,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -13285,15 +13294,6 @@ ] }, "x-ms-client-name": "fileRequestIntent" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -13380,6 +13380,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -13742,15 +13751,6 @@ "type": "boolean", "x-ms-client-name": "legalHold" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "blocks", "in": "body", @@ -13858,6 +13858,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -13940,15 +13949,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -14034,6 +14034,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -14155,15 +14164,6 @@ "type": "string", "x-ms-client-name": "ifTags" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "queryRequest", "in": "body", @@ -14885,6 +14885,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "timeout", "in": "query", @@ -14947,15 +14956,6 @@ } }, "collectionFormat": "csv" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -15023,6 +15023,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "prefix", "in": "query", @@ -15091,15 +15100,6 @@ } }, "collectionFormat": "csv" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -15162,15 +15162,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15179,6 +15170,15 @@ "type": "string", "format": "uuid", "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { @@ -15331,15 +15331,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15349,6 +15340,15 @@ "format": "uuid", "x-ms-client-name": "clientRequestId" }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, { "name": "storageServiceProperties", "in": "body", @@ -15416,15 +15416,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15433,6 +15424,15 @@ "type": "string", "format": "uuid", "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { @@ -15495,15 +15495,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15512,6 +15503,15 @@ "type": "string", "format": "uuid", "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { @@ -15579,15 +15579,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15597,6 +15588,15 @@ "format": "uuid", "x-ms-client-name": "clientRequestId" }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, { "name": "keyInfo", "in": "body", diff --git a/specification/storage/data-plane/Microsoft.BlobStorage/stable/2026-02-06/generated_blob.json b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2026-02-06/generated_blob.json index ae15cd1eae27..af15cfa4d4f1 100644 --- a/specification/storage/data-plane/Microsoft.BlobStorage/stable/2026-02-06/generated_blob.json +++ b/specification/storage/data-plane/Microsoft.BlobStorage/stable/2026-02-06/generated_blob.json @@ -981,6 +981,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -1326,15 +1335,6 @@ true ], "x-ms-client-name": "requiresSync" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -1450,6 +1450,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -1590,15 +1599,6 @@ ] }, "x-ms-client-name": "blobDeleteType" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -1661,6 +1661,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -1789,15 +1798,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2260,6 +2260,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2327,15 +2336,6 @@ "required": false, "type": "boolean", "x-ms-client-name": "PreventEncryptionScopeOverride" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2409,6 +2409,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2432,15 +2441,6 @@ "required": false, "type": "string", "x-ms-client-name": "leaseId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2652,6 +2652,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2693,15 +2702,6 @@ "type": "string", "format": "date-time-rfc7231", "x-ms-client-name": "ifUnmodifiedSince" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2761,6 +2761,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2801,15 +2810,6 @@ "type": "string", "format": "date-time-rfc7231", "x-ms-client-name": "ifModifiedSince" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -2883,6 +2883,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -2906,15 +2915,6 @@ "required": false, "type": "string", "x-ms-client-name": "leaseId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3015,6 +3015,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3085,15 +3094,6 @@ "format": "date-time-rfc7231", "x-ms-client-name": "ifUnmodifiedSince" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "containerAcl", "in": "body", @@ -3175,6 +3175,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3206,15 +3215,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3279,6 +3279,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3310,15 +3319,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3492,6 +3492,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3561,15 +3570,6 @@ } }, "collectionFormat": "csv" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3637,6 +3637,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3701,15 +3710,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3787,6 +3787,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -3842,15 +3851,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -3925,10 +3925,19 @@ "x-ms-client-name": "version" }, { - "name": "containerName", - "in": "path", - "description": "The name of the container.", - "required": true, + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container.", + "required": true, "type": "string" }, { @@ -3979,15 +3988,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4065,6 +4065,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4121,15 +4130,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4208,6 +4208,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4271,15 +4280,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4357,6 +4357,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4481,15 +4490,6 @@ "description": "Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; For recursive list, multiple entity levels are supported. (Inclusive)", "required": false, "type": "string" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4557,6 +4557,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4688,15 +4697,6 @@ "description": "Specifies the relative path to list paths from. For non-recursive list, only one entity level is supported; For recursive list, multiple entity levels are supported. (Inclusive)", "required": false, "type": "string" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4764,6 +4764,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4779,15 +4788,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -4940,6 +4940,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -4965,15 +4974,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5038,6 +5038,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5112,15 +5121,6 @@ "type": "string", "format": "date-time-rfc7231", "x-ms-client-name": "ExpiresOn" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5194,6 +5194,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5318,15 +5327,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5405,6 +5405,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5491,15 +5500,6 @@ "required": false, "type": "string", "x-ms-client-name": "versionId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5599,6 +5599,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5639,15 +5648,6 @@ "required": false, "type": "string", "x-ms-client-name": "versionId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5712,6 +5712,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5760,15 +5769,6 @@ "required": false, "type": "string", "x-ms-client-name": "versionId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -5837,6 +5837,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -5966,15 +5975,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6064,6 +6064,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6162,15 +6171,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6248,6 +6248,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6337,15 +6346,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6419,6 +6419,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6508,15 +6517,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6594,6 +6594,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6691,15 +6700,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6777,6 +6777,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -6867,15 +6876,6 @@ "modelAsString": false }, "x-ms-client-name": "action" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -6954,6 +6954,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7083,15 +7092,6 @@ "required": false, "type": "string", "x-ms-client-name": "leaseId" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -7177,6 +7177,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7556,15 +7565,6 @@ "modelAsString": false }, "x-ms-client-name": "requiresSync" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -7670,6 +7670,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7725,15 +7734,6 @@ "modelAsString": false }, "x-ms-client-name": "copyActionAbortConstant" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -7798,6 +7798,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -7994,15 +8003,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8081,6 +8081,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -8106,15 +8115,6 @@ "type": "integer", "format": "int32", "minimum": 0 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8267,6 +8267,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -8357,15 +8366,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8433,6 +8433,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -8535,15 +8544,6 @@ "type": "string", "x-ms-client-name": "ifNoneMatch" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "tags", "in": "body", @@ -8616,6 +8616,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "x-ms-meta", "in": "header", @@ -8872,15 +8881,6 @@ "modelAsString": false }, "x-ms-client-name": "blobType" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -8978,6 +8978,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -9193,15 +9202,6 @@ }, "x-ms-client-name": "pageWrite" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -9315,6 +9315,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -9496,15 +9505,6 @@ "modelAsString": false }, "x-ms-client-name": "pageWrite" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -9593,6 +9593,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -9870,15 +9879,6 @@ "modelAsString": false }, "x-ms-client-name": "pageWrite" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -9979,6 +9979,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10085,15 +10094,6 @@ "type": "integer", "format": "int32", "minimum": 1 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10175,6 +10175,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10296,15 +10305,6 @@ "type": "integer", "format": "int32", "minimum": 1 - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10386,6 +10386,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10516,15 +10525,6 @@ "type": "integer", "format": "int64", "x-ms-client-name": "blobContentLength" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10603,6 +10603,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10722,15 +10731,6 @@ "format": "int64", "default": 0, "x-ms-client-name": "blobSequenceNumber" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -10809,6 +10809,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -10884,15 +10893,6 @@ "required": true, "type": "string", "x-ms-client-name": "copySource" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -11009,6 +11009,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -11193,15 +11202,6 @@ "format": "int64", "x-ms-client-name": "structuredContentLength" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -11319,6 +11319,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -11574,15 +11583,6 @@ ] }, "x-ms-client-name": "fileRequestIntent" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -11687,6 +11687,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -11759,19 +11768,10 @@ "name": "x-ms-blob-condition-appendpos", "in": "header", "description": "Optional conditional header, used only for the Append Block operation. A number indicating the byte offset to compare. Append Block will succeed only if the append position is equal to this number. If it is not, the request will fail with the AppendPositionConditionNotMet error (HTTP status code 412 - Precondition Failed).", - "required": false, - "type": "integer", - "format": "int64", - "x-ms-client-name": "appendPosition" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" + "required": false, + "type": "integer", + "format": "int64", + "x-ms-client-name": "appendPosition" } ], "responses": { @@ -11852,6 +11852,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "x-ms-meta", "in": "header", @@ -12254,15 +12263,6 @@ }, "x-ms-client-name": "blobType" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -12370,6 +12370,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "x-ms-meta", "in": "header", @@ -12825,15 +12834,6 @@ ] }, "x-ms-client-name": "fileRequestIntent" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -12931,6 +12931,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -13064,15 +13073,6 @@ "format": "int64", "x-ms-client-name": "structuredContentLength" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "body", "in": "body", @@ -13172,6 +13172,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -13367,15 +13376,6 @@ ] }, "x-ms-client-name": "fileRequestIntent" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -13462,6 +13462,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -13824,15 +13833,6 @@ "type": "boolean", "x-ms-client-name": "legalHold" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "blocks", "in": "body", @@ -13940,6 +13940,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -14022,15 +14031,6 @@ "required": false, "type": "string", "x-ms-client-name": "ifTags" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -14116,6 +14116,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "containerName", "in": "path", @@ -14237,15 +14246,6 @@ "type": "string", "x-ms-client-name": "ifTags" }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" - }, { "name": "queryRequest", "in": "body", @@ -14967,6 +14967,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "timeout", "in": "query", @@ -15029,15 +15038,6 @@ } }, "collectionFormat": "csv" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -15105,6 +15105,15 @@ "type": "string", "x-ms-client-name": "version" }, + { + "name": "x-ms-client-request-id", + "in": "header", + "description": "An opaque, globally-unique, client-generated string identifier for the request.", + "required": false, + "type": "string", + "format": "uuid", + "x-ms-client-name": "clientRequestId" + }, { "name": "prefix", "in": "query", @@ -15173,15 +15182,6 @@ } }, "collectionFormat": "csv" - }, - { - "name": "x-ms-client-request-id", - "in": "header", - "description": "An opaque, globally-unique, client-generated string identifier for the request.", - "required": false, - "type": "string", - "format": "uuid", - "x-ms-client-name": "clientRequestId" } ], "responses": { @@ -15244,15 +15244,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15261,6 +15252,15 @@ "type": "string", "format": "uuid", "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { @@ -15413,15 +15413,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15431,6 +15422,15 @@ "format": "uuid", "x-ms-client-name": "clientRequestId" }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, { "name": "storageServiceProperties", "in": "body", @@ -15498,15 +15498,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15515,6 +15506,15 @@ "type": "string", "format": "uuid", "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { @@ -15577,15 +15577,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15594,6 +15585,15 @@ "type": "string", "format": "uuid", "x-ms-client-name": "clientRequestId" + }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 } ], "responses": { @@ -15661,15 +15661,6 @@ "type": "string", "x-ms-client-name": "version" }, - { - "name": "timeout", - "in": "query", - "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0 - }, { "name": "x-ms-client-request-id", "in": "header", @@ -15679,6 +15670,15 @@ "format": "uuid", "x-ms-client-name": "clientRequestId" }, + { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0 + }, { "name": "keyInfo", "in": "body", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml index cf502b31f68b..4eb6ac9797e7 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/StorageSync/tspconfig.yaml @@ -11,7 +11,7 @@ options: output-file: "{version-status}/{version}/storagesync.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + emit-lro-options: "all" "@azure-tools/typespec-python": service-dir: "sdk/storage" diff --git a/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml b/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml index 4bfc19d1d187..bb0a68373ebf 100644 --- a/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml +++ b/specification/support/resource-manager/Microsoft.Support/Support/tspconfig.yaml @@ -16,7 +16,7 @@ options: output-file: "{version-status}/{version}/support.json" examples-dir: "{project-root}/examples" arm-types-dir: "{project-root}/../../../../common-types/resource-management" - arm-resource-flattening: true + emit-lro-options: "all" "@azure-tools/typespec-python": emitter-output-dir: "{output-dir}/{service-dir}/azure-mgmt-support" diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json index 8a1e0617ada8..6b3b85c3297c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json @@ -2935,7 +2935,25 @@ "typeProperties": { "description": "Properties specific to this dataset type.", "x-ms-client-flatten": true, - "$ref": "#/definitions/GenericDatasetTypeProperties" + "$ref": "#/definitions/JiraDatasetTypeProperties" + } + } + }, + "JiraDatasetTypeProperties": { + "description": "Jira Dataset Properties", + "type": "object", + "properties": { + "tableName": { + "type": "object", + "description": "This property is only supported in Jira V1 Dataset, please consider upgrading to V2 dataset." + }, + "table": { + "type": "object", + "description": "The schema name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string)." + }, + "schema": { + "type": "object", + "description": "The table name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string)." } } }, diff --git a/specification/verifiedid/Microsoft.VerifiedId.Management/back-compatible.tsp b/specification/verifiedid/Microsoft.VerifiedId.Management/back-compatible.tsp new file mode 100644 index 000000000000..127bd112e688 --- /dev/null +++ b/specification/verifiedid/Microsoft.VerifiedId.Management/back-compatible.tsp @@ -0,0 +1,8 @@ +import "@azure-tools/typespec-client-generator-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Microsoft.VerifiedId; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Authority.properties, + "autorest" +); diff --git a/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp b/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp index d1332c5f0667..787521711d79 100644 --- a/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp +++ b/specification/verifiedid/Microsoft.VerifiedId.Management/main.tsp @@ -4,6 +4,8 @@ import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; +import "./back-compatible.tsp"; + using TypeSpec.Http; using TypeSpec.Rest; using TypeSpec.Versioning; diff --git a/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml b/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml index ef68ffa2bfb3..d8040e8a2e4c 100644 --- a/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml +++ b/specification/verifiedid/Microsoft.VerifiedId.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/verifiedid.json" use-read-only-status-schema: true diff --git a/specification/vmware/resource-manager/Microsoft.AVS/AVS/back-compatible.tsp b/specification/vmware/resource-manager/Microsoft.AVS/AVS/back-compatible.tsp index 141fe3a9b5d2..f9c838042cf1 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/AVS/back-compatible.tsp +++ b/specification/vmware/resource-manager/Microsoft.AVS/AVS/back-compatible.tsp @@ -12,7 +12,7 @@ import "./workloadNetworks-dhcpConfigurations.tsp"; using Azure.ClientGenerator.Core; -namespace Microsoft.AVS; +using Microsoft.AVS; @@clientLocation(WorkloadNetworkVmGroups.list, WorkloadNetworks, "!csharp"); @@clientLocation(WorkloadNetworkVmGroups.get, WorkloadNetworks, "!csharp"); @@ -161,3 +161,76 @@ namespace Microsoft.AVS; @@clientName(WorkloadNetworkDhcpConfigurations.create, "CreateDhcp"); @@clientName(WorkloadNetworkDhcpConfigurations.update, "UpdateDhcp"); @@clientName(WorkloadNetworkDhcpConfigurations.delete, "DeleteDhcp"); + +// Flatten properties for backward compatibility +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(CloudLink.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Cluster.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Datastore.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ExpressRouteAuthorization.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(GlobalReachConnection.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(HcxEnterpriseSite.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(IscsiPath.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PrivateCloud.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProvisionedNetwork.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(PureStoragePolicy.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScriptCmdlet.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ScriptPackage.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(VirtualMachine.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkDnsService.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkDnsZone.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkGateway.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkPortMirroring.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetwork.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkPublicIP.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkSegment.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkVMGroup.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(WorkloadNetworkVirtualMachine.properties, + "autorest" +); + +// Discriminated type +// @@Azure.ClientGenerator.Core.Legacy.flattenProperty(Addon.properties, +// "autorest" +// ); diff --git a/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2023-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2023-09-01/vmware.json index cb6c81afaca5..e5202e6f36b7 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2023-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2023-09-01/vmware.json @@ -6492,8 +6492,7 @@ "properties": { "properties": { "$ref": "#/definitions/AddonProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ @@ -8400,8 +8399,7 @@ "properties": { "properties": { "$ref": "#/definitions/PlacementPolicyProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ @@ -9144,8 +9142,7 @@ "properties": { "properties": { "$ref": "#/definitions/ScriptExecutionProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ @@ -10029,8 +10026,7 @@ "properties": { "properties": { "$ref": "#/definitions/WorkloadNetworkDhcpEntity", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2024-09-01/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2024-09-01/vmware.json index 95dd648964b8..02bedfada8b5 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2024-09-01/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/AVS/stable/2024-09-01/vmware.json @@ -7031,8 +7031,7 @@ "properties": { "properties": { "$ref": "#/definitions/AddonProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ @@ -8642,8 +8641,7 @@ "properties": { "properties": { "$ref": "#/definitions/HostProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." }, "zones": { "type": "array", @@ -9159,8 +9157,7 @@ "properties": { "properties": { "$ref": "#/definitions/PlacementPolicyProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ @@ -10441,8 +10438,7 @@ "properties": { "properties": { "$ref": "#/definitions/ScriptExecutionProperties", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ @@ -11336,8 +11332,7 @@ "properties": { "properties": { "$ref": "#/definitions/WorkloadNetworkDhcpEntity", - "description": "The resource-specific properties for this resource.", - "x-ms-client-flatten": true + "description": "The resource-specific properties for this resource." } }, "allOf": [ diff --git a/specification/vmware/resource-manager/Microsoft.AVS/AVS/tspconfig.yaml b/specification/vmware/resource-manager/Microsoft.AVS/AVS/tspconfig.yaml index b608180b0716..df9289eec908 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/AVS/tspconfig.yaml +++ b/specification/vmware/resource-manager/Microsoft.AVS/AVS/tspconfig.yaml @@ -11,8 +11,6 @@ options: "@azure-tools/typespec-autorest": azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true emitter-output-dir: "{project-root}" output-file: "{version-status}/{version}/vmware.json" arm-types-dir: "{project-root}/../../../../common-types/resource-management" diff --git a/specification/workloads/Workloads.Operations.Management/tspconfig.yaml b/specification/workloads/Workloads.Operations.Management/tspconfig.yaml index ce55d803eae4..4a8f1edff056 100644 --- a/specification/workloads/Workloads.Operations.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.Operations.Management/tspconfig.yaml @@ -6,8 +6,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/operations/{version-status}/{version}/operations.json" linter: extends: diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/back-compatible.tsp b/specification/workloads/Workloads.SAPDiscoverySite.Management/back-compatible.tsp index 05e4917efe26..401514d4ce18 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/back-compatible.tsp +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/back-compatible.tsp @@ -5,3 +5,13 @@ using Microsoft.Workloads; @@clientName(SAPDiscoverySites, "SapDiscoverySites", "autorest"); @@clientName(SAPInstances, "SapInstances", "autorest"); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SAPDiscoverySite.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SAPInstance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ServerInstance.properties, + "autorest" +); diff --git a/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml index 3931ded444cb..7a0c9827f0c6 100644 --- a/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.SAPDiscoverySite.Management/tspconfig.yaml @@ -9,8 +9,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/SAPDiscoverySites/{version-status}/{version}/SAPDiscoverySites.json" "@azure-tools/typespec-ts": experimental-extensible-enums: true diff --git a/specification/workloads/Workloads.SAPMonitor.Management/back-compatible.tsp b/specification/workloads/Workloads.SAPMonitor.Management/back-compatible.tsp new file mode 100644 index 000000000000..d0d2d9a5c19a --- /dev/null +++ b/specification/workloads/Workloads.SAPMonitor.Management/back-compatible.tsp @@ -0,0 +1,21 @@ +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +using Microsoft.Workloads; + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Alert.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(AlertTemplate.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(Monitor.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(ProviderInstance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SapLandscapeMonitorResource.properties, + "autorest" +); diff --git a/specification/workloads/Workloads.SAPMonitor.Management/main.tsp b/specification/workloads/Workloads.SAPMonitor.Management/main.tsp index 063edf772a54..682faf1901cb 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/main.tsp +++ b/specification/workloads/Workloads.SAPMonitor.Management/main.tsp @@ -8,6 +8,7 @@ import "./ProviderInstance.tsp"; import "./SapLandscapeMonitor.tsp"; import "./Alert.tsp"; import "./AlertTemplate.tsp"; +import "./back-compatible.tsp"; using Azure.ResourceManager; using TypeSpec.Versioning; diff --git a/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml index 751f5cf55247..09ed9fe0aa65 100644 --- a/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.SAPMonitor.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/monitors/{version-status}/{version}/monitors.json" "@azure-tools/typespec-ts": experimental-extensible-enums: true diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/back-compatible.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/back-compatible.tsp index b3399529fff7..acfcbc865753 100644 --- a/specification/workloads/Workloads.SAPVirtualInstance.Management/back-compatible.tsp +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/back-compatible.tsp @@ -1,7 +1,7 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; -namespace Microsoft.Workloads; +using Microsoft.Workloads; @@clientName(SAPVirtualInstances, "SapVirtualInstances", "autorest"); @@clientName(SAPDatabaseInstances, "SapDatabaseInstances", "autorest"); @@ -9,7 +9,24 @@ namespace Microsoft.Workloads; "SapCentralServerInstances", "autorest" ); +@@clientName(SAPApplicationServerInstance, + "SAPApplicationServerInstance", + "autorest" +); @@clientName(SAPApplicationServerInstances, "SapApplicationServerInstances", "autorest" ); + +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SAPApplicationServerInstance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SAPCentralServerInstance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SAPVirtualInstance.properties, + "autorest" +); +@@Azure.ClientGenerator.Core.Legacy.flattenProperty(SAPDatabaseInstance.properties, + "autorest" +); diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml index 5375fe705d1e..898cd6f81738 100644 --- a/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml @@ -10,8 +10,6 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" emit-common-types-schema: "never" - # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag - arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/SAPVirtualInstance/{version-status}/{version}/SAPVirtualInstance.json" "@azure-tools/typespec-csharp": emitter-output-dir: "{output-dir}/sdk/workloadssapvirtualinstance/{namespace}"